Braket / Paginator / SearchSpendingLimits

SearchSpendingLimits

class Braket.Paginator.SearchSpendingLimits

paginator = client.get_paginator('search_spending_limits')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ],
            'operator': 'EQUAL'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  The filters to apply when searching for spending limits. Use filters to narrow down the results based on specific criteria.

  • (dict) –

    Specifies filter criteria for searching spending limits. Use filters to narrow down results based on specific attributes.

    • name (string) – [REQUIRED]

      The name of the field to filter on. Currently only supports deviceArn.

    • values (list) – [REQUIRED]

      An array of values to match against the specified field.

      • (string) –

    • operator (string) – [REQUIRED]

      The comparison operator to use when filtering.

• 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

{
    'spendingLimits': [
        {
            'spendingLimitArn': 'string',
            'deviceArn': 'string',
            'timePeriod': {
                'startAt': datetime(2015, 1, 1),
                'endAt': datetime(2015, 1, 1)
            },
            'spendingLimit': 'string',
            'queuedSpend': 'string',
            'totalSpend': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • spendingLimits (list) –

    An array of spending limit summaries that match the specified filters.

    • (dict) –

      Contains summary information about a spending limit, including current spending status and configuration details.

      • spendingLimitArn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies the spending limit.

      • deviceArn (string) –

        The Amazon Resource Name (ARN) of the quantum device associated with this spending limit.

      • timePeriod (dict) –

        The time period during which the spending limit is active.

        • startAt (datetime) –

          The start date and time for the spending limit period, in epoch seconds.

        • endAt (datetime) –

          The end date and time for the spending limit period, in epoch seconds.

      • spendingLimit (string) –

        The maximum spending amount allowed for the device during the specified time period, in USD.

      • queuedSpend (string) –

        The amount currently queued for spending on the device, in USD.

      • totalSpend (string) –

        The total amount spent on the device so far during the current time period, in USD.

      • createdAt (datetime) –

        The date and time when the spending limit was created, in epoch seconds.

      • updatedAt (datetime) –

        The date and time when the spending limit was last modified, in epoch seconds.

      • tags (dict) –

        The tags associated with the spending limit. Each tag consists of a key and an optional value.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.