Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Deletes an existing keyword from 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.

Keywords "HELP" and "STOP" can't be deleted or modified.

Creating a Request

data DeleteKeyword

See: newDeleteKeyword smart constructor.

Constructors

DeleteKeyword'

Fields

• originationIdentity :: Text

  The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.

• keyword :: Text

  The keyword to delete.

Instances

ToJSON DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

toJSON :: DeleteKeyword -> Value

toEncoding :: DeleteKeyword -> Encoding

toJSONList :: [DeleteKeyword] -> Value

toEncodingList :: [DeleteKeyword] -> Encoding

ToHeaders DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

toHeaders :: DeleteKeyword -> [Header]

ToPath DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

toPath :: DeleteKeyword -> ByteString

ToQuery DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

toQuery :: DeleteKeyword -> QueryString

AWSRequest DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Associated Types

type AWSResponse DeleteKeyword

Methods

request :: (Service -> Service) -> DeleteKeyword -> Request DeleteKeyword

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteKeyword -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteKeyword)))

Generic DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Associated Types

type Rep DeleteKeyword :: Type -> Type

Methods

from :: DeleteKeyword -> Rep DeleteKeyword x

to :: Rep DeleteKeyword x -> DeleteKeyword

Read DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

readsPrec :: Int -> ReadS DeleteKeyword

readList :: ReadS [DeleteKeyword]

readPrec :: ReadPrec DeleteKeyword

readListPrec :: ReadPrec [DeleteKeyword]

Show DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

showsPrec :: Int -> DeleteKeyword -> ShowS

show :: DeleteKeyword -> String

showList :: [DeleteKeyword] -> ShowS

NFData DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

rnf :: DeleteKeyword -> ()

Eq DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

(==) :: DeleteKeyword -> DeleteKeyword -> Bool

(/=) :: DeleteKeyword -> DeleteKeyword -> Bool

Hashable DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

hashWithSalt :: Int -> DeleteKeyword -> Int

hash :: DeleteKeyword -> Int

type AWSResponse DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

type AWSResponse DeleteKeyword = DeleteKeywordResponse

type Rep DeleteKeyword

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

type Rep DeleteKeyword = D1 ('MetaData "DeleteKeyword" "Amazonka.PinpointSmsVoiceV2.DeleteKeyword" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DeleteKeyword'" 'PrefixI 'True) (S1 ('MetaSel ('Just "originationIdentity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteKeyword

Arguments

:: Text

DeleteKeyword

-> Text

DeleteKeyword

-> DeleteKeyword

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

DeleteKeyword, deleteKeyword_originationIdentity - The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.

DeleteKeyword, deleteKeyword_keyword - The keyword to delete.

Request Lenses

deleteKeyword_originationIdentity :: Lens' DeleteKeyword Text

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.

deleteKeyword_keyword :: Lens' DeleteKeyword Text

The keyword to delete.

Destructuring the Response

data DeleteKeywordResponse

See: newDeleteKeywordResponse smart constructor.

Constructors

DeleteKeywordResponse'

Fields

• keyword :: Maybe Text

  The keyword that was deleted.

• keywordAction :: Maybe KeywordAction

  The action that was associated with the deleted keyword.

• keywordMessage :: Maybe Text

  The message that was associated with the deleted 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

Generic DeleteKeywordResponse

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Associated Types

type Rep DeleteKeywordResponse :: Type -> Type

Methods

from :: DeleteKeywordResponse -> Rep DeleteKeywordResponse x

to :: Rep DeleteKeywordResponse x -> DeleteKeywordResponse

Read DeleteKeywordResponse

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

readsPrec :: Int -> ReadS DeleteKeywordResponse

readList :: ReadS [DeleteKeywordResponse]

readPrec :: ReadPrec DeleteKeywordResponse

readListPrec :: ReadPrec [DeleteKeywordResponse]

Show DeleteKeywordResponse

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

showsPrec :: Int -> DeleteKeywordResponse -> ShowS

show :: DeleteKeywordResponse -> String

showList :: [DeleteKeywordResponse] -> ShowS

NFData DeleteKeywordResponse

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

rnf :: DeleteKeywordResponse -> ()

Eq DeleteKeywordResponse

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

Methods

(==) :: DeleteKeywordResponse -> DeleteKeywordResponse -> Bool

(/=) :: DeleteKeywordResponse -> DeleteKeywordResponse -> Bool

type Rep DeleteKeywordResponse

Defined in Amazonka.PinpointSmsVoiceV2.DeleteKeyword

type Rep DeleteKeywordResponse = D1 ('MetaData "DeleteKeywordResponse" "Amazonka.PinpointSmsVoiceV2.DeleteKeyword" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DeleteKeywordResponse'" '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)))))

newDeleteKeywordResponse

Arguments

:: Int

$sel:httpStatus:DeleteKeywordResponse'

-> DeleteKeywordResponse

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

DeleteKeyword, deleteKeywordResponse_keyword - The keyword that was deleted.

DeleteKeywordResponse, deleteKeywordResponse_keywordAction - The action that was associated with the deleted keyword.

DeleteKeywordResponse, deleteKeywordResponse_keywordMessage - The message that was associated with the deleted keyword.

DeleteKeyword, deleteKeywordResponse_originationIdentity - The PhoneNumberId or PoolId that the keyword was associated with.

DeleteKeywordResponse, deleteKeywordResponse_originationIdentityArn - The PhoneNumberArn or PoolArn that the keyword was associated with.

$sel:httpStatus:DeleteKeywordResponse', deleteKeywordResponse_httpStatus - The response's http status code.

Response Lenses

deleteKeywordResponse_keyword :: Lens' DeleteKeywordResponse (Maybe Text)

The keyword that was deleted.

deleteKeywordResponse_keywordAction :: Lens' DeleteKeywordResponse (Maybe KeywordAction)

The action that was associated with the deleted keyword.

deleteKeywordResponse_keywordMessage :: Lens' DeleteKeywordResponse (Maybe Text)

The message that was associated with the deleted keyword.

deleteKeywordResponse_originationIdentity :: Lens' DeleteKeywordResponse (Maybe Text)

The PhoneNumberId or PoolId that the keyword was associated with.

deleteKeywordResponse_originationIdentityArn :: Lens' DeleteKeywordResponse (Maybe Text)

The PhoneNumberArn or PoolArn that the keyword was associated with.

deleteKeywordResponse_httpStatus :: Lens' DeleteKeywordResponse Int

The response's http status code.