openapi: 3.0.0
info:
version: 2015-06-23
x-release: v4
title: 'AWS Device Farm #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.CreateDevicePool #X Amz Target=DeviceFarm 20150623.CreateProject API'
description:
Welcome to the AWS Device Farm API documentation, which contains APIs for:
-
Testing on desktop browsers
Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain TestGrid in their names. For more information, see Testing Web Applications on Selenium with Device Farm.
-
Testing on real mobile devices
Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the Device Farm Developer Guide.
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: devicefarm
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/devicefarm-2015-06-23.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://devicefarm.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Device Farm multi-region endpoint
- url: https://devicefarm.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS Device Farm multi-region endpoint
- url: http://devicefarm.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Device Farm endpoint for China (Beijing) and China (Ningxia)
- url: https://devicefarm.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS Device Farm endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=DeviceFarm 20150623.CreateProject'
paths:
/#X-Amz-Target=DeviceFarm_20150623.CreateProject:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateProject
description: Creates a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectResult'
'480':
description: ArgumentException
content:
application/json:
schema:
$ref: '#/components/schemas/ArgumentException'
'481':
description: NotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: ServiceAccountException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceAccountException'
'484':
description: TagOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/TagOperationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- DeviceFarm_20150623.CreateProject
tags:
- '#X Amz Target=DeviceFarm 20150623.CreateProject'
components:
schemas:
TagOperationException: {}
VpcSubnetIds:
type: array
items:
$ref: '#/components/schemas/SubnetId'
minItems: 1
maxItems: 8
NonEmptyString:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 4096
LimitExceededException: {}
SubnetId:
type: string
pattern: ^subnet-[0-9a-fA-F]{8,}$
minLength: 1
maxLength: 4096
DateTime:
type: string
format: date-time
Project:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The project's ARN.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The project's name.
defaultJobTimeoutMinutes:
allOf:
- $ref: '#/components/schemas/JobTimeoutMinutes'
- description: The default number of minutes (at the project level) a test run executes before it times out. The default value is 150 minutes.
created:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: When the project was created.
vpcConfig:
allOf:
- $ref: '#/components/schemas/VpcConfig'
- description: The VPC security groups and subnets that are attached to a project.
description: Represents an operating-system neutral workspace for running and managing tests.
VpcConfig:
type: object
required:
- securityGroupIds
- subnetIds
- vpcId
properties:
securityGroupIds:
allOf:
- $ref: '#/components/schemas/VpcSecurityGroupIds'
- description: An array of one or more security groups IDs in your Amazon VPC.
subnetIds:
allOf:
- $ref: '#/components/schemas/VpcSubnetIds'
- description: An array of one or more subnet IDs in your Amazon VPC.
vpcId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the Amazon VPC.
description: Contains the VPC configuration data necessary to interface with AWS Device Farm's services.
VpcSecurityGroupIds:
type: array
items:
$ref: '#/components/schemas/SecurityGroupId'
minItems: 1
maxItems: 5
CreateProjectRequest:
type: object
required:
- name
title: CreateProjectRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The project's name.
defaultJobTimeoutMinutes:
allOf:
- $ref: '#/components/schemas/JobTimeoutMinutes'
- description: Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run.
vpcConfig:
allOf:
- $ref: '#/components/schemas/VpcConfig'
- description: The VPC security groups and subnets that are attached to a project.
description: Represents a request to the create project operation.
SecurityGroupId:
type: string
pattern: ^sg-[0-9a-fA-F]{8,}$
minLength: 1
maxLength: 4096
ServiceAccountException: {}
NotFoundException: {}
AmazonResourceName:
type: string
pattern: ^arn:.+
minLength: 32
maxLength: 1011
CreateProjectResult:
type: object
example:
project:
name: MyProject
arn: arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE
created: '1472660939.152'
properties:
project:
allOf:
- $ref: '#/components/schemas/Project'
- description: The newly created project.
description: Represents the result of a create project request.
JobTimeoutMinutes:
type: integer
Name:
type: string
minLength: 0
maxLength: 256
ArgumentException: {}
parameters:
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/devicefarm/
x-hasEquivalentPaths: true