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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an opted out destination phone number in the opt-out list.

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

Synopsis

data PutOptedOutNumber = PutOptedOutNumber' {
- optOutListName :: Text
- optedOutNumber :: Text
}
newPutOptedOutNumber :: Text -> Text -> PutOptedOutNumber
putOptedOutNumber_optOutListName :: Lens' PutOptedOutNumber Text
putOptedOutNumber_optedOutNumber :: Lens' PutOptedOutNumber Text
data PutOptedOutNumberResponse = PutOptedOutNumberResponse' {
- endUserOptedOut :: Maybe Bool
- optOutListArn :: Maybe Text
- optOutListName :: Maybe Text
- optedOutNumber :: Maybe Text
- optedOutTimestamp :: Maybe POSIX
- httpStatus :: Int
}
newPutOptedOutNumberResponse :: Int -> PutOptedOutNumberResponse
putOptedOutNumberResponse_endUserOptedOut :: Lens' PutOptedOutNumberResponse (Maybe Bool)
putOptedOutNumberResponse_optOutListArn :: Lens' PutOptedOutNumberResponse (Maybe Text)
putOptedOutNumberResponse_optOutListName :: Lens' PutOptedOutNumberResponse (Maybe Text)
putOptedOutNumberResponse_optedOutNumber :: Lens' PutOptedOutNumberResponse (Maybe Text)
putOptedOutNumberResponse_optedOutTimestamp :: Lens' PutOptedOutNumberResponse (Maybe UTCTime)
putOptedOutNumberResponse_httpStatus :: Lens' PutOptedOutNumberResponse Int

Creating a Request

data PutOptedOutNumber Source #

See: newPutOptedOutNumber smart constructor.

Constructors

PutOptedOutNumber'
Fields optOutListName :: Text The OptOutListName or OptOutListArn to add the phone number to. optedOutNumber :: Text The phone number to add to the OptOutList in E.164 format.

Instances

Instances details

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

newPutOptedOutNumber Source #

Arguments

:: Text	`PutOptedOutNumber`
-> Text	`PutOptedOutNumber`
-> PutOptedOutNumber

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

PutOptedOutNumber, putOptedOutNumber_optOutListName - The OptOutListName or OptOutListArn to add the phone number to.

PutOptedOutNumber, putOptedOutNumber_optedOutNumber - The phone number to add to the OptOutList in E.164 format.

Request Lenses

putOptedOutNumber_optOutListName :: Lens' PutOptedOutNumber Text Source #

The OptOutListName or OptOutListArn to add the phone number to.

putOptedOutNumber_optedOutNumber :: Lens' PutOptedOutNumber Text Source #

The phone number to add to the OptOutList in E.164 format.

Destructuring the Response

data PutOptedOutNumberResponse Source #

See: newPutOptedOutNumberResponse smart constructor.

Constructors

PutOptedOutNumberResponse'

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 added to the OptOutList.
optedOutTimestamp :: Maybe POSIX
The time that the phone number was added to the OptOutList, in UNIX epoch time format.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic PutOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.PutOptedOutNumber Associated Types type Rep PutOptedOutNumberResponse :: Type -> Type # Methods from :: PutOptedOutNumberResponse -> Rep PutOptedOutNumberResponse x # to :: Rep PutOptedOutNumberResponse x -> PutOptedOutNumberResponse #
Read PutOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.PutOptedOutNumber Methods readsPrec :: Int -> ReadS PutOptedOutNumberResponse # readList :: ReadS [PutOptedOutNumberResponse] # readPrec :: ReadPrec PutOptedOutNumberResponse # readListPrec :: ReadPrec [PutOptedOutNumberResponse] #
Show PutOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.PutOptedOutNumber Methods showsPrec :: Int -> PutOptedOutNumberResponse -> ShowS # show :: PutOptedOutNumberResponse -> String # showList :: [PutOptedOutNumberResponse] -> ShowS #
NFData PutOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.PutOptedOutNumber Methods rnf :: PutOptedOutNumberResponse -> () #
Eq PutOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.PutOptedOutNumber Methods (==) :: PutOptedOutNumberResponse -> PutOptedOutNumberResponse -> Bool # (/=) :: PutOptedOutNumberResponse -> PutOptedOutNumberResponse -> Bool #
type Rep PutOptedOutNumberResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.PutOptedOutNumber type Rep PutOptedOutNumberResponse = D1 ('MetaData "PutOptedOutNumberResponse" "Amazonka.PinpointSmsVoiceV2.PutOptedOutNumber" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "PutOptedOutNumberResponse'" '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)))))

newPutOptedOutNumberResponse Source #

Arguments

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

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

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

PutOptedOutNumberResponse, putOptedOutNumberResponse_optOutListArn - The OptOutListArn that the phone number was removed from.

PutOptedOutNumber, putOptedOutNumberResponse_optOutListName - The OptOutListName that the phone number was removed from.

PutOptedOutNumber, putOptedOutNumberResponse_optedOutNumber - The phone number that was added to the OptOutList.

PutOptedOutNumberResponse, putOptedOutNumberResponse_optedOutTimestamp - The time that the phone number was added to the OptOutList, in UNIX epoch time format.

$sel:httpStatus:PutOptedOutNumberResponse', putOptedOutNumberResponse_httpStatus - The response's http status code.

Response Lenses

putOptedOutNumberResponse_endUserOptedOut :: Lens' PutOptedOutNumberResponse (Maybe Bool) Source #

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

putOptedOutNumberResponse_optOutListArn :: Lens' PutOptedOutNumberResponse (Maybe Text) Source #

The OptOutListArn that the phone number was removed from.

putOptedOutNumberResponse_optOutListName :: Lens' PutOptedOutNumberResponse (Maybe Text) Source #

The OptOutListName that the phone number was removed from.

putOptedOutNumberResponse_optedOutNumber :: Lens' PutOptedOutNumberResponse (Maybe Text) Source #

The phone number that was added to the OptOutList.

putOptedOutNumberResponse_optedOutTimestamp :: Lens' PutOptedOutNumberResponse (Maybe UTCTime) Source #

The time that the phone number was added to the OptOutList, in UNIX epoch time format.

putOptedOutNumberResponse_httpStatus :: Lens' PutOptedOutNumberResponse Int Source #

The response's http status code.