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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Releases an existing origination phone number in your account. Once released, a phone number is no longer available for sending messages.

If the origination phone number has deletion protection enabled or is associated with a pool, an Error is returned.

Synopsis

Creating a Request

data ReleasePhoneNumber Source #

See: newReleasePhoneNumber smart constructor.

Constructors

ReleasePhoneNumber'
Fields phoneNumberId :: Text The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.

Instances

Instances details

ToJSON ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods toJSON :: ReleasePhoneNumber -> Value # toEncoding :: ReleasePhoneNumber -> Encoding # toJSONList :: [ReleasePhoneNumber] -> Value # toEncodingList :: [ReleasePhoneNumber] -> Encoding #
ToHeaders ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods toHeaders :: ReleasePhoneNumber -> [Header] #
ToPath ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods toPath :: ReleasePhoneNumber -> ByteString #
ToQuery ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods toQuery :: ReleasePhoneNumber -> QueryString #
AWSRequest ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Associated Types type AWSResponse ReleasePhoneNumber # Methods request :: (Service -> Service) -> ReleasePhoneNumber -> Request ReleasePhoneNumber # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ReleasePhoneNumber -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ReleasePhoneNumber))) #
Generic ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Associated Types type Rep ReleasePhoneNumber :: Type -> Type # Methods from :: ReleasePhoneNumber -> Rep ReleasePhoneNumber x # to :: Rep ReleasePhoneNumber x -> ReleasePhoneNumber #
Read ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods readsPrec :: Int -> ReadS ReleasePhoneNumber # readList :: ReadS [ReleasePhoneNumber] # readPrec :: ReadPrec ReleasePhoneNumber # readListPrec :: ReadPrec [ReleasePhoneNumber] #
Show ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods showsPrec :: Int -> ReleasePhoneNumber -> ShowS # show :: ReleasePhoneNumber -> String # showList :: [ReleasePhoneNumber] -> ShowS #
NFData ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods rnf :: ReleasePhoneNumber -> () #
Eq ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods (==) :: ReleasePhoneNumber -> ReleasePhoneNumber -> Bool # (/=) :: ReleasePhoneNumber -> ReleasePhoneNumber -> Bool #
Hashable ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods hashWithSalt :: Int -> ReleasePhoneNumber -> Int # hash :: ReleasePhoneNumber -> Int #
type AWSResponse ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber type AWSResponse ReleasePhoneNumber = ReleasePhoneNumberResponse
type Rep ReleasePhoneNumber Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber type Rep ReleasePhoneNumber = D1 ('MetaData "ReleasePhoneNumber" "Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "ReleasePhoneNumber'" 'PrefixI 'True) (S1 ('MetaSel ('Just "phoneNumberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newReleasePhoneNumber Source #

Arguments

:: Text	`ReleasePhoneNumber`
-> ReleasePhoneNumber

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

ReleasePhoneNumber, releasePhoneNumber_phoneNumberId - The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.

Request Lenses

releasePhoneNumber_phoneNumberId :: Lens' ReleasePhoneNumber Text Source #

The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.

Destructuring the Response

data ReleasePhoneNumberResponse Source #

See: newReleasePhoneNumberResponse smart constructor.

Constructors

ReleasePhoneNumberResponse'

Fields

createdTimestamp :: Maybe POSIX
The time when the phone number was created, in UNIX epoch time format.
isoCountryCode :: Maybe Text
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
messageType :: Maybe MessageType
The message type that was associated with the phone number.
monthlyLeasingPrice :: Maybe Text
The monthly price of the phone number, in US dollars.
numberCapabilities :: Maybe (NonEmpty NumberCapability)
Specifies if the number could be used for text messages, voice, or both.
numberType :: Maybe NumberType
The type of number that was released.
optOutListName :: Maybe Text
The name of the OptOutList that was associated with the phone number.
phoneNumber :: Maybe Text
The phone number that was released.
phoneNumberArn :: Maybe Text
The PhoneNumberArn of the phone number that was released.
phoneNumberId :: Maybe Text
The PhoneNumberId of the phone number that was released.
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.
twoWayChannelArn :: Maybe Text
The Amazon Resource Name (ARN) of the TwoWayChannel.
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 ReleasePhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Associated Types type Rep ReleasePhoneNumberResponse :: Type -> Type # Methods from :: ReleasePhoneNumberResponse -> Rep ReleasePhoneNumberResponse x # to :: Rep ReleasePhoneNumberResponse x -> ReleasePhoneNumberResponse #
Read ReleasePhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods readsPrec :: Int -> ReadS ReleasePhoneNumberResponse # readList :: ReadS [ReleasePhoneNumberResponse] # readPrec :: ReadPrec ReleasePhoneNumberResponse # readListPrec :: ReadPrec [ReleasePhoneNumberResponse] #
Show ReleasePhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods showsPrec :: Int -> ReleasePhoneNumberResponse -> ShowS # show :: ReleasePhoneNumberResponse -> String # showList :: [ReleasePhoneNumberResponse] -> ShowS #
NFData ReleasePhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods rnf :: ReleasePhoneNumberResponse -> () #
Eq ReleasePhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber Methods (==) :: ReleasePhoneNumberResponse -> ReleasePhoneNumberResponse -> Bool # (/=) :: ReleasePhoneNumberResponse -> ReleasePhoneNumberResponse -> Bool #
type Rep ReleasePhoneNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber type Rep ReleasePhoneNumberResponse = D1 ('MetaData "ReleasePhoneNumberResponse" "Amazonka.PinpointSmsVoiceV2.ReleasePhoneNumber" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "ReleasePhoneNumberResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (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))))))

newReleasePhoneNumberResponse Source #

Arguments

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

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

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

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

ReleasePhoneNumberResponse, releasePhoneNumberResponse_messageType - The message type that was associated with the phone number.

ReleasePhoneNumberResponse, releasePhoneNumberResponse_monthlyLeasingPrice - The monthly price of the phone number, in US dollars.

ReleasePhoneNumberResponse, releasePhoneNumberResponse_numberCapabilities - Specifies if the number could be used for text messages, voice, or both.

ReleasePhoneNumberResponse, releasePhoneNumberResponse_numberType - The type of number that was released.

ReleasePhoneNumberResponse, releasePhoneNumberResponse_optOutListName - The name of the OptOutList that was associated with the phone number.

ReleasePhoneNumberResponse, releasePhoneNumberResponse_phoneNumber - The phone number that was released.

ReleasePhoneNumberResponse, releasePhoneNumberResponse_phoneNumberArn - The PhoneNumberArn of the phone number that was released.

ReleasePhoneNumber, releasePhoneNumberResponse_phoneNumberId - The PhoneNumberId of the phone number that was released.

ReleasePhoneNumberResponse, releasePhoneNumberResponse_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.

ReleasePhoneNumberResponse, releasePhoneNumberResponse_status - The current status of the request.

ReleasePhoneNumberResponse, releasePhoneNumberResponse_twoWayChannelArn - The Amazon Resource Name (ARN) of the TwoWayChannel.

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

$sel:httpStatus:ReleasePhoneNumberResponse', releasePhoneNumberResponse_httpStatus - The response's http status code.

Response Lenses

releasePhoneNumberResponse_createdTimestamp :: Lens' ReleasePhoneNumberResponse (Maybe UTCTime) Source #

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

releasePhoneNumberResponse_isoCountryCode :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #

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

releasePhoneNumberResponse_messageType :: Lens' ReleasePhoneNumberResponse (Maybe MessageType) Source #

The message type that was associated with the phone number.

releasePhoneNumberResponse_monthlyLeasingPrice :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #

The monthly price of the phone number, in US dollars.

releasePhoneNumberResponse_numberCapabilities :: Lens' ReleasePhoneNumberResponse (Maybe (NonEmpty NumberCapability)) Source #

Specifies if the number could be used for text messages, voice, or both.

releasePhoneNumberResponse_numberType :: Lens' ReleasePhoneNumberResponse (Maybe NumberType) Source #

The type of number that was released.

releasePhoneNumberResponse_optOutListName :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #

The name of the OptOutList that was associated with the phone number.

releasePhoneNumberResponse_phoneNumber :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #

The phone number that was released.

releasePhoneNumberResponse_phoneNumberArn :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #

The PhoneNumberArn of the phone number that was released.

releasePhoneNumberResponse_phoneNumberId :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #

The PhoneNumberId of the phone number that was released.

releasePhoneNumberResponse_selfManagedOptOutsEnabled :: Lens' ReleasePhoneNumberResponse (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.

releasePhoneNumberResponse_status :: Lens' ReleasePhoneNumberResponse (Maybe NumberStatus) Source #

The current status of the request.

releasePhoneNumberResponse_twoWayChannelArn :: Lens' ReleasePhoneNumberResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the TwoWayChannel.

releasePhoneNumberResponse_twoWayEnabled :: Lens' ReleasePhoneNumberResponse (Maybe Bool) Source #

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

releasePhoneNumberResponse_httpStatus :: Lens' ReleasePhoneNumberResponse Int Source #

The response's http status code.