amazonka-pinpoint-sms-voice-v2-2.0: Amazon Pinpoint SMS Voice V2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Description

Request an origination phone number for use in your account. For more information on phone number request see Requesting a number in the Amazon Pinpoint User Guide.

Synopsis

Creating a Request

data RequestPhoneNumber Source #

See: newRequestPhoneNumber smart constructor.

Constructors

RequestPhoneNumber' 

Fields

  • clientToken :: Maybe Text

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

  • deletionProtectionEnabled :: Maybe Bool

    By default this is set to false. When set to true the phone number can't be deleted.

  • optOutListName :: Maybe Text

    The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.

  • poolId :: Maybe Text

    The pool to associated with the phone number. You can use the PoolId or PoolArn.

  • registrationId :: Maybe Text

    Use this field to attach your phone number for an external registration process.

  • tags :: Maybe [Tag]

    An array of tags (key and value pairs) associate with the requested phone number.

  • isoCountryCode :: Text

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • messageType :: MessageType

    The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

  • numberCapabilities :: NonEmpty NumberCapability

    Indicates if the phone number will be used for text messages, voice messages, or both.

  • numberType :: RequestableNumberType

    The type of phone number to request.

Instances

Instances details
ToJSON RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

ToHeaders RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

ToPath RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

ToQuery RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

AWSRequest RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Associated Types

type AWSResponse RequestPhoneNumber #

Generic RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Associated Types

type Rep RequestPhoneNumber :: Type -> Type #

Read RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Show RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

NFData RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Methods

rnf :: RequestPhoneNumber -> () #

Eq RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Hashable RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

type AWSResponse RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

type Rep RequestPhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

newRequestPhoneNumber Source #

Create a value of RequestPhoneNumber 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:clientToken:RequestPhoneNumber', requestPhoneNumber_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

RequestPhoneNumber, requestPhoneNumber_deletionProtectionEnabled - By default this is set to false. When set to true the phone number can't be deleted.

RequestPhoneNumber, requestPhoneNumber_optOutListName - The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.

RequestPhoneNumber, requestPhoneNumber_poolId - The pool to associated with the phone number. You can use the PoolId or PoolArn.

$sel:registrationId:RequestPhoneNumber', requestPhoneNumber_registrationId - Use this field to attach your phone number for an external registration process.

RequestPhoneNumber, requestPhoneNumber_tags - An array of tags (key and value pairs) associate with the requested phone number.

RequestPhoneNumber, requestPhoneNumber_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

RequestPhoneNumber, requestPhoneNumber_messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

RequestPhoneNumber, requestPhoneNumber_numberCapabilities - Indicates if the phone number will be used for text messages, voice messages, or both.

RequestPhoneNumber, requestPhoneNumber_numberType - The type of phone number to request.

Request Lenses

requestPhoneNumber_clientToken :: Lens' RequestPhoneNumber (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

requestPhoneNumber_deletionProtectionEnabled :: Lens' RequestPhoneNumber (Maybe Bool) Source #

By default this is set to false. When set to true the phone number can't be deleted.

requestPhoneNumber_optOutListName :: Lens' RequestPhoneNumber (Maybe Text) Source #

The name of the OptOutList to associate with the phone number. You can use the OutOutListName or OptPutListArn.

requestPhoneNumber_poolId :: Lens' RequestPhoneNumber (Maybe Text) Source #

The pool to associated with the phone number. You can use the PoolId or PoolArn.

requestPhoneNumber_registrationId :: Lens' RequestPhoneNumber (Maybe Text) Source #

Use this field to attach your phone number for an external registration process.

requestPhoneNumber_tags :: Lens' RequestPhoneNumber (Maybe [Tag]) Source #

An array of tags (key and value pairs) associate with the requested phone number.

requestPhoneNumber_isoCountryCode :: Lens' RequestPhoneNumber Text Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

requestPhoneNumber_messageType :: Lens' RequestPhoneNumber MessageType Source #

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

requestPhoneNumber_numberCapabilities :: Lens' RequestPhoneNumber (NonEmpty NumberCapability) Source #

Indicates if the phone number will be used for text messages, voice messages, or both.

Destructuring the Response

data RequestPhoneNumberResponse Source #

See: newRequestPhoneNumberResponse smart constructor.

Constructors

RequestPhoneNumberResponse' 

Fields

Instances

