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.UpdatePhoneNumber

Description

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

Creating a Request

data UpdatePhoneNumber Source #

See: newUpdatePhoneNumber smart constructor.

Constructors

UpdatePhoneNumber' 

Fields

  • 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 OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

  • 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.

  • twoWayChannelArn :: Maybe Text

    The Amazon Resource Name (ARN) of 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.

  • phoneNumberId :: Text

    The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

Instances

Instances details
ToJSON UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

ToHeaders UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

ToPath UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

ToQuery UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

AWSRequest UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

Associated Types

type AWSResponse UpdatePhoneNumber #

Generic UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

Associated Types

type Rep UpdatePhoneNumber :: Type -> Type #

Read UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

Show UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

NFData UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

Methods

rnf :: UpdatePhoneNumber -> () #

Eq UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

Hashable UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

type AWSResponse UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

type Rep UpdatePhoneNumber Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

type Rep UpdatePhoneNumber = D1 ('MetaData "UpdatePhoneNumber" "Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "UpdatePhoneNumber'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deletionProtectionEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "optOutListName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "selfManagedOptOutsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "twoWayChannelArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "twoWayEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "phoneNumberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdatePhoneNumber Source #

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.

Constructors

UpdatePhoneNumberResponse' 

Fields

Instances

Instances details
Generic UpdatePhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

Associated Types

type Rep UpdatePhoneNumberResponse :: Type -> Type #

Read UpdatePhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

Show UpdatePhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

NFData UpdatePhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

Eq UpdatePhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

type Rep UpdatePhoneNumberResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber

type Rep UpdatePhoneNumberResponse = D1 ('MetaData "UpdatePhoneNumberResponse" "Amazonka.PinpointSmsVoiceV2.UpdatePhoneNumber" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "UpdatePhoneNumberResponse'" '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 NumberType)) :*: 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 "selfManagedOptOutsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NumberStatus)) :*: 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))))))

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_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_optOutListName :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #

The name of the OptOutList associated with the phone number.

updatePhoneNumberResponse_phoneNumberArn :: Lens' UpdatePhoneNumberResponse (Maybe Text) Source #

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

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.