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.ListUploads 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.ListUploads'
paths:
/#X-Amz-Target=DeviceFarm_20150623.ListUploads:
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: ListUploads
description: Gets information about uploads, given an AWS Device Farm project ARN.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListUploadsResult'
'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/ListUploadsRequest'
parameters:
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- DeviceFarm_20150623.ListUploads
tags:
- '#X Amz Target=DeviceFarm 20150623.ListUploads'
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:
ListUploadsRequest:
type: object
required:
- arn
title: ListUploadsRequest
properties:
arn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The Amazon Resource Name (ARN) of the project for which you want to list uploads.
type:
allOf:
- $ref: '#/components/schemas/UploadType'
- description: The type of upload.
Must be one of the following values:
-
ANDROID_APP
-
IOS_APP
-
WEB_APP
-
EXTERNAL_DATA
-
APPIUM_JAVA_JUNIT_TEST_PACKAGE
-
APPIUM_JAVA_TESTNG_TEST_PACKAGE
-
APPIUM_PYTHON_TEST_PACKAGE
-
APPIUM_NODE_TEST_PACKAGE
-
APPIUM_RUBY_TEST_PACKAGE
-
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
-
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
-
APPIUM_WEB_PYTHON_TEST_PACKAGE
-
APPIUM_WEB_NODE_TEST_PACKAGE
-
APPIUM_WEB_RUBY_TEST_PACKAGE
-
CALABASH_TEST_PACKAGE
-
INSTRUMENTATION_TEST_PACKAGE
-
UIAUTOMATION_TEST_PACKAGE
-
UIAUTOMATOR_TEST_PACKAGE
-
XCTEST_TEST_PACKAGE
-
XCTEST_UI_TEST_PACKAGE
-
APPIUM_JAVA_JUNIT_TEST_SPEC
-
APPIUM_JAVA_TESTNG_TEST_SPEC
-
APPIUM_PYTHON_TEST_SPEC
-
APPIUM_NODE_TEST_SPEC
-
APPIUM_RUBY_TEST_SPEC
-
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
-
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
-
APPIUM_WEB_PYTHON_TEST_SPEC
-
APPIUM_WEB_NODE_TEST_SPEC
-
APPIUM_WEB_RUBY_TEST_SPEC
-
INSTRUMENTATION_TEST_SPEC
-
XCTEST_UI_TEST_SPEC
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
description: Represents a request to the list uploads operation.
SensitiveURL:
type: string
minLength: 0
maxLength: 2048
format: password
Message:
type: string
minLength: 0
maxLength: 16384
Metadata:
type: string
minLength: 0
maxLength: 8192
PaginationToken:
type: string
minLength: 4
maxLength: 1024
ContentType:
type: string
minLength: 0
maxLength: 64
LimitExceededException: {}
DateTime:
type: string
format: date-time
ListUploadsResult:
type: object
example:
uploads: []
properties:
uploads:
allOf:
- $ref: '#/components/schemas/Uploads'
- description: Information about the uploads.
nextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.
description: Represents the result of a list uploads request.
Upload:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/AmazonResourceName'
- description: The upload's ARN.
name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The upload's file name.
created:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: When the upload was created.
type:
allOf:
- $ref: '#/components/schemas/UploadType'
- description: The upload's type.
Must be one of the following values:
-
ANDROID_APP
-
IOS_APP
-
WEB_APP
-
EXTERNAL_DATA
-
APPIUM_JAVA_JUNIT_TEST_PACKAGE
-
APPIUM_JAVA_TESTNG_TEST_PACKAGE
-
APPIUM_PYTHON_TEST_PACKAGE
-
APPIUM_NODE_TEST_PACKAGE
-
APPIUM_RUBY_TEST_PACKAGE
-
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
-
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
-
APPIUM_WEB_PYTHON_TEST_PACKAGE
-
APPIUM_WEB_NODE_TEST_PACKAGE
-
APPIUM_WEB_RUBY_TEST_PACKAGE
-
CALABASH_TEST_PACKAGE
-
INSTRUMENTATION_TEST_PACKAGE
-
UIAUTOMATION_TEST_PACKAGE
-
UIAUTOMATOR_TEST_PACKAGE
-
XCTEST_TEST_PACKAGE
-
XCTEST_UI_TEST_PACKAGE
-
APPIUM_JAVA_JUNIT_TEST_SPEC
-
APPIUM_JAVA_TESTNG_TEST_SPEC
-
APPIUM_PYTHON_TEST_SPEC
-
APPIUM_NODE_TEST_SPEC
-
APPIUM_RUBY_TEST_SPEC
-
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
-
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
-
APPIUM_WEB_PYTHON_TEST_SPEC
-
APPIUM_WEB_NODE_TEST_SPEC
-
APPIUM_WEB_RUBY_TEST_SPEC
-
INSTRUMENTATION_TEST_SPEC
-
XCTEST_UI_TEST_SPEC
status:
allOf:
- $ref: '#/components/schemas/UploadStatus'
- description: The upload's status.
Must be one of the following values:
-
FAILED
-
INITIALIZED
-
PROCESSING
-
SUCCEEDED
url:
allOf:
- $ref: '#/components/schemas/SensitiveURL'
- description: The presigned Amazon S3 URL that was used to store a file using a PUT request.
metadata:
allOf:
- $ref: '#/components/schemas/Metadata'
- description: The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
contentType:
allOf:
- $ref: '#/components/schemas/ContentType'
- description: The upload's content type (for example, application/octet-stream).
message:
allOf:
- $ref: '#/components/schemas/Message'
- description: A message about the upload's result.
category:
allOf:
- $ref: '#/components/schemas/UploadCategory'
- description: 'The upload''s category. Allowed values include:
'
description: An app or a set of one or more tests to upload or that have been uploaded.
Uploads:
type: array
items:
$ref: '#/components/schemas/Upload'
UploadCategory:
type: string
enum:
- CURATED
- PRIVATE
ServiceAccountException: {}
NotFoundException: {}
AmazonResourceName:
type: string
pattern: ^arn:.+
minLength: 32
maxLength: 1011
Name:
type: string
minLength: 0
maxLength: 256
UploadStatus:
type: string
enum:
- INITIALIZED
- PROCESSING
- SUCCEEDED
- FAILED
UploadType:
type: string
enum:
- ANDROID_APP
- IOS_APP
- WEB_APP
- EXTERNAL_DATA
- APPIUM_JAVA_JUNIT_TEST_PACKAGE
- APPIUM_JAVA_TESTNG_TEST_PACKAGE
- APPIUM_PYTHON_TEST_PACKAGE
- APPIUM_NODE_TEST_PACKAGE
- APPIUM_RUBY_TEST_PACKAGE
- APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
- APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
- APPIUM_WEB_PYTHON_TEST_PACKAGE
- APPIUM_WEB_NODE_TEST_PACKAGE
- APPIUM_WEB_RUBY_TEST_PACKAGE
- CALABASH_TEST_PACKAGE
- INSTRUMENTATION_TEST_PACKAGE
- UIAUTOMATION_TEST_PACKAGE
- UIAUTOMATOR_TEST_PACKAGE
- XCTEST_TEST_PACKAGE
- XCTEST_UI_TEST_PACKAGE
- APPIUM_JAVA_JUNIT_TEST_SPEC
- APPIUM_JAVA_TESTNG_TEST_SPEC
- APPIUM_PYTHON_TEST_SPEC
- APPIUM_NODE_TEST_SPEC
- APPIUM_RUBY_TEST_SPEC
- APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
- APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
- APPIUM_WEB_PYTHON_TEST_SPEC
- APPIUM_WEB_NODE_TEST_SPEC
- APPIUM_WEB_RUBY_TEST_SPEC
- INSTRUMENTATION_TEST_SPEC
- XCTEST_UI_TEST_SPEC
ArgumentException: {}
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