DeviceFarm / Paginator / ListUploads

ListUploads

class DeviceFarm.Paginator.ListUploads

paginator = client.get_paginator('list_uploads')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DeviceFarm.Client.list_uploads().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': '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

  • 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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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

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

  • NextToken (string) –

    A token to resume pagination.