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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an Error is returned.

Synopsis

Creating a Request

data DeleteOptedOutNumber Source #

See: newDeleteOptedOutNumber smart constructor.

Constructors

DeleteOptedOutNumber'
Fields optOutListName :: Text The OptOutListName or OptOutListArn to remove the phone number from. optedOutNumber :: Text The phone number, in E.164 format, to remove from the OptOutList.

Instances

Instances details

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

newDeleteOptedOutNumber Source #

Arguments

:: Text	`DeleteOptedOutNumber`
-> Text	`DeleteOptedOutNumber`
-> DeleteOptedOutNumber

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

DeleteOptedOutNumber, deleteOptedOutNumber_optOutListName - The OptOutListName or OptOutListArn to remove the phone number from.

DeleteOptedOutNumber, deleteOptedOutNumber_optedOutNumber - The phone number, in E.164 format, to remove from the OptOutList.

Request Lenses

deleteOptedOutNumber_optOutListName :: Lens' DeleteOptedOutNumber Text Source #

The OptOutListName or OptOutListArn to remove the phone number from.

deleteOptedOutNumber_optedOutNumber :: Lens' DeleteOptedOutNumber Text Source #

The phone number, in E.164 format, to remove from the OptOutList.

Destructuring the Response

data DeleteOptedOutNumberResponse Source #

See: newDeleteOptedOutNumberResponse smart constructor.

Constructors

DeleteOptedOutNumberResponse'

Fields

endUserOptedOut :: Maybe Bool
This is true if it was the end user who requested their phone number be removed.
optOutListArn :: Maybe Text
The OptOutListArn that the phone number was removed from.
optOutListName :: Maybe Text
The OptOutListName that the phone number was removed from.
optedOutNumber :: Maybe Text
The phone number that was removed from the OptOutList.
optedOutTimestamp :: Maybe POSIX
The time that the number was removed at, in UNIX epoch time format.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DeleteOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DeleteOptedOutNumber Associated Types type Rep DeleteOptedOutNumberResponse :: Type -> Type # Methods from :: DeleteOptedOutNumberResponse -> Rep DeleteOptedOutNumberResponse x # to :: Rep DeleteOptedOutNumberResponse x -> DeleteOptedOutNumberResponse #
Read DeleteOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DeleteOptedOutNumber Methods readsPrec :: Int -> ReadS DeleteOptedOutNumberResponse # readList :: ReadS [DeleteOptedOutNumberResponse] # readPrec :: ReadPrec DeleteOptedOutNumberResponse # readListPrec :: ReadPrec [DeleteOptedOutNumberResponse] #
Show DeleteOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DeleteOptedOutNumber Methods showsPrec :: Int -> DeleteOptedOutNumberResponse -> ShowS # show :: DeleteOptedOutNumberResponse -> String # showList :: [DeleteOptedOutNumberResponse] -> ShowS #
NFData DeleteOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DeleteOptedOutNumber Methods rnf :: DeleteOptedOutNumberResponse -> () #
Eq DeleteOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DeleteOptedOutNumber Methods (==) :: DeleteOptedOutNumberResponse -> DeleteOptedOutNumberResponse -> Bool # (/=) :: DeleteOptedOutNumberResponse -> DeleteOptedOutNumberResponse -> Bool #
type Rep DeleteOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DeleteOptedOutNumber type Rep DeleteOptedOutNumberResponse = D1 ('MetaData "DeleteOptedOutNumberResponse" "Amazonka.PinpointSmsVoiceV2.DeleteOptedOutNumber" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DeleteOptedOutNumberResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endUserOptedOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "optOutListArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "optOutListName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "optedOutNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "optedOutTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDeleteOptedOutNumberResponse Source #

Arguments

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

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

DeleteOptedOutNumberResponse, deleteOptedOutNumberResponse_endUserOptedOut - This is true if it was the end user who requested their phone number be removed.

DeleteOptedOutNumberResponse, deleteOptedOutNumberResponse_optOutListArn - The OptOutListArn that the phone number was removed from.

DeleteOptedOutNumber, deleteOptedOutNumberResponse_optOutListName - The OptOutListName that the phone number was removed from.

DeleteOptedOutNumber, deleteOptedOutNumberResponse_optedOutNumber - The phone number that was removed from the OptOutList.

DeleteOptedOutNumberResponse, deleteOptedOutNumberResponse_optedOutTimestamp - The time that the number was removed at, in UNIX epoch time format.

$sel:httpStatus:DeleteOptedOutNumberResponse', deleteOptedOutNumberResponse_httpStatus - The response's http status code.

Response Lenses

deleteOptedOutNumberResponse_endUserOptedOut :: Lens' DeleteOptedOutNumberResponse (Maybe Bool) Source #

This is true if it was the end user who requested their phone number be removed.

deleteOptedOutNumberResponse_optOutListArn :: Lens' DeleteOptedOutNumberResponse (Maybe Text) Source #

The OptOutListArn that the phone number was removed from.

deleteOptedOutNumberResponse_optOutListName :: Lens' DeleteOptedOutNumberResponse (Maybe Text) Source #

The OptOutListName that the phone number was removed from.

deleteOptedOutNumberResponse_optedOutNumber :: Lens' DeleteOptedOutNumberResponse (Maybe Text) Source #

The phone number that was removed from the OptOutList.

deleteOptedOutNumberResponse_optedOutTimestamp :: Lens' DeleteOptedOutNumberResponse (Maybe UTCTime) Source #

The time that the number was removed at, in UNIX epoch time format.

deleteOptedOutNumberResponse_httpStatus :: Lens' DeleteOptedOutNumberResponse Int Source #

The response's http status code.