ChimeSDKMessaging / Client / describe_channel_ban

describe_channel_ban#

ChimeSDKMessaging.Client.describe_channel_ban(**kwargs)#

Returns the full details of a channel ban.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel_ban(
    ChannelArn='string',
    MemberArn='string',
    ChimeBearer='string'
)
Parameters:

  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel from which the user is banned.

  • MemberArn (string) –

    [REQUIRED]

    The AppInstanceUserArn of the member being banned.

  • ChimeBearer (string) –

    [REQUIRED]

    The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelBan': {
        'Member': {
            'Arn': 'string',
            'Name': 'string'
        },
        'ChannelArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'CreatedBy': {
            'Arn': 'string',
            'Name': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • ChannelBan (dict) –

      The details of the ban.

      • Member (dict) –

        The member being banned from the channel.

        • Arn (string) –

          The ARN in an Identity.

        • Name (string) –

          The name in an Identity.

      • ChannelArn (string) –

        The ARN of the channel from which a member is being banned.

      • CreatedTimestamp (datetime) –

        The time at which the ban was created.

      • CreatedBy (dict) –

        The AppInstanceUser who created the ban.

        • Arn (string) –

          The ARN in an Identity.

        • Name (string) –

          The name in an Identity.

Exceptions

  • ChimeSDKMessaging.Client.exceptions.BadRequestException

  • ChimeSDKMessaging.Client.exceptions.ForbiddenException

  • ChimeSDKMessaging.Client.exceptions.NotFoundException

  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException

  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException

  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException

  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException