[ aws . chime-sdk-messaging ]

get-channel-message

Description

Gets the full details of a channel message.

Note

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-channel-message
--channel-arn <value>
--message-id <value>
--chime-bearer <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--channel-arn (string)

The ARN of the channel.

--message-id (string)

The ID of the message.

--chime-bearer (string)

The AppInstanceUserArn of the user that makes the API call.

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

See ‘aws help’ for descriptions of global parameters.

Output

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.

(string)