[ aws . chime-sdk-messaging ]

update-channel-message

Description

Updates the content of a 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

  update-channel-message
--channel-arn <value>
--message-id <value>
[--content <value>]
[--metadata <value>]
--chime-bearer <value>
[--sub-channel-id <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 string of the message being updated.

--content (string)

The content of the message being updated.

--metadata (string)

The metadata of the message being updated.

--chime-bearer (string)

The AppInstanceUserArn of the user that makes the API call.

--sub-channel-id (string)

The ID of the SubChannel in the request.

Note

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

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

ChannelArn -> (string)

The ARN of the channel.

MessageId -> (string)

The ID string of the message being updated.

Status -> (structure)

The status of the message update.

Value -> (string)

The message status value.

Detail -> (string)

Contains more details about the messasge status.

SubChannelId -> (string)

The ID of the SubChannel in the response.