Braket / Client / search_spending_limits

search_spending_limits

Braket.Client.search_spending_limits(**kwargs)

Searches and lists spending limits based on specified filters. This operation supports pagination and allows filtering by various criteria to find specific spending limits. We recommend using pagination to ensure that the operation returns quickly and successfully.

See also: AWS API Documentation

Request Syntax

response = client.search_spending_limits(
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ],
            'operator': 'EQUAL'
        },
    ]
)

Parameters:

• nextToken (string) – The token to retrieve the next page of results. This value is returned from a previous call to SearchSpendingLimits when there are more results available.

• maxResults (integer) – The maximum number of results to return in a single call. Minimum value of 1, maximum value of 100. Default is 20.

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

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) –

    The token to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

• Braket.Client.exceptions.AccessDeniedException

• Braket.Client.exceptions.ThrottlingException

• Braket.Client.exceptions.InternalServiceException

• Braket.Client.exceptions.ValidationException