DeviceFarm / Client / list_device_instances

list_device_instances#

DeviceFarm.Client.list_device_instances(**kwargs)#

Returns information about the private device instances associated with one or more AWS accounts.

See also: AWS API Documentation

Request Syntax

response = client.list_device_instances(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – An integer that specifies the maximum number of items you want to return in the API response.

  • nextToken (string) – An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Return type:

dict

Returns:

Response Syntax

{
    'deviceInstances': [
        {
            'arn': 'string',
            'deviceArn': 'string',
            'labels': [
                'string',
            ],
            'status': 'IN_USE'|'PREPARING'|'AVAILABLE'|'NOT_AVAILABLE',
            'udid': 'string',
            'instanceProfile': {
                'arn': 'string',
                'packageCleanup': True|False,
                'excludeAppPackagesFromCleanup': [
                    'string',
                ],
                '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) –

      An identifier that can be used in the next call to this operation to return the next set of items in the list.

Exceptions

  • DeviceFarm.Client.exceptions.ArgumentException

  • DeviceFarm.Client.exceptions.NotFoundException

  • DeviceFarm.Client.exceptions.LimitExceededException

  • DeviceFarm.Client.exceptions.ServiceAccountException