Skip to content

get_sms_sandbox_account_status async

get_sms_sandbox_account_status(
    *, config_overrides: Optional[AsyncSNSClientConfig] = None
) -> GetSMSSandboxAccountStatusResult

Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.

Raises:

Source code in docs_src/capo_sns/_services/async_sns.py
async def get_sms_sandbox_account_status(
    self, *, config_overrides: Optional[AsyncSNSClientConfig] = None
) -> "capo_sns.types.get_sms_sandbox_account_status_result.GetSMSSandboxAccountStatusResult":
    """<p>Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.</p> <p>When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the <i>SMS sandbox</i>. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">SMS sandbox</a> in the <i>Amazon SNS Developer Guide</i>.</p>

    Raises:
        capo_sns.errors.authorization_error_exception.AuthorizationErrorException: <p>Indicates that the user has been denied access to the requested resource.</p>
        capo_sns.errors.internal_error_exception.InternalErrorException: <p>Indicates an internal service error.</p>
        capo_sns.errors.throttled_exception.ThrottledException: <p>Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.</p>
        capo_sns.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sns.types.get_sms_sandbox_account_status_input.GetSMSSandboxAccountStatusInput]",
    ) -> AsyncOperationResponse[
        "capo_sns.types.get_sms_sandbox_account_status_result.GetSMSSandboxAccountStatusResult"
    ]:
        import capo_sns._operations.amazon_simple_notification_service.get_sms_sandbox_account_status

        (
            output,
            http_response,
        ) = await capo_sns._operations.amazon_simple_notification_service.get_sms_sandbox_account_status.async_get_sms_sandbox_account_status(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSMSSandboxAccountStatus")
    )
    input_: capo_sns.types.get_sms_sandbox_account_status_input.GetSMSSandboxAccountStatusInput = {}

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output