Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data RequestPhoneNumber = RequestPhoneNumber' {
- clientToken :: Maybe Text
- deletionProtectionEnabled :: Maybe Bool
- optOutListName :: Maybe Text
- poolId :: Maybe Text
- registrationId :: Maybe Text
- tags :: Maybe [Tag]
- isoCountryCode :: Text
- messageType :: MessageType
- numberCapabilities :: NonEmpty NumberCapability
- numberType :: RequestableNumberType
}
newRequestPhoneNumber :: Text -> MessageType -> NonEmpty NumberCapability -> RequestableNumberType -> RequestPhoneNumber
requestPhoneNumber_clientToken :: Lens' RequestPhoneNumber (Maybe Text)
requestPhoneNumber_deletionProtectionEnabled :: Lens' RequestPhoneNumber (Maybe Bool)
requestPhoneNumber_optOutListName :: Lens' RequestPhoneNumber (Maybe Text)
requestPhoneNumber_poolId :: Lens' RequestPhoneNumber (Maybe Text)
requestPhoneNumber_registrationId :: Lens' RequestPhoneNumber (Maybe Text)
requestPhoneNumber_tags :: Lens' RequestPhoneNumber (Maybe [Tag])
requestPhoneNumber_isoCountryCode :: Lens' RequestPhoneNumber Text
requestPhoneNumber_messageType :: Lens' RequestPhoneNumber MessageType
requestPhoneNumber_numberCapabilities :: Lens' RequestPhoneNumber (NonEmpty NumberCapability)
requestPhoneNumber_numberType :: Lens' RequestPhoneNumber RequestableNumberType
data RequestPhoneNumberResponse = RequestPhoneNumberResponse' {
- createdTimestamp :: Maybe POSIX
- deletionProtectionEnabled :: Maybe Bool
- isoCountryCode :: Maybe Text
- messageType :: Maybe MessageType
- monthlyLeasingPrice :: Maybe Text
- numberCapabilities :: Maybe (NonEmpty NumberCapability)
- numberType :: Maybe RequestableNumberType
- optOutListName :: Maybe Text
- phoneNumber :: Maybe Text
- phoneNumberArn :: Maybe Text
- phoneNumberId :: Maybe Text
- poolId :: Maybe Text
- selfManagedOptOutsEnabled :: Maybe Bool
- status :: Maybe NumberStatus
- tags :: Maybe [Tag]
- twoWayChannelArn :: Maybe Text
- twoWayEnabled :: Maybe Bool
- httpStatus :: Int
}
newRequestPhoneNumberResponse :: Int -> RequestPhoneNumberResponse
requestPhoneNumberResponse_createdTimestamp :: Lens' RequestPhoneNumberResponse (Maybe UTCTime)
requestPhoneNumberResponse_deletionProtectionEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool)
requestPhoneNumberResponse_isoCountryCode :: Lens' RequestPhoneNumberResponse (Maybe Text)
requestPhoneNumberResponse_messageType :: Lens' RequestPhoneNumberResponse (Maybe MessageType)
requestPhoneNumberResponse_monthlyLeasingPrice :: Lens' RequestPhoneNumberResponse (Maybe Text)
requestPhoneNumberResponse_numberCapabilities :: Lens' RequestPhoneNumberResponse (Maybe (NonEmpty NumberCapability))
requestPhoneNumberResponse_numberType :: Lens' RequestPhoneNumberResponse (Maybe RequestableNumberType)
requestPhoneNumberResponse_optOutListName :: Lens' RequestPhoneNumberResponse (Maybe Text)
requestPhoneNumberResponse_phoneNumber :: Lens' RequestPhoneNumberResponse (Maybe Text)
requestPhoneNumberResponse_phoneNumberArn :: Lens' RequestPhoneNumberResponse (Maybe Text)
requestPhoneNumberResponse_phoneNumberId :: Lens' RequestPhoneNumberResponse (Maybe Text)
requestPhoneNumberResponse_poolId :: Lens' RequestPhoneNumberResponse (Maybe Text)
requestPhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool)
requestPhoneNumberResponse_status :: Lens' RequestPhoneNumberResponse (Maybe NumberStatus)
requestPhoneNumberResponse_tags :: Lens' RequestPhoneNumberResponse (Maybe [Tag])
requestPhoneNumberResponse_twoWayChannelArn :: Lens' RequestPhoneNumberResponse (Maybe Text)
requestPhoneNumberResponse_twoWayEnabled :: Lens' RequestPhoneNumberResponse (Maybe Bool)
requestPhoneNumberResponse_httpStatus :: Lens' RequestPhoneNumberResponse Int

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 Methods toJSON :: RequestPhoneNumber -> Value # toEncoding :: RequestPhoneNumber -> Encoding # toJSONList :: [RequestPhoneNumber] -> Value # toEncodingList :: [RequestPhoneNumber] -> Encoding #
ToHeaders RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods toHeaders :: RequestPhoneNumber -> [Header] #
ToPath RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods toPath :: RequestPhoneNumber -> ByteString #
ToQuery RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods toQuery :: RequestPhoneNumber -> QueryString #
AWSRequest RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Associated Types type AWSResponse RequestPhoneNumber # Methods request :: (Service -> Service) -> RequestPhoneNumber -> Request RequestPhoneNumber # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RequestPhoneNumber -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RequestPhoneNumber))) #
Generic RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Associated Types type Rep RequestPhoneNumber :: Type -> Type # Methods from :: RequestPhoneNumber -> Rep RequestPhoneNumber x # to :: Rep RequestPhoneNumber x -> RequestPhoneNumber #
Read RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods readsPrec :: Int -> ReadS RequestPhoneNumber # readList :: ReadS [RequestPhoneNumber] # readPrec :: ReadPrec RequestPhoneNumber # readListPrec :: ReadPrec [RequestPhoneNumber] #
Show RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods showsPrec :: Int -> RequestPhoneNumber -> ShowS # show :: RequestPhoneNumber -> String # showList :: [RequestPhoneNumber] -> ShowS #
NFData RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods rnf :: RequestPhoneNumber -> () #
Eq RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods (==) :: RequestPhoneNumber -> RequestPhoneNumber -> Bool # (/=) :: RequestPhoneNumber -> RequestPhoneNumber -> Bool #
Hashable RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods hashWithSalt :: Int -> RequestPhoneNumber -> Int # hash :: RequestPhoneNumber -> Int #
type AWSResponse RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber type AWSResponse RequestPhoneNumber = RequestPhoneNumberResponse
type Rep RequestPhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber type Rep RequestPhoneNumber = D1 ('MetaData "RequestPhoneNumber" "Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "RequestPhoneNumber'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deletionProtectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "optOutListName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "poolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "registrationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "isoCountryCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MessageType) :: (S1 ('MetaSel ('Just "numberCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty NumberCapability)) :*: S1 ('MetaSel ('Just "numberType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RequestableNumberType))))))

