DeviceFarm / Client / list_uploads

list_uploads#

DeviceFarm.Client.list_uploads(**kwargs)#

Gets information about uploads, given an AWS Device Farm project ARN.

Request Syntax

response = client.list_uploads(
    arn='string',
    type='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='string'
)

Parameters:

arn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the project for which you want to list uploads.
type (string) –
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 (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'uploads': [
        {
            'arn': 'string',
            'name': 'string',
            'created': datetime(2015, 1, 1),
            'type': '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': 'INITIALIZED'|'PROCESSING'|'SUCCEEDED'|'FAILED',
            'url': 'string',
            'metadata': 'string',
            'contentType': 'string',
            'message': 'string',
            'category': 'CURATED'|'PRIVATE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Represents the result of a list uploads request.
- uploads (list) –
  
  Information about the uploads.
  - (dict) –
    
    An app or a set of one or more tests to upload or that have been uploaded.
    - arn (string) –
      
      The upload’s ARN.
    - name (string) –
      
      The upload’s file name.
    - created (datetime) –
      
      When the upload was created.
    - type (string) –
      
      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 (string) –
      
      The upload’s status.
      
      Must be one of the following values:
      - FAILED
      - INITIALIZED
      - PROCESSING
      - SUCCEEDED
    - url (string) –
      
      The presigned Amazon S3 URL that was used to store a file using a PUT request.
    - metadata (string) –
      
      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 (string) –
      
      The upload’s content type (for example, application/octet-stream).
    - message (string) –
      
      A message about the upload’s result.
    - category (string) –
      
      The upload’s category. Allowed values include:
      - CURATED: An upload managed by AWS Device Farm.
      - PRIVATE: An upload managed by the AWS Device Farm customer.
- nextToken (string) –
  
  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.

Exceptions

Examples

The following example returns information about uploads, given a specific Device Farm project.

response = client.list_uploads(
    # You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.
    arn='arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456',
    # A dynamically generated value, used for paginating results.
    nextToken='RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE',
)

print(response)

Expected Output:

{
    'uploads': [
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}