ChimeSDKMessaging / Client / update_channel_message
update_channel_message#
- ChimeSDKMessaging.Client.update_channel_message(**kwargs)#
Updates the content of a message.
Note
The
x-amz-chime-bearer
request header is mandatory. Use the ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call as the value in the header.See also: AWS API Documentation
Request Syntax
response = client.update_channel_message( ChannelArn='string', MessageId='string', Content='string', Metadata='string', ChimeBearer='string', SubChannelId='string', ContentType='string' )
- Parameters:
ChannelArn (string) –
[REQUIRED]
The ARN of the channel.
MessageId (string) –
[REQUIRED]
The ID string of the message being updated.
Content (string) –
[REQUIRED]
The content of the channel message.
Metadata (string) – The metadata of the message being updated.
ChimeBearer (string) –
[REQUIRED]
The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.SubChannelId (string) –
The ID of the SubChannel in the request.
Note
Only required when updating messages in a SubChannel that the user belongs to.
ContentType (string) – The content type of the channel message.
- Return type:
dict
- Returns:
Response Syntax
{ 'ChannelArn': 'string', 'MessageId': 'string', 'Status': { 'Value': 'SENT'|'PENDING'|'FAILED'|'DENIED', 'Detail': 'string' }, 'SubChannelId': 'string' }
Response Structure
(dict) –
ChannelArn (string) –
The ARN of the channel.
MessageId (string) –
The ID string of the message being updated.
Status (dict) –
The status of the message update.
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.
Exceptions