put-events-configuration¶
Description¶
Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
put-events-configuration
--account-id <value>
--bot-id <value>
[--outbound-events-https-endpoint <value>]
[--lambda-function-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--account-id (string)
The Amazon Chime account ID.
--bot-id (string)
The bot ID.
--outbound-events-https-endpoint (string)
HTTPS endpoint that allows the bot to receive outgoing events.
--lambda-function-arn (string)
Lambda function ARN that allows the bot to receive outgoing events.
--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.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Output¶
EventsConfiguration -> (structure)
The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
BotId -> (string)
The bot ID.
OutboundEventsHTTPSEndpoint -> (string)
HTTPS endpoint that allows a bot to receive outgoing events.
LambdaFunctionArn -> (string)
Lambda function ARN that allows a bot to receive outgoing events.