Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.
The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.
Parameters:
-
channel_arn
(ChimeArn)
–
-
message_id
(MessageId)
–
The ID of the message being deleted.
-
chime_bearer
(ChimeArn)
–
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
-
sub_channel_id
(Optional[SubChannelId], default:
None
)
–
The ID of the SubChannel in the request.
Only required when deleting messages in a SubChannel that the user belongs to.
Raises:
Source code in docs_src/capo_chime_sdk_messaging/_services/chime_sdk_messaging.py
| def delete_channel_message(
self,
channel_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
message_id: "capo_chime_sdk_messaging.types.message_id.MessageId",
chime_bearer: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
*,
config_overrides: Optional[ChimeSDKMessagingClientConfig] = None,
sub_channel_id: Optional[
"capo_chime_sdk_messaging.types.sub_channel_id.SubChannelId"
] = None,
) -> None:
"""<p>Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by <code>UpdateChannelMessage</code>.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the header.</p> </note>
Args:
channel_arn: <p>The ARN of the channel.</p>
message_id: <p>The ID of the message being deleted.</p>
chime_bearer: <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
sub_channel_id: <p>The ID of the SubChannel in the request.</p> <note> <p>Only required when deleting messages in a SubChannel that the user belongs to.</p> </note>
Raises:
capo_chime_sdk_messaging.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
capo_chime_sdk_messaging.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
capo_chime_sdk_messaging.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
capo_chime_sdk_messaging.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
capo_chime_sdk_messaging.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
capo_chime_sdk_messaging.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
capo_chime_sdk_messaging.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_chime_sdk_messaging.types.delete_channel_message_request.DeleteChannelMessageRequest]",
) -> OperationResponse[None]:
import capo_chime_sdk_messaging._operations.chime_messaging_service.delete_channel_message
output, http_response = (
capo_chime_sdk_messaging._operations.chime_messaging_service.delete_channel_message.delete_channel_message(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteChannelMessage")
)
input_: capo_chime_sdk_messaging.types.delete_channel_message_request.DeleteChannelMessageRequest = {
"channel_arn": channel_arn,
"message_id": message_id,
"chime_bearer": chime_bearer,
}
if sub_channel_id is not None:
input_["sub_channel_id"] = sub_channel_id
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|