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 ]



Gets the full details of a channel message.


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.

See also: AWS API Documentation


--channel-arn <value>
--message-id <value>
--chime-bearer <value>
[--sub-channel-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--endpoint-url <value>]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]


--channel-arn (string)

The ARN of the channel.

--message-id (string)

The ID of the message.

--chime-bearer (string)

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

--sub-channel-id (string)

The ID of the SubChannel in the request.


Only required when getting messages in a SubChannel that the user belongs to.

--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.

--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.


ChannelMessage -> (structure)

The details of and content in the message.

ChannelArn -> (string)

The ARN of the channel.

MessageId -> (string)

The ID of a message.

Content -> (string)

The message content.

Metadata -> (string)

The message metadata.

Type -> (string)

The message type.

CreatedTimestamp -> (timestamp)

The time at which the message was created.

LastEditedTimestamp -> (timestamp)

The time at which a message was edited.

LastUpdatedTimestamp -> (timestamp)

The time at which a message was updated.

Sender -> (structure)

The message sender.

Arn -> (string)

The ARN in an Identity.

Name -> (string)

The name in an Identity.

Redacted -> (boolean)

Hides the content of a message.

Persistence -> (string)

The persistence setting for a channel message.

Status -> (structure)

The status of the channel message.

Value -> (string)

The message status value.

Detail -> (string)

Contains more details about the messasge status.

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.


SubChannelId -> (string)

The ID of the SubChannel.

ContentType -> (string)

The content type of the channel message.