get_upload

DeviceFarm.Client.get_upload(**kwargs)

Gets information about an upload.

See also: AWS API Documentation

Request Syntax

response = client.get_upload(
    arn='string'
)

Parameters

arn (string) --

[REQUIRED]

The upload's ARN.

Return type

dict

Returns

Response Syntax

{
    'upload': {
        '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'
    }
}

Response Structure

• (dict) --

  Represents the result of a get upload request.

  • upload (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.

Exceptions

• DeviceFarm.Client.exceptions.ArgumentException
• DeviceFarm.Client.exceptions.NotFoundException
• DeviceFarm.Client.exceptions.LimitExceededException
• DeviceFarm.Client.exceptions.ServiceAccountException

Examples

The following example gets information about a specific upload.

response = client.get_upload(
    # You can get the test ARN by using the list-uploads CLI command.
    arn='arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456',
)

print(response)

Expected Output:

{
    'upload': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}