Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

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, End User Messaging SMS responds with a customizable message.

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

post/#X-Amz-Target=PinpointSMSVoiceV2.DescribeKeywords

Headers

X-Amz-Target'PinpointSMSVoiceV2.DescribeKeywords' required

Request body

OriginationIdentitystring required
<p>The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use <a>DescribePhoneNumbers</a> to find the values for PhoneNumberId and PhoneNumberArn while <a>DescribeSenderIds</a> can be used to get the values for SenderId and SenderIdArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
KeywordsKeyword[]

An array of keywords to search for.

NextTokenstring

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.

MaxResultsinteger

The maximum number of results to return per each request.

Response

Success

OriginationIdentityArnstring

The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

OriginationIdentitystring

The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

NextTokenstring

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