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 ]

send-channel-message

Description

Sends a message to a particular channel that the member is a part of.

Note

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Also, STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

CONTROL messages are limited to 30 bytes and do not contain metadata.

See also: AWS API Documentation

Synopsis

  send-channel-message
--channel-arn <value>
--content <value>
--type <value>
--persistence <value>
[--metadata <value>]
[--client-request-token <value>]
--chime-bearer <value>
[--push-notification <value>]
[--message-attributes <value>]
[--sub-channel-id <value>]
[--content-type <value>]
[--target <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--channel-arn (string)

The ARN of the channel.

--content (string)

The content of the channel message.

--type (string)

The type of message, STANDARD or CONTROL .

STANDARD messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.

CONTROL messages are limited to 30 bytes and do not contain metadata.

Possible values:

  • STANDARD
  • CONTROL

--persistence (string)

Boolean that controls whether the message is persisted on the back end. Required.

Possible values:

  • PERSISTENT
  • NON_PERSISTENT

--metadata (string)

The optional metadata for each message.

--client-request-token (string)

The Idempotency token for each client request.

--chime-bearer (string)

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

--push-notification (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.

Shorthand Syntax:

Title=string,Body=string,Type=string

JSON Syntax:

{
  "Title": "string",
  "Body": "string",
  "Type": "DEFAULT"|"VOIP"
}

--message-attributes (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:

KeyName1=StringValues=string,string,KeyName2=StringValues=string,string

JSON Syntax:

{"string": {
      "StringValues": ["string", ...]
    }
  ...}

--sub-channel-id (string)

The ID of the SubChannel in the request.

--content-type (string)

The content type of the channel message.

--target (list)

The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

(structure)

The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.

MemberArn -> (string)

The ARN of the target channel member.

Shorthand Syntax:

MemberArn=string ...

JSON Syntax:

[
  {
    "MemberArn": "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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ChannelArn -> (string)

The ARN of the channel.

MessageId -> (string)

The ID string assigned to each message.

Status -> (structure)

The status of the channel message.

Value -> (string)

The message status value.

Detail -> (string)

Contains more details about the message status.

SubChannelId -> (string)

The ID of the SubChannel in the response.