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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified keywords or all keywords on your 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.

This operation returns paginated results.

Synopsis

data DescribeKeywords = DescribeKeywords' {
- filters :: Maybe [KeywordFilter]
- keywords :: Maybe [Text]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- originationIdentity :: Text
}
newDescribeKeywords :: Text -> DescribeKeywords
describeKeywords_filters :: Lens' DescribeKeywords (Maybe [KeywordFilter])
describeKeywords_keywords :: Lens' DescribeKeywords (Maybe [Text])
describeKeywords_maxResults :: Lens' DescribeKeywords (Maybe Natural)
describeKeywords_nextToken :: Lens' DescribeKeywords (Maybe Text)
describeKeywords_originationIdentity :: Lens' DescribeKeywords Text
data DescribeKeywordsResponse = DescribeKeywordsResponse' {
- keywords :: Maybe [KeywordInformation]
- nextToken :: Maybe Text
- originationIdentity :: Maybe Text
- originationIdentityArn :: Maybe Text
- httpStatus :: Int
}
newDescribeKeywordsResponse :: Int -> DescribeKeywordsResponse
describeKeywordsResponse_keywords :: Lens' DescribeKeywordsResponse (Maybe [KeywordInformation])
describeKeywordsResponse_nextToken :: Lens' DescribeKeywordsResponse (Maybe Text)
describeKeywordsResponse_originationIdentity :: Lens' DescribeKeywordsResponse (Maybe Text)
describeKeywordsResponse_originationIdentityArn :: Lens' DescribeKeywordsResponse (Maybe Text)
describeKeywordsResponse_httpStatus :: Lens' DescribeKeywordsResponse Int

Creating a Request

data DescribeKeywords Source #

See: newDescribeKeywords smart constructor.

Constructors

DescribeKeywords'

Fields

filters :: Maybe [KeywordFilter]
An array of keyword filters to filter the results.
keywords :: Maybe [Text]
An array of keywords to search for.
maxResults :: Maybe Natural
The maximum number of results to return per each request.
nextToken :: Maybe Text
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
originationIdentity :: Text
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

Instances

Instances details

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

newDescribeKeywords Source #

Arguments

:: Text	`DescribeKeywords`
-> DescribeKeywords

Create a value of DescribeKeywords 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:filters:DescribeKeywords', describeKeywords_filters - An array of keyword filters to filter the results.

DescribeKeywords, describeKeywords_keywords - An array of keywords to search for.

$sel:maxResults:DescribeKeywords', describeKeywords_maxResults - The maximum number of results to return per each request.

DescribeKeywords, describeKeywords_nextToken - The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

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

Request Lenses

describeKeywords_filters :: Lens' DescribeKeywords (Maybe [KeywordFilter]) Source #

An array of keyword filters to filter the results.

describeKeywords_keywords :: Lens' DescribeKeywords (Maybe [Text]) Source #

An array of keywords to search for.

describeKeywords_maxResults :: Lens' DescribeKeywords (Maybe Natural) Source #

The maximum number of results to return per each request.

describeKeywords_nextToken :: Lens' DescribeKeywords (Maybe Text) Source #

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

describeKeywords_originationIdentity :: Lens' DescribeKeywords Text Source #

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

Destructuring the Response

data DescribeKeywordsResponse Source #

See: newDescribeKeywordsResponse smart constructor.

Constructors

DescribeKeywordsResponse'

Fields

keywords :: Maybe [KeywordInformation]
An array of KeywordInformation objects that contain the results.
nextToken :: Maybe Text
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
originationIdentity :: Maybe Text
The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
originationIdentityArn :: Maybe Text
The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeKeywordsResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeKeywords Associated Types type Rep DescribeKeywordsResponse :: Type -> Type # Methods from :: DescribeKeywordsResponse -> Rep DescribeKeywordsResponse x # to :: Rep DescribeKeywordsResponse x -> DescribeKeywordsResponse #
Read DescribeKeywordsResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeKeywords Methods readsPrec :: Int -> ReadS DescribeKeywordsResponse # readList :: ReadS [DescribeKeywordsResponse] # readPrec :: ReadPrec DescribeKeywordsResponse # readListPrec :: ReadPrec [DescribeKeywordsResponse] #
Show DescribeKeywordsResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeKeywords Methods showsPrec :: Int -> DescribeKeywordsResponse -> ShowS # show :: DescribeKeywordsResponse -> String # showList :: [DescribeKeywordsResponse] -> ShowS #
NFData DescribeKeywordsResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeKeywords Methods rnf :: DescribeKeywordsResponse -> () #
Eq DescribeKeywordsResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeKeywords Methods (==) :: DescribeKeywordsResponse -> DescribeKeywordsResponse -> Bool # (/=) :: DescribeKeywordsResponse -> DescribeKeywordsResponse -> Bool #
type Rep DescribeKeywordsResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeKeywords type Rep DescribeKeywordsResponse = D1 ('MetaData "DescribeKeywordsResponse" "Amazonka.PinpointSmsVoiceV2.DescribeKeywords" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DescribeKeywordsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keywords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeywordInformation])) :: S1 ('MetaSel ('Just "nextToken") '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)))))

newDescribeKeywordsResponse Source #

Arguments

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

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

DescribeKeywords, describeKeywordsResponse_keywords - An array of KeywordInformation objects that contain the results.

DescribeKeywords, describeKeywordsResponse_nextToken - The token to be used for the next set of paginated results. If this field is empty then there are no more results.

DescribeKeywords, describeKeywordsResponse_originationIdentity - The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

DescribeKeywordsResponse, describeKeywordsResponse_originationIdentityArn - The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

$sel:httpStatus:DescribeKeywordsResponse', describeKeywordsResponse_httpStatus - The response's http status code.

Response Lenses

describeKeywordsResponse_keywords :: Lens' DescribeKeywordsResponse (Maybe [KeywordInformation]) Source #

An array of KeywordInformation objects that contain the results.

describeKeywordsResponse_nextToken :: Lens' DescribeKeywordsResponse (Maybe Text) Source #

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

describeKeywordsResponse_originationIdentity :: Lens' DescribeKeywordsResponse (Maybe Text) Source #

The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

describeKeywordsResponse_originationIdentityArn :: Lens' DescribeKeywordsResponse (Maybe Text) Source #

The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

describeKeywordsResponse_httpStatus :: Lens' DescribeKeywordsResponse Int Source #

The response's http status code.