[ aws . pinpoint-sms-voice-v2 ]
put-keyword¶
Description¶
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, Amazon Pinpoint responds with a customizable message.
If you specify a keyword that isn’t valid, an Error is returned.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
put-keyword
--origination-identity <value>
--keyword <value>
--keyword-message <value>
[--keyword-action <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--origination-identity (string)
The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
--keyword (string)
The new keyword to add.
--keyword-message (string)
The message associated with the keyword.
AUTOMATIC_RESPONSE: A message is sent to the recipient.
OPT_OUT: Keeps the recipient from receiving future messages.
OPT_IN: The recipient wants to receive future messages.
--keyword-action (string)
The action to perform for the new keyword when it is received.
Possible values:
AUTOMATIC_RESPONSE
OPT_OUT
OPT_IN
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
OriginationIdentityArn -> (string)
The PhoneNumberArn or PoolArn that the keyword was associated with.
OriginationIdentity -> (string)
The PhoneNumberId or PoolId that the keyword was associated with.
Keyword -> (string)
The keyword that was added.
KeywordMessage -> (string)
The message associated with the keyword.
KeywordAction -> (string)
The action to perform when the keyword is used.