Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeKeywords

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.

Request Syntax


{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Keywords": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "OriginationIdentity": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

An array of keyword filters to filter the results.

Type: Array of KeywordFilter objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

Keywords

An array of keywords to search for.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 30.

Pattern: [ \S]+

Required: No

MaxResults

The maximum number of results to return per each request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

Response Syntax


{
   "Keywords": [ 
      { 
         "Keyword": "string",
         "KeywordAction": "string",
         "KeywordMessage": "string"
      }
   ],
   "NextToken": "string",
   "OriginationIdentity": "string",
   "OriginationIdentityArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Keywords

An array of KeywordInformation objects that contain the results.

Type: Array of KeywordInformation objects

NextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

OriginationIdentity

The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

Type: String

OriginationIdentityArn

The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400