set_text_message_spend_limit_override ¶

set_text_message_spend_limit_override(
    monthly_limit: MonthlyLimit,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
) -> SetTextMessageSpendLimitOverrideResult

Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the MaxLimit, which is set by Amazon Web Services.

Parameters:

monthly_limit (MonthlyLimit) –

The new monthly limit to enforce on text messages.

Raises:

AccessDeniedException –

The request was denied because you don't have sufficient permissions to access the resource.
InternalServerException –

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
ThrottlingException –

An error that occurred because too many requests were sent during a certain amount of time.
ValidationException –

A validation exception for a field.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py

def set_text_message_spend_limit_override(
    self,
    monthly_limit: "capo_pinpoint_sms_voice_v2.types.monthly_limit.MonthlyLimit",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
) -> "capo_pinpoint_sms_voice_v2.types.set_text_message_spend_limit_override_result.SetTextMessageSpendLimitOverrideResult":
    """<p>Sets an account level monthly spend limit override for sending text messages. The requested spend limit must be less than or equal to the <code>MaxLimit</code>, which is set by Amazon Web Services. </p>

    Args:
        monthly_limit: <p>The new monthly limit to enforce on text messages.</p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.set_text_message_spend_limit_override_request.SetTextMessageSpendLimitOverrideRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.set_text_message_spend_limit_override_result.SetTextMessageSpendLimitOverrideResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.set_text_message_spend_limit_override

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.set_text_message_spend_limit_override.set_text_message_spend_limit_override(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("SetTextMessageSpendLimitOverride")
    )
    input_: capo_pinpoint_sms_voice_v2.types.set_text_message_spend_limit_override_request.SetTextMessageSpendLimitOverrideRequest = {
        "monthly_limit": monthly_limit
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output