newRequestPhoneNumber Source #

Arguments

:: Text	`RequestPhoneNumber`
-> MessageType	`RequestPhoneNumber`
-> NonEmpty NumberCapability	`RequestPhoneNumber`
-> RequestableNumberType	`RequestPhoneNumber`
-> RequestPhoneNumber

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.

requestPhoneNumber_numberType :: Lens' RequestPhoneNumber RequestableNumberType Source #

The type of phone number to request.

Destructuring the Response

data RequestPhoneNumberResponse Source #

See: newRequestPhoneNumberResponse smart constructor.

Constructors

RequestPhoneNumberResponse'

Fields

createdTimestamp :: Maybe POSIX
The time when the phone number was created, in UNIX epoch time format.
deletionProtectionEnabled :: Maybe Bool
By default this is set to false. When set to true the phone number can't be deleted.
isoCountryCode :: Maybe Text
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
messageType :: Maybe 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.
monthlyLeasingPrice :: Maybe Text
The monthly price, in US dollars, to lease the phone number.
numberCapabilities :: Maybe (NonEmpty NumberCapability)
Indicates if the phone number will be used for text messages, voice messages or both.
numberType :: Maybe RequestableNumberType
The type of number that was released.
optOutListName :: Maybe Text
The name of the OptOutList that is associated with the requested phone number.
phoneNumber :: Maybe Text
The new phone number that was requested.
phoneNumberArn :: Maybe Text
The Amazon Resource Name (ARN) of the requested phone number.
phoneNumberId :: Maybe Text
The unique identifier of the new phone number.
poolId :: Maybe Text
The unique identifier of the pool associated with the phone number
selfManagedOptOutsEnabled :: Maybe Bool
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.
status :: Maybe NumberStatus
The current status of the request.
tags :: Maybe [Tag]
An array of key and value pair tags that are associated with the phone number.
twoWayChannelArn :: Maybe Text
The ARN used to identify the two way channel.
twoWayEnabled :: Maybe Bool
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic RequestPhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Associated Types type Rep RequestPhoneNumberResponse :: Type -> Type # Methods from :: RequestPhoneNumberResponse -> Rep RequestPhoneNumberResponse x # to :: Rep RequestPhoneNumberResponse x -> RequestPhoneNumberResponse #
Read RequestPhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods readsPrec :: Int -> ReadS RequestPhoneNumberResponse # readList :: ReadS [RequestPhoneNumberResponse] # readPrec :: ReadPrec RequestPhoneNumberResponse # readListPrec :: ReadPrec [RequestPhoneNumberResponse] #
Show RequestPhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods showsPrec :: Int -> RequestPhoneNumberResponse -> ShowS # show :: RequestPhoneNumberResponse -> String # showList :: [RequestPhoneNumberResponse] -> ShowS #
NFData RequestPhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods rnf :: RequestPhoneNumberResponse -> () #
Eq RequestPhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.RequestPhoneNumber Methods (==) :: RequestPhoneNumberResponse -> RequestPhoneNumberResponse -> Bool # (/=) :: RequestPhoneNumberResponse -> RequestPhoneNumberResponse -> Bool #
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 #

Arguments

:: Int	`$sel:httpStatus:RequestPhoneNumberResponse'`
-> RequestPhoneNumberResponse

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_createdTimestamp :: Lens' RequestPhoneNumberResponse (Maybe UTCTime) Source #

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

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_numberType :: Lens' RequestPhoneNumberResponse (Maybe RequestableNumberType) Source #

The type of number that was released.

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

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

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

The new phone number that was requested.

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

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

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

The unique identifier of the new 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_status :: Lens' RequestPhoneNumberResponse (Maybe NumberStatus) Source #

The current status of the request.

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

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

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

The ARN used to identify the two way channel.

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.

requestPhoneNumberResponse_httpStatus :: Lens' RequestPhoneNumberResponse Int Source #

The response's http status code.