ListArtifacts

class DeviceFarm.Paginator.ListArtifacts

paginator = client.get_paginator('list_artifacts')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    arn='string',
    type='SCREENSHOT'|'FILE'|'LOG',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

• arn (string) --

  [REQUIRED]

  The run, job, suite, or test ARN.

• type (string) --

  [REQUIRED]

  The artifacts' type.

  Allowed values include:

  • FILE
  • LOG
  • SCREENSHOT
• 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

{
    'artifacts': [
        {
            'arn': 'string',
            'name': 'string',
            'type': 'UNKNOWN'|'SCREENSHOT'|'DEVICE_LOG'|'MESSAGE_LOG'|'VIDEO_LOG'|'RESULT_LOG'|'SERVICE_LOG'|'WEBKIT_LOG'|'INSTRUMENTATION_OUTPUT'|'EXERCISER_MONKEY_OUTPUT'|'CALABASH_JSON_OUTPUT'|'CALABASH_PRETTY_OUTPUT'|'CALABASH_STANDARD_OUTPUT'|'CALABASH_JAVA_XML_OUTPUT'|'AUTOMATION_OUTPUT'|'APPIUM_SERVER_OUTPUT'|'APPIUM_JAVA_OUTPUT'|'APPIUM_JAVA_XML_OUTPUT'|'APPIUM_PYTHON_OUTPUT'|'APPIUM_PYTHON_XML_OUTPUT'|'EXPLORER_EVENT_LOG'|'EXPLORER_SUMMARY_LOG'|'APPLICATION_CRASH_REPORT'|'XCTEST_LOG'|'VIDEO'|'CUSTOMER_ARTIFACT'|'CUSTOMER_ARTIFACT_LOG'|'TESTSPEC_OUTPUT',
            'extension': 'string',
            'url': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  Represents the result of a list artifacts operation.

  • artifacts (list) --

    Information about the artifacts.

    • (dict) --

      Represents the output of a test. Examples of artifacts include logs and screenshots.

      • arn (string) --

        The artifact's ARN.

      • name (string) --

        The artifact's name.

      • type (string) --

        The artifact's type.

        Allowed values include the following:

        • UNKNOWN
        • SCREENSHOT
        • DEVICE_LOG
        • MESSAGE_LOG
        • VIDEO_LOG
        • RESULT_LOG
        • SERVICE_LOG
        • WEBKIT_LOG
        • INSTRUMENTATION_OUTPUT
        • EXERCISER_MONKEY_OUTPUT: the artifact (log) generated by an Android fuzz test.
        • CALABASH_JSON_OUTPUT
        • CALABASH_PRETTY_OUTPUT
        • CALABASH_STANDARD_OUTPUT
        • CALABASH_JAVA_XML_OUTPUT
        • AUTOMATION_OUTPUT
        • APPIUM_SERVER_OUTPUT
        • APPIUM_JAVA_OUTPUT
        • APPIUM_JAVA_XML_OUTPUT
        • APPIUM_PYTHON_OUTPUT
        • APPIUM_PYTHON_XML_OUTPUT
        • EXPLORER_EVENT_LOG
        • EXPLORER_SUMMARY_LOG
        • APPLICATION_CRASH_REPORT
        • XCTEST_LOG
        • VIDEO
        • CUSTOMER_ARTIFACT
        • CUSTOMER_ARTIFACT_LOG
        • TESTSPEC_OUTPUT

      • extension (string) --

        The artifact's file extension.

      • url (string) --

        The presigned Amazon S3 URL that can be used with a GET request to download the artifact's file.

  • NextToken (string) --

    A token to resume pagination.