redact_channel_message

ChimeSDKMessaging.Client.redact_channel_message(**kwargs)

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

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.redact_channel_message(
    ChannelArn='string',
    MessageId='string',
    ChimeBearer='string',
    SubChannelId='string'
)

Parameters

• ChannelArn (string) --

  [REQUIRED]

  The ARN of the channel containing the messages that you want to redact.

• MessageId (string) --

  [REQUIRED]

  The ID of the message being redacted.

• ChimeBearer (string) --

  [REQUIRED]

  The AppInstanceUserArn of the user that makes the API call.

• SubChannelId (string) -- The ID of the SubChannel in the request.

Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'MessageId': 'string',
    'SubChannelId': 'string'
}

Response Structure

• (dict) --

  • ChannelArn (string) --

    The ARN of the channel containing the messages that you want to redact.

  • MessageId (string) --

    The ID of the message being redacted.

  • SubChannelId (string) --

    The ID of the SubChannel in the response.

    Note

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

Exceptions

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