PinpointSMSVoiceV2 / Client / describe_spend_limits

describe_spend_limits#

PinpointSMSVoiceV2.Client.describe_spend_limits(**kwargs)#

Describes the current Amazon Pinpoint monthly spend limits for sending voice and text messages.

When you establish an Amazon Web Services account, the account has initial monthly spend limit in a given Region. 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.

See also: AWS API Documentation

Request Syntax

response = client.describe_spend_limits(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – The token to be used for the next set of paginated results. You don’t need to supply a value for this field in the initial request.

  • MaxResults (integer) – The maximum number of results to return per each request.

Return type:

dict

Returns:

Response Syntax

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

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.

    • NextToken (string) –

      The token to be used for the next set of paginated results. If this field is empty then there are no more results.

Exceptions

  • PinpointSMSVoiceV2.Client.exceptions.ThrottlingException

  • PinpointSMSVoiceV2.Client.exceptions.AccessDeniedException

  • PinpointSMSVoiceV2.Client.exceptions.ValidationException

  • PinpointSMSVoiceV2.Client.exceptions.InternalServerException