DeviceFarm / Client / create_upload

create_upload#

DeviceFarm.Client.create_upload(**kwargs)#

Uploads an app or test scripts.

See also: AWS API Documentation

Request Syntax

response = client.create_upload(
    projectArn='string',
    name='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',
    contentType='string'
)
Parameters:
  • projectArn (string) –

    [REQUIRED]

    The ARN of the project for the upload.

  • name (string) –

    [REQUIRED]

    The upload’s file name. The name should not contain any forward slashes ( /). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension.

  • type (string) –

    [REQUIRED]

    The upload’s upload 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

    • INSTRUMENTATION_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

    If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

  • contentType (string) – The upload’s content type (for example, application/octet-stream).

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 create upload request.

    • upload (dict) –

      The newly created upload.

      • 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

        • INSTRUMENTATION_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 creates a new Appium Python test package upload inside an existing project.

response = client.create_upload(
    name='MyAppiumPythonUpload',
    type='APPIUM_PYTHON_TEST_PACKAGE',
    # You can get the project ARN by using the list-projects CLI command.
    projectArn='arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456',
)

print(response)

Expected Output:

{
    'upload': {
        'name': 'MyAppiumPythonUpload',
        'type': 'APPIUM_PYTHON_TEST_PACKAGE',
        'arn': 'arn:aws:devicefarm:us-west-2:123456789101:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE',
        'created': datetime(2016, 8, 31, 16, 36, 44, 2, 244, 0),
        'status': 'INITIALIZED',
        'url': 'https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aproject%3A5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789101%3Aupload%3A5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE/MyAppiumPythonUpload?AWSAccessKeyId=1234567891011EXAMPLE&Expires=1472747804&Signature=1234567891011EXAMPLE',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}