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 |
Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an Error is returned.
Synopsis
- data UpdatePhoneNumber = UpdatePhoneNumber' {}
- newUpdatePhoneNumber :: Text -> UpdatePhoneNumber
- updatePhoneNumber_deletionProtectionEnabled :: Lens' UpdatePhoneNumber (Maybe Bool)
- updatePhoneNumber_optOutListName :: Lens' UpdatePhoneNumber (Maybe Text)
- updatePhoneNumber_selfManagedOptOutsEnabled :: Lens' UpdatePhoneNumber (Maybe Bool)
- updatePhoneNumber_twoWayChannelArn :: Lens' UpdatePhoneNumber (Maybe Text)
- updatePhoneNumber_twoWayEnabled :: Lens' UpdatePhoneNumber (Maybe Bool)
- updatePhoneNumber_phoneNumberId :: Lens' UpdatePhoneNumber Text
- data UpdatePhoneNumberResponse = UpdatePhoneNumberResponse' {
- createdTimestamp :: Maybe POSIX
- deletionProtectionEnabled :: Maybe Bool
- isoCountryCode :: Maybe Text
- messageType :: Maybe MessageType
- monthlyLeasingPrice :: Maybe Text
- numberCapabilities :: Maybe (NonEmpty NumberCapability)
- numberType :: Maybe NumberType
- optOutListName :: Maybe Text
- phoneNumber :: Maybe Text
- phoneNumberArn :: Maybe Text
- phoneNumberId :: Maybe Text
- selfManagedOptOutsEnabled :: Maybe Bool
- status :: Maybe NumberStatus
- twoWayChannelArn :: Maybe Text
- twoWayEnabled :: Maybe Bool
- httpStatus :: Int
- newUpdatePhoneNumberResponse :: Int -> UpdatePhoneNumberResponse
- updatePhoneNumberResponse_createdTimestamp :: Lens' UpdatePhoneNumberResponse (Maybe UTCTime)
- updatePhoneNumberResponse_deletionProtectionEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool)
- updatePhoneNumberResponse_isoCountryCode :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_messageType :: Lens' UpdatePhoneNumberResponse (Maybe MessageType)
- updatePhoneNumberResponse_monthlyLeasingPrice :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_numberCapabilities :: Lens' UpdatePhoneNumberResponse (Maybe (NonEmpty NumberCapability))
- updatePhoneNumberResponse_numberType :: Lens' UpdatePhoneNumberResponse (Maybe NumberType)
- updatePhoneNumberResponse_optOutListName :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_phoneNumber :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_phoneNumberArn :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_phoneNumberId :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool)
- updatePhoneNumberResponse_status :: Lens' UpdatePhoneNumberResponse (Maybe NumberStatus)
- updatePhoneNumberResponse_twoWayChannelArn :: Lens' UpdatePhoneNumberResponse (Maybe Text)
- updatePhoneNumberResponse_twoWayEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool)
- updatePhoneNumberResponse_httpStatus :: Lens' UpdatePhoneNumberResponse Int
Creating a Request
data UpdatePhoneNumber Source #
See: newUpdatePhoneNumber
smart constructor.
UpdatePhoneNumber' | |
|
Instances
Create a value of UpdatePhoneNumber
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:
UpdatePhoneNumber
, updatePhoneNumber_deletionProtectionEnabled
- By default this is set to false. When set to true the phone number
can't be deleted.
UpdatePhoneNumber
, updatePhoneNumber_optOutListName
- The OptOutList to add the phone number to. Valid values for this field
can be either the OutOutListName or OutOutListArn.
UpdatePhoneNumber
, updatePhoneNumber_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.
UpdatePhoneNumber
, updatePhoneNumber_twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.
UpdatePhoneNumber
, updatePhoneNumber_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
UpdatePhoneNumber
, updatePhoneNumber_phoneNumberId
- The unique identifier of the phone number. Valid values for this field
can be either the PhoneNumberId or PhoneNumberArn.
Request Lenses
updatePhoneNumber_deletionProtectionEnabled :: Lens' UpdatePhoneNumber (Maybe Bool) Source #
By default this is set to false. When set to true the phone number can't be deleted.
updatePhoneNumber_optOutListName :: Lens' UpdatePhoneNumber (Maybe Text) Source #
The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.
updatePhoneNumber_selfManagedOptOutsEnabled :: Lens' UpdatePhoneNumber (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.
updatePhoneNumber_twoWayChannelArn :: Lens' UpdatePhoneNumber (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
updatePhoneNumber_twoWayEnabled :: Lens' UpdatePhoneNumber (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
updatePhoneNumber_phoneNumberId :: Lens' UpdatePhoneNumber Text Source #
The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
Destructuring the Response
data UpdatePhoneNumberResponse Source #
See: newUpdatePhoneNumberResponse
smart constructor.
UpdatePhoneNumberResponse' | |
|
Instances
newUpdatePhoneNumberResponse Source #
Create a value of UpdatePhoneNumberResponse
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:
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_createdTimestamp
- The time when the phone number was created, in
UNIX epoch time format.
UpdatePhoneNumber
, updatePhoneNumberResponse_deletionProtectionEnabled
- When set to true the phone number can't be deleted.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_isoCountryCode
- The two-character code, in ISO 3166-1 alpha-2 format, for the country or
region.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_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.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_monthlyLeasingPrice
- The monthly leasing price of the phone number, in US dollars.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_numberCapabilities
- Specifies if the number could be used for text messages, voice or both.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_numberType
- The type of number that was requested.
UpdatePhoneNumber
, updatePhoneNumberResponse_optOutListName
- The name of the OptOutList associated with the phone number.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_phoneNumber
- The phone number that was updated.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_phoneNumberArn
- The Amazon Resource Name (ARN) of the updated phone number.
UpdatePhoneNumber
, updatePhoneNumberResponse_phoneNumberId
- The unique identifier of the phone number.
UpdatePhoneNumber
, updatePhoneNumberResponse_selfManagedOptOutsEnabled
- This is true if self managed opt-out are enabled.
UpdatePhoneNumberResponse
, updatePhoneNumberResponse_status
- The current status of the request.
UpdatePhoneNumber
, updatePhoneNumberResponse_twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.
UpdatePhoneNumber
, updatePhoneNumberResponse_twoWayEnabled
- By default this is set to false. When set to true you can receive
incoming text messages from your end recipients.
$sel:httpStatus:UpdatePhoneNumberResponse'
, updatePhoneNumberResponse_httpStatus
- The response's http status code.
Response Lenses
updatePhoneNumberResponse_createdTimestamp :: Lens' UpdatePhoneNumberResponse (Maybe UTCTime) Source #
The time when the phone number was created, in UNIX epoch time format.
updatePhoneNumberResponse_deletionProtectionEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool) Source #
When set to true the phone number can't be deleted.
updatePhoneNumberResponse_isoCountryCode :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
updatePhoneNumberResponse_messageType :: Lens' UpdatePhoneNumberResponse (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.
updatePhoneNumberResponse_monthlyLeasingPrice :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The monthly leasing price of the phone number, in US dollars.
updatePhoneNumberResponse_numberCapabilities :: Lens' UpdatePhoneNumberResponse (Maybe (NonEmpty NumberCapability)) Source #
Specifies if the number could be used for text messages, voice or both.
updatePhoneNumberResponse_numberType :: Lens' UpdatePhoneNumberResponse (Maybe NumberType) Source #
The type of number that was requested.
updatePhoneNumberResponse_optOutListName :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The name of the OptOutList associated with the phone number.
updatePhoneNumberResponse_phoneNumber :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The phone number that was updated.
updatePhoneNumberResponse_phoneNumberArn :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the updated phone number.
updatePhoneNumberResponse_phoneNumberId :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The unique identifier of the phone number.
updatePhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool) Source #
This is true if self managed opt-out are enabled.
updatePhoneNumberResponse_status :: Lens' UpdatePhoneNumberResponse (Maybe NumberStatus) Source #
The current status of the request.
updatePhoneNumberResponse_twoWayChannelArn :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the two way channel.
updatePhoneNumberResponse_twoWayEnabled :: Lens' UpdatePhoneNumberResponse (Maybe Bool) Source #
By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
updatePhoneNumberResponse_httpStatus :: Lens' UpdatePhoneNumberResponse Int Source #
The response's http status code.