PinpointSMSVoiceV2 / Paginator / DescribeSpendLimits

DescribeSpendLimits

class PinpointSMSVoiceV2.Paginator.DescribeSpendLimits

paginator = client.get_paginator('describe_spend_limits')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PinpointSMSVoiceV2.Client.describe_spend_limits().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'SpendLimits': [
        {
            'Name': 'TEXT_MESSAGE_MONTHLY_SPEND_LIMIT'|'VOICE_MESSAGE_MONTHLY_SPEND_LIMIT'|'MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT',
            'EnforcedLimit': 123,
            'MaxLimit': 123,
            'Overridden': True|False
        },
    ],

}

Response Structure

• (dict) –

  • SpendLimits (list) –

    An array of SpendLimit objects that contain the details for the requested spend limits.

    • (dict) –

      Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting increases to your monthly SMS spending quota for Amazon Pinpoint in the Amazon Pinpoint User Guide.

      • Name (string) –

        The name for the SpendLimit.

      • EnforcedLimit (integer) –

        The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.

      • MaxLimit (integer) –

        The maximum amount of money that you are able to spend to send messages each month, in US dollars.

      • Overridden (boolean) –

        When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.