Chime / Client / redact_channel_message
redact_channel_message#
- Chime.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 theAppInstanceUserArn
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' )
- 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) – The
AppInstanceUserArn
of the user that makes the API call.
- Return type:
dict
- Returns:
Response Syntax
{ 'ChannelArn': 'string', 'MessageId': '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.
Exceptions
Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException