keywords

Creates, updates, deletes, gets or lists a keywords resource.

Overview

Name	keywords
Type	Resource
Id	aws.pinpoint_sms_voice_v2.keywords

Fields

The following fields are returned by SELECT queries:

describe_keywords

Name	Datatype	Description
keyword	string	The keyword as a string. (pattern: <code>[ \S]+</code>)
keyword_action	string	The action to perform for the keyword. (AUTOMATIC_RESPONSE, OPT_OUT, OPT_IN)
keyword_message	string	A custom message that can be used with the keyword. (pattern: <code>(?!\s*$)[\s\S]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_keywords	select	region		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.
put_keyword	replace	region, OriginationIdentity, KeywordMessage		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, End User Messaging SMS responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.
delete_keyword	delete	region		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, End User Messaging SMS responds with a customizable message. Keywords "HELP" and "STOP" can't be deleted or modified.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_keywords

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.

SELECT
keyword,
keyword_action,
keyword_message
FROM aws.pinpoint_sms_voice_v2.keywords
WHERE region = '{{ region }}' -- required
;

REPLACE examples

put_keyword

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, End User Messaging SMS responds with a customizable message. If you specify a keyword that isn't valid, an error is returned.

REPLACE aws.pinpoint_sms_voice_v2.keywords
SET 
OriginationIdentity = '{{ OriginationIdentity }}',
Keyword = '{{ Keyword }}',
KeywordMessage = '{{ KeywordMessage }}',
KeywordAction = '{{ KeywordAction }}'
WHERE 
region = '{{ region }}' --required
AND OriginationIdentity = '{{ OriginationIdentity }}' --required
AND KeywordMessage = '{{ KeywordMessage }}' --required
RETURNING
keyword,
keyword_action,
keyword_message,
origination_identity,
origination_identity_arn;

DELETE examples

delete_keyword

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, End User Messaging SMS responds with a customizable message. Keywords "HELP" and "STOP" can't be deleted or modified.

DELETE FROM aws.pinpoint_sms_voice_v2.keywords
WHERE region = '{{ region }}' --required
;