describe_channel_ban `async` ¶

describe_channel_ban(
    channel_arn: ChimeArn,
    member_arn: ChimeArn,
    chime_bearer: ChimeArn,
    *,
    config_overrides: Optional[AsyncChimeSDKMessagingClientConfig] = None,
) -> DescribeChannelBanResponse

Returns the full details of a channel ban.

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 channel from which the user is banned.
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:

BadRequestException –

The input parameters don't match the service's restrictions.
ForbiddenException –

The client is permanently forbidden from making the request.
NotFoundException –

One or more of the resources in the request does not exist in the system.
ServiceFailureException –

The service encountered an unexpected error.
ServiceUnavailableException –

The service is currently unavailable.
ThrottledClientException –

The client exceeded its request rate limit.
UnauthorizedClientException –

The client is not currently authorized to make the request.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_chime_sdk_messaging/_services/async_chime_sdk_messaging.py

async def describe_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[AsyncChimeSDKMessagingClientConfig] = None,
) -> "capo_chime_sdk_messaging.types.describe_channel_ban_response.DescribeChannelBanResponse":
    """<p>Returns the full details of a channel ban.</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 from which the user is banned.</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.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_messaging.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime_sdk_messaging.types.describe_channel_ban_request.DescribeChannelBanRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime_sdk_messaging.types.describe_channel_ban_response.DescribeChannelBanResponse"
    ]:
        import capo_chime_sdk_messaging._operations.chime_messaging_service.describe_channel_ban

        (
            output,
            http_response,
        ) = await capo_chime_sdk_messaging._operations.chime_messaging_service.describe_channel_ban.async_describe_channel_ban(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_chime_sdk_messaging.types.describe_channel_ban_response.DescribeChannelBanResponse",
    ) -> dict[str, Any]:
        import capo_chime_sdk_messaging.types.describe_channel_ban_response

        return capo_chime_sdk_messaging.types.describe_channel_ban_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeChannelBan", redact_output=_redact_output),
    )
    input_: capo_chime_sdk_messaging.types.describe_channel_ban_request.DescribeChannelBanRequest = {
        "channel_arn": channel_arn,
        "member_arn": member_arn,
        "chime_bearer": chime_bearer,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_channel_ban async ¶

describe_channel_ban `async` ¶