class DeviceFarm.Paginator.ListDeviceInstances
paginator = client.get_paginator('list_device_instances')

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

See also: AWS API Documentation

Request Syntax

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

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

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

Return type
Response Syntax
    'deviceInstances': [
            'arn': 'string',
            'deviceArn': 'string',
            'labels': [
            'status': 'IN_USE'|'PREPARING'|'AVAILABLE'|'NOT_AVAILABLE',
            'udid': 'string',
            'instanceProfile': {
                'arn': 'string',
                'packageCleanup': True|False,
                'excludeAppPackagesFromCleanup': [
                'rebootAfterUse': True|False,
                'name': 'string',
                'description': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) --
    • deviceInstances (list) --

      An object that contains information about your device instances.

      • (dict) --

        Represents the device instance.

        • arn (string) --

          The Amazon Resource Name (ARN) of the device instance.

        • deviceArn (string) --

          The ARN of the device.

        • labels (list) --

          An array of strings that describe the device instance.

          • (string) --
        • status (string) --

          The status of the device instance. Valid values are listed here.

        • udid (string) --

          Unique device identifier for the device instance.

        • instanceProfile (dict) --

          A object that contains information about the instance profile.

          • arn (string) --

            The Amazon Resource Name (ARN) of the instance profile.

          • packageCleanup (boolean) --

            When set to true , Device Farm removes app packages after a test run. The default value is false for private devices.

          • excludeAppPackagesFromCleanup (list) --

            An array of strings containing the list of app packages that should not be cleaned up from the device after a test run completes.

            The list of packages is considered only if you set packageCleanup to true .

            • (string) --
          • rebootAfterUse (boolean) --

            When set to true , Device Farm reboots the instance after a test run. The default value is true .

          • name (string) --

            The name of the instance profile.

          • description (string) --

            The description of the instance profile.

    • NextToken (string) --

      A token to resume pagination.