Instances details
Generic RequestPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Associated Types

type Rep RequestPhoneNumberResponse :: Type -> Type #

Read RequestPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Show RequestPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

NFData RequestPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Eq RequestPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

type Rep RequestPhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

type Rep RequestPhoneNumberResponse = D1 ('MetaData "RequestPhoneNumberResponse" "Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "RequestPhoneNumberResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "deletionProtectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "isoCountryCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)))) :*: ((S1 ('MetaSel ('Just "monthlyLeasingPrice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "numberCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty NumberCapability)))) :*: (S1 ('MetaSel ('Just "numberType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestableNumberType)) :*: (S1 ('MetaSel ('Just "optOutListName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "phoneNumberArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "phoneNumberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "poolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "selfManagedOptOutsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NumberStatus)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "twoWayChannelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "twoWayEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newRequestPhoneNumberResponse Source #

Create a value of RequestPhoneNumberResponse 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:

RequestPhoneNumberResponse, requestPhoneNumberResponse_createdTimestamp - The time when the phone number was created, in UNIX epoch time format.

RequestPhoneNumber, requestPhoneNumberResponse_deletionProtectionEnabled - By default this is set to false. When set to true the phone number can't be deleted.

RequestPhoneNumber, requestPhoneNumberResponse_isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

RequestPhoneNumber, requestPhoneNumberResponse_messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

RequestPhoneNumberResponse, requestPhoneNumberResponse_monthlyLeasingPrice - The monthly price, in US dollars, to lease the phone number.

RequestPhoneNumber, requestPhoneNumberResponse_numberCapabilities - Indicates if the phone number will be used for text messages, voice messages or both.

RequestPhoneNumber, requestPhoneNumberResponse_numberType - The type of number that was released.

RequestPhoneNumber, requestPhoneNumberResponse_optOutListName - The name of the OptOutList that is associated with the requested phone number.

RequestPhoneNumberResponse, requestPhoneNumberResponse_phoneNumber - The new phone number that was requested.

RequestPhoneNumberResponse, requestPhoneNumberResponse_phoneNumberArn - The Amazon Resource Name (ARN) of the requested phone number.

RequestPhoneNumberResponse, requestPhoneNumberResponse_phoneNumberId - The unique identifier of the new phone number.

RequestPhoneNumber, requestPhoneNumberResponse_poolId - The unique identifier of the pool associated with the phone number

RequestPhoneNumberResponse, requestPhoneNumberResponse_selfManagedOptOutsEnabled - By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

RequestPhoneNumberResponse, requestPhoneNumberResponse_status - The current status of the request.

RequestPhoneNumber, requestPhoneNumberResponse_tags - An array of key and value pair tags that are associated with the phone number.

RequestPhoneNumberResponse, requestPhoneNumberResponse_twoWayChannelArn - The ARN used to identify the two way channel.

RequestPhoneNumberResponse, requestPhoneNumberResponse_twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

$sel:httpStatus:RequestPhoneNumberResponse', requestPhoneNumberResponse_httpStatus - The response's http status code.

Response Lenses

requestPhoneNumberResponse_deletionProtectionEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool) Source #

By default this is set to false. When set to true the phone number can't be deleted.

requestPhoneNumberResponse_isoCountryCode :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

requestPhoneNumberResponse_messageType :: Lens' RequestPhoneNumberResponse (Maybe MessageType) Source #

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

requestPhoneNumberResponse_monthlyLeasingPrice :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #

The monthly price, in US dollars, to lease the phone number.

requestPhoneNumberResponse_numberCapabilities :: Lens' RequestPhoneNumberResponse (Maybe (NonEmpty NumberCapability)) Source #

Indicates if the phone number will be used for text messages, voice messages or both.

requestPhoneNumberResponse_optOutListName :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #

The name of the OptOutList that is associated with the requested phone number.

requestPhoneNumberResponse_phoneNumberArn :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the requested phone number.

requestPhoneNumberResponse_poolId :: Lens' RequestPhoneNumberResponse (Maybe Text) Source #

The unique identifier of the pool associated with the phone number

requestPhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool) Source #

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

requestPhoneNumberResponse_tags :: Lens' RequestPhoneNumberResponse (Maybe [Tag]) Source #

An array of key and value pair tags that are associated with the phone number.

requestPhoneNumberResponse_twoWayEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool) Source #

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.