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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates or updates a keyword configuration on an origination phone number or pool.

A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, Amazon Pinpoint responds with a customizable message.

If you specify a keyword that isn't valid, an Error is returned.

Synopsis

data PutKeyword = PutKeyword' {
- keywordAction :: Maybe KeywordAction
- originationIdentity :: Text
- keyword :: Text
- keywordMessage :: Text
}
newPutKeyword :: Text -> Text -> Text -> PutKeyword
putKeyword_keywordAction :: Lens' PutKeyword (Maybe KeywordAction)
putKeyword_originationIdentity :: Lens' PutKeyword Text
putKeyword_keyword :: Lens' PutKeyword Text
putKeyword_keywordMessage :: Lens' PutKeyword Text
data PutKeywordResponse = PutKeywordResponse' {
- keyword :: Maybe Text
- keywordAction :: Maybe KeywordAction
- keywordMessage :: Maybe Text
- originationIdentity :: Maybe Text
- originationIdentityArn :: Maybe Text
- httpStatus :: Int
}
newPutKeywordResponse :: Int -> PutKeywordResponse
putKeywordResponse_keyword :: Lens' PutKeywordResponse (Maybe Text)
putKeywordResponse_keywordAction :: Lens' PutKeywordResponse (Maybe KeywordAction)
putKeywordResponse_keywordMessage :: Lens' PutKeywordResponse (Maybe Text)
putKeywordResponse_originationIdentity :: Lens' PutKeywordResponse (Maybe Text)
putKeywordResponse_originationIdentityArn :: Lens' PutKeywordResponse (Maybe Text)
putKeywordResponse_httpStatus :: Lens' PutKeywordResponse Int

Creating a Request

data PutKeyword Source #

See: newPutKeyword smart constructor.

Constructors

PutKeyword'

Fields

keywordAction :: Maybe KeywordAction
The action to perform for the new keyword when it is received.
originationIdentity :: Text
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
keyword :: Text
The new keyword to add.
keywordMessage :: Text
The message associated with the keyword.
- AUTOMATIC_RESPONSE: A message is sent to the recipient.
- OPT_OUT: Keeps the recipient from receiving future messages.
- OPT_IN: The recipient wants to receive future messages.

Instances

Instances details

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

newPutKeyword Source #

Arguments

:: Text	`PutKeyword`
-> Text	`PutKeyword`
-> Text	`PutKeyword`
-> PutKeyword

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

PutKeyword, putKeyword_keywordAction - The action to perform for the new keyword when it is received.

PutKeyword, putKeyword_originationIdentity - The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

PutKeyword, putKeyword_keyword - The new keyword to add.

PutKeyword, putKeyword_keywordMessage - The message associated with the keyword.

AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.

Request Lenses

putKeyword_keywordAction :: Lens' PutKeyword (Maybe KeywordAction) Source #

The action to perform for the new keyword when it is received.

putKeyword_originationIdentity :: Lens' PutKeyword Text Source #

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

putKeyword_keyword :: Lens' PutKeyword Text Source #

The new keyword to add.

putKeyword_keywordMessage :: Lens' PutKeyword Text Source #

The message associated with the keyword.

AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.

Destructuring the Response

data PutKeywordResponse Source #

See: newPutKeywordResponse smart constructor.

Constructors

PutKeywordResponse'

Fields

keyword :: Maybe Text
The keyword that was added.
keywordAction :: Maybe KeywordAction
The action to perform when the keyword is used.
keywordMessage :: Maybe Text
The message associated with the keyword.
originationIdentity :: Maybe Text
The PhoneNumberId or PoolId that the keyword was associated with.
originationIdentityArn :: Maybe Text
The PhoneNumberArn or PoolArn that the keyword was associated with.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newPutKeywordResponse Source #

Arguments

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

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

PutKeyword, putKeywordResponse_keyword - The keyword that was added.

PutKeyword, putKeywordResponse_keywordAction - The action to perform when the keyword is used.

PutKeyword, putKeywordResponse_keywordMessage - The message associated with the keyword.

PutKeyword, putKeywordResponse_originationIdentity - The PhoneNumberId or PoolId that the keyword was associated with.

PutKeywordResponse, putKeywordResponse_originationIdentityArn - The PhoneNumberArn or PoolArn that the keyword was associated with.

$sel:httpStatus:PutKeywordResponse', putKeywordResponse_httpStatus - The response's http status code.

Response Lenses

putKeywordResponse_keyword :: Lens' PutKeywordResponse (Maybe Text) Source #

The keyword that was added.

putKeywordResponse_keywordAction :: Lens' PutKeywordResponse (Maybe KeywordAction) Source #

The action to perform when the keyword is used.

putKeywordResponse_keywordMessage :: Lens' PutKeywordResponse (Maybe Text) Source #

The message associated with the keyword.

putKeywordResponse_originationIdentity :: Lens' PutKeywordResponse (Maybe Text) Source #

The PhoneNumberId or PoolId that the keyword was associated with.

putKeywordResponse_originationIdentityArn :: Lens' PutKeywordResponse (Maybe Text) Source #

The PhoneNumberArn or PoolArn that the keyword was associated with.

putKeywordResponse_httpStatus :: Lens' PutKeywordResponse Int Source #

The response's http status code.