SearchDevices

class Braket.Paginator.SearchDevices
paginator = client.get_paginator('search_devices')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Braket.Client.search_devices().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • filters (list) --

    [REQUIRED]

    The filter values to use to search for a device.

    • (dict) --

      The filter to use for searching devices.

      • name (string) -- [REQUIRED]

        The name to use to filter results.

      • values (list) -- [REQUIRED]

        The values to use to filter results.

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

dict

Returns

Response Syntax

{
    'devices': [
        {
            'deviceArn': 'string',
            'deviceName': 'string',
            'deviceStatus': 'ONLINE'|'OFFLINE'|'RETIRED',
            'deviceType': 'QPU'|'SIMULATOR',
            'providerName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • devices (list) --

      An array of DeviceSummary objects for devices that match the specified filter values.

      • (dict) --

        Includes information about the device.

        • deviceArn (string) --

          The ARN of the device.

        • deviceName (string) --

          The name of the device.

        • deviceStatus (string) --

          The status of the device.

        • deviceType (string) --

          The type of the device.

        • providerName (string) --

          The provider of the device.

    • NextToken (string) --

      A token to resume pagination.