libZSservicesZSamazonka-snsZSamazonka-sns
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SNS.CreateSMSSandboxPhoneNumber

Description

Adds a destination phone number to an account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

When you start using Amazon SNS to send SMS messages, your 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 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.

Synopsis

Creating a Request

data CreateSMSSandboxPhoneNumber Source #

See: newCreateSMSSandboxPhoneNumber smart constructor.

Constructors

CreateSMSSandboxPhoneNumber' 

Fields

  • languageCode :: Maybe LanguageCodeString

    The language to use for sending the OTP. The default value is en-US.

  • phoneNumber :: Text

    The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.

Instances

Instances details
Eq CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

Read CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

Show CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

Generic CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

Associated Types

type Rep CreateSMSSandboxPhoneNumber :: Type -> Type #

NFData CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

Hashable CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

AWSRequest CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

ToHeaders CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

ToPath CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

ToQuery CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

type Rep CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

type Rep CreateSMSSandboxPhoneNumber = D1 ('MetaData "CreateSMSSandboxPhoneNumber" "Amazonka.SNS.CreateSMSSandboxPhoneNumber" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "CreateSMSSandboxPhoneNumber'" 'PrefixI 'True) (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCodeString)) :*: S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateSMSSandboxPhoneNumber Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

newCreateSMSSandboxPhoneNumber Source #

Create a value of CreateSMSSandboxPhoneNumber with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:languageCode:CreateSMSSandboxPhoneNumber', createSMSSandboxPhoneNumber_languageCode - The language to use for sending the OTP. The default value is en-US.

$sel:phoneNumber:CreateSMSSandboxPhoneNumber', createSMSSandboxPhoneNumber_phoneNumber - The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.

Request Lenses

createSMSSandboxPhoneNumber_languageCode :: Lens' CreateSMSSandboxPhoneNumber (Maybe LanguageCodeString) Source #

The language to use for sending the OTP. The default value is en-US.

createSMSSandboxPhoneNumber_phoneNumber :: Lens' CreateSMSSandboxPhoneNumber Text Source #

The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to.

Destructuring the Response

data CreateSMSSandboxPhoneNumberResponse Source #

Constructors

CreateSMSSandboxPhoneNumberResponse' 

Fields

Instances

Instances details
Eq CreateSMSSandboxPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

Read CreateSMSSandboxPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

Show CreateSMSSandboxPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

Generic CreateSMSSandboxPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

NFData CreateSMSSandboxPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

type Rep CreateSMSSandboxPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.SNS.CreateSMSSandboxPhoneNumber

type Rep CreateSMSSandboxPhoneNumberResponse = D1 ('MetaData "CreateSMSSandboxPhoneNumberResponse" "Amazonka.SNS.CreateSMSSandboxPhoneNumber" "libZSservicesZSamazonka-snsZSamazonka-sns" 'False) (C1 ('MetaCons "CreateSMSSandboxPhoneNumberResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSMSSandboxPhoneNumberResponse Source #

Create a value of CreateSMSSandboxPhoneNumberResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateSMSSandboxPhoneNumberResponse', createSMSSandboxPhoneNumberResponse_httpStatus - The response's http status code.

Response Lenses