AWS CLI Command Reference

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime-sdk-messaging ]

channel-flow-callback

Description

Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.

You can return one of the following processing responses:

  • Update message content or metadata
  • Deny a message
  • Make no changes to the message

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  channel-flow-callback
[--callback-id <value>]
--channel-arn <value>
[--delete-resource | --no-delete-resource]
--channel-message <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--callback-id (string)

The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.

--channel-arn (string)

The ARN of the channel.

--delete-resource | --no-delete-resource (boolean)

When a processor determines that a message needs to be DENIED , pass this parameter with a value of true.

--channel-message (structure)

Stores information about the processed message.

MessageId -> (string)

The message ID.

Content -> (string)

The message content.

Metadata -> (string)

The message metadata.

PushNotification -> (structure)

The push notification configuration of the message.

Title -> (string)

The title of the push notification.

Body -> (string)

The body of the push notification.

Type -> (string)

Enum value that indicates the type of the push notification for a message. DEFAULT : Normal mobile push notification. VOIP : VOIP mobile push notification.

MessageAttributes -> (map)

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences .

key -> (string)

value -> (structure)

A list of message attribute values.

StringValues -> (list)

The strings in a message attribute value.

(string)

Shorthand Syntax:

MessageId=string,Content=string,Metadata=string,PushNotification={Title=string,Body=string,Type=string},MessageAttributes={KeyName1={StringValues=[string,string]},KeyName2={StringValues=[string,string]}}

JSON Syntax:

{
  "MessageId": "string",
  "Content": "string",
  "Metadata": "string",
  "PushNotification": {
    "Title": "string",
    "Body": "string",
    "Type": "DEFAULT"|"VOIP"
  },
  "MessageAttributes": {"string": {
        "StringValues": ["string", ...]
      }
    ...}
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ChannelArn -> (string)

The ARN of the channel.

CallbackId -> (string)

The call back ID passed in the request.