describe_channel_ban

Chime.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 AppInstanceUserArn of the user 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 ARN of the member being banned.

• ChimeBearer (string) -- The AppInstanceUserArn of the user 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

• Chime.Client.exceptions.BadRequestException
• Chime.Client.exceptions.ForbiddenException
• Chime.Client.exceptions.NotFoundException
• Chime.Client.exceptions.UnauthorizedClientException
• Chime.Client.exceptions.ThrottledClientException
• Chime.Client.exceptions.ServiceUnavailableException
• Chime.Client.exceptions.ServiceFailureException