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.CreateInstanceProfile 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.CreateInstanceProfile'
paths:
/#X-Amz-Target=DeviceFarm_20150623.CreateInstanceProfile:
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: CreateInstanceProfile
description: Creates a profile that can be applied to one or more private fleet device instances.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInstanceProfileResult'
'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'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateInstanceProfileRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- DeviceFarm_20150623.CreateInstanceProfile
tags:
- '#X Amz Target=DeviceFarm 20150623.CreateInstanceProfile'
components:
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
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
schemas:
String:
type: string
Message:
type: string
minLength: 0
maxLength: 16384
LimitExceededException: {}
Boolean:
type: boolean
PackageIds:
type: array
items:
$ref: '#/components/schemas/String'
CreateInstanceProfileRequest:
type: object
required:
- name
title: CreateInstanceProfileRequest
properties:
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of your instance profile.
description:
allOf:
- $ref: '#/components/schemas/Message'
- description: The description of your instance profile.
packageCleanup:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
excludeAppPackagesFromCleanup:
allOf:
- $ref: '#/components/schemas/PackageIds'
- description: An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.
The list of packages is considered only if you set packageCleanup to true.
rebootAfterUse:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: When set to true, Device Farm reboots the instance after a test run. The default value is true.
ServiceAccountException: {}
NotFoundException: {}
AmazonResourceName:
type: string
pattern: ^arn:.+
minLength: 32
maxLength: 1011
CreateInstanceProfileResult:
type: object
properties:
instanceProfile:
allOf:
- $ref: '#/components/schemas/InstanceProfile'
- description: An object that contains information about your instance profile.
Name:
type: string
minLength: 0
maxLength: 256
ArgumentException: {}
InstanceProfile:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The Amazon Resource Name (ARN) of the instance profile.
packageCleanup:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.
excludeAppPackagesFromCleanup:
allOf:
- $ref: '#/components/schemas/PackageIds'
- description: An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.
The list of packages is considered only if you set packageCleanup to true.
rebootAfterUse:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: When set to true, Device Farm reboots the instance after a test run. The default value is true.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the instance profile.
description:
allOf:
- $ref: '#/components/schemas/Message'
- description: The description of the instance profile.
description: Represents the instance profile.
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