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 ]

list-channel-messages

Description

List all the messages in a channel. Returns a paginated list of ChannelMessages . By default, sorted by creation timestamp in descending order.

Note

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

See also: AWS API Documentation

Synopsis

  list-channel-messages
--channel-arn <value>
[--sort-order <value>]
[--not-before <value>]
[--not-after <value>]
[--max-results <value>]
[--next-token <value>]
[--chime-bearer <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.

--sort-order (string)

The order in which you want messages sorted. Default is Descending, based on time created.

Possible values:

  • ASCENDING
  • DESCENDING

--not-before (timestamp)

The initial or starting time stamp for your requested messages.

--not-after (timestamp)

The final or ending time stamp for your requested messages.

--max-results (integer)

The maximum number of messages that you want returned.

--next-token (string)

The token passed by previous API calls until all requested messages are returned.

--chime-bearer (string)

The AppInstanceUserArn of the user that makes the API call.

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

Output

ChannelArn -> (string)

The ARN of the channel containing the requested messages.

NextToken -> (string)

The token passed by previous API calls until all requested messages are returned.

ChannelMessages -> (list)

The information about, and content of, each requested message.

(structure)

Summary of the messages in a Channel .

MessageId -> (string)

The ID of the message.

Content -> (string)

The content of the message.

Metadata -> (string)

The metadata of the message.

Type -> (string)

The type of message.

CreatedTimestamp -> (timestamp)

The time at which the message summary was created.

LastUpdatedTimestamp -> (timestamp)

The time at which a message was last updated.

LastEditedTimestamp -> (timestamp)

The time at which a message was last edited.

Sender -> (structure)

The message sender.

Arn -> (string)

The ARN in an Identity.

Name -> (string)

The name in an Identity.

Redacted -> (boolean)

Indicates whether a message was redacted.