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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new opt-out list.

If the opt-out list name already exists, an Error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the Amazon Pinpoint User Guide.

Synopsis

data CreateOptOutList = CreateOptOutList' {
- clientToken :: Maybe Text
- tags :: Maybe [Tag]
- optOutListName :: Text
}
newCreateOptOutList :: Text -> CreateOptOutList
createOptOutList_clientToken :: Lens' CreateOptOutList (Maybe Text)
createOptOutList_tags :: Lens' CreateOptOutList (Maybe [Tag])
createOptOutList_optOutListName :: Lens' CreateOptOutList Text
data CreateOptOutListResponse = CreateOptOutListResponse' {
- createdTimestamp :: Maybe POSIX
- optOutListArn :: Maybe Text
- optOutListName :: Maybe Text
- tags :: Maybe [Tag]
- httpStatus :: Int
}
newCreateOptOutListResponse :: Int -> CreateOptOutListResponse
createOptOutListResponse_createdTimestamp :: Lens' CreateOptOutListResponse (Maybe UTCTime)
createOptOutListResponse_optOutListArn :: Lens' CreateOptOutListResponse (Maybe Text)
createOptOutListResponse_optOutListName :: Lens' CreateOptOutListResponse (Maybe Text)
createOptOutListResponse_tags :: Lens' CreateOptOutListResponse (Maybe [Tag])
createOptOutListResponse_httpStatus :: Lens' CreateOptOutListResponse Int

Creating a Request

data CreateOptOutList Source #

See: newCreateOptOutList smart constructor.

Constructors

CreateOptOutList'
Fields clientToken :: Maybe Text Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency. tags :: Maybe [Tag] An array of tags (key and value pairs) to associate with the new OptOutList. optOutListName :: Text The name of the new OptOutList.

Instances

Instances details

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

newCreateOptOutList Source #

Arguments

:: Text	`CreateOptOutList`
-> CreateOptOutList

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

$sel:clientToken:CreateOptOutList', createOptOutList_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

CreateOptOutList, createOptOutList_tags - An array of tags (key and value pairs) to associate with the new OptOutList.

CreateOptOutList, createOptOutList_optOutListName - The name of the new OptOutList.

Request Lenses

createOptOutList_clientToken :: Lens' CreateOptOutList (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

createOptOutList_tags :: Lens' CreateOptOutList (Maybe [Tag]) Source #

An array of tags (key and value pairs) to associate with the new OptOutList.

createOptOutList_optOutListName :: Lens' CreateOptOutList Text Source #

The name of the new OptOutList.

Destructuring the Response

data CreateOptOutListResponse Source #

See: newCreateOptOutListResponse smart constructor.

Constructors

CreateOptOutListResponse'
Fields createdTimestamp :: Maybe POSIX The time when the pool was created, in UNIX epoch time format. optOutListArn :: Maybe Text The Amazon Resource Name (ARN) for the OptOutList. optOutListName :: Maybe Text The name of the new OptOutList. tags :: Maybe [Tag] An array of tags (key and value pairs) associated with the new OptOutList. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateOptOutListResponse Source #

Arguments

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

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

CreateOptOutListResponse, createOptOutListResponse_createdTimestamp - The time when the pool was created, in UNIX epoch time format.

CreateOptOutListResponse, createOptOutListResponse_optOutListArn - The Amazon Resource Name (ARN) for the OptOutList.

CreateOptOutList, createOptOutListResponse_optOutListName - The name of the new OptOutList.

CreateOptOutList, createOptOutListResponse_tags - An array of tags (key and value pairs) associated with the new OptOutList.

$sel:httpStatus:CreateOptOutListResponse', createOptOutListResponse_httpStatus - The response's http status code.

Response Lenses

createOptOutListResponse_createdTimestamp :: Lens' CreateOptOutListResponse (Maybe UTCTime) Source #

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

createOptOutListResponse_optOutListArn :: Lens' CreateOptOutListResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the OptOutList.

createOptOutListResponse_optOutListName :: Lens' CreateOptOutListResponse (Maybe Text) Source #

The name of the new OptOutList.

createOptOutListResponse_tags :: Lens' CreateOptOutListResponse (Maybe [Tag]) Source #

An array of tags (key and value pairs) associated with the new OptOutList.

createOptOutListResponse_httpStatus :: Lens' CreateOptOutListResponse Int Source #

The response's http status code.