ListSamples

class DeviceFarm.Paginator.ListSamples

paginator = client.get_paginator('list_samples')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    arn='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

• arn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the job used to list samples.

• 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

{
    'samples': [
        {
            'arn': 'string',
            'type': 'CPU'|'MEMORY'|'THREADS'|'RX_RATE'|'TX_RATE'|'RX'|'TX'|'NATIVE_FRAMES'|'NATIVE_FPS'|'NATIVE_MIN_DRAWTIME'|'NATIVE_AVG_DRAWTIME'|'NATIVE_MAX_DRAWTIME'|'OPENGL_FRAMES'|'OPENGL_FPS'|'OPENGL_MIN_DRAWTIME'|'OPENGL_AVG_DRAWTIME'|'OPENGL_MAX_DRAWTIME',
            'url': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  Represents the result of a list samples request.

  • samples (list) --

    Information about the samples.

    • (dict) --

      Represents a sample of performance data.

      • arn (string) --

        The sample's ARN.

      • type (string) --

        The sample's type.

        Must be one of the following values:

        • CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage.
        • MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes.
        • NATIVE_AVG_DRAWTIME
        • NATIVE_FPS
        • NATIVE_FRAMES
        • NATIVE_MAX_DRAWTIME
        • NATIVE_MIN_DRAWTIME
        • OPENGL_AVG_DRAWTIME
        • OPENGL_FPS
        • OPENGL_FRAMES
        • OPENGL_MAX_DRAWTIME
        • OPENGL_MIN_DRAWTIME
        • RX
        • RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.
        • THREADS: A threads sample type. This is expressed as the total number of threads per app process.
        • TX
        • TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.

      • url (string) --

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

  • NextToken (string) --

    A token to resume pagination.