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 |
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' {}
- 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.
RequestPhoneNumber' | |
|
Instances
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.
requestPhoneNumber_numberType :: Lens' RequestPhoneNumber RequestableNumberType Source #
The type of phone number to request.
Destructuring the Response
data RequestPhoneNumberResponse Source #
See: newRequestPhoneNumberResponse
smart constructor.
RequestPhoneNumberResponse' | |
|
Instances
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_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.