Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.
If you ban a user who is already part of a channel, that user is automatically kicked from the channel.
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)
–
The ARN of the ban request.
-
member_arn
(ChimeArn)
–
The AppInstanceUserArn of the member being banned.
-
chime_bearer
(ChimeArn)
–
The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
Raises:
Source code in docs_src/capo_chime_sdk_messaging/_services/chime_sdk_messaging.py
| def create_channel_ban(
self,
channel_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
member_arn: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
chime_bearer: "capo_chime_sdk_messaging.types.chime_arn.ChimeArn",
*,
config_overrides: Optional[ChimeSDKMessagingClientConfig] = None,
) -> "capo_chime_sdk_messaging.types.create_channel_ban_response.CreateChannelBanResponse":
"""<p>Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or channels.</p> <p>If you ban a user who is already part of a channel, that user is automatically kicked from the channel.</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 ban request.</p>
member_arn: <p>The <code>AppInstanceUserArn</code> of the member being banned.</p>
chime_bearer: <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
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.conflict_exception.ConflictException: <p>The request could not be processed because of conflict in the current state of the resource.</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.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</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.create_channel_ban_request.CreateChannelBanRequest]",
) -> OperationResponse[
"capo_chime_sdk_messaging.types.create_channel_ban_response.CreateChannelBanResponse"
]:
import capo_chime_sdk_messaging._operations.chime_messaging_service.create_channel_ban
output, http_response = (
capo_chime_sdk_messaging._operations.chime_messaging_service.create_channel_ban.create_channel_ban(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
def _redact_output(
output: "capo_chime_sdk_messaging.types.create_channel_ban_response.CreateChannelBanResponse",
) -> dict[str, Any]:
import capo_chime_sdk_messaging.types.create_channel_ban_response
return capo_chime_sdk_messaging.types.create_channel_ban_response.redact_sensitive(
output
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("CreateChannelBan", redact_output=_redact_output),
)
input_: capo_chime_sdk_messaging.types.create_channel_ban_request.CreateChannelBanRequest = {
"channel_arn": channel_arn,
"member_arn": member_arn,
"chime_bearer": chime_bearer,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|