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 AppInstanceUserArn of the user 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'
)

Parameters

• ChannelArn (string) --

  [REQUIRED]

  The ARN of the channel.

• MessageId (string) --

  [REQUIRED]

  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.
• ChimeBearer (string) --

  [REQUIRED]

  The AppInstanceUserArn of the user 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.

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

  • SubChannelId (string) --

    The ID of the SubChannel in the response.

Exceptions

• ChimeSDKMessaging.Client.exceptions.BadRequestException
• ChimeSDKMessaging.Client.exceptions.ConflictException
• ChimeSDKMessaging.Client.exceptions.ForbiddenException
• ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException
• ChimeSDKMessaging.Client.exceptions.ThrottledClientException
• ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException
• ChimeSDKMessaging.Client.exceptions.ServiceFailureException