Chime / Client / list_channel_bans

list_channel_bans#

Chime.Client.list_channel_bans(**kwargs)#

Lists all the users banned from a particular channel.

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.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelBans, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.list_channel_bans(
    ChannelArn='string',
    MaxResults=123,
    NextToken='string',
    ChimeBearer='string'
)
Parameters:
  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel.

  • MaxResults (integer) – The maximum number of bans that you want returned.

  • NextToken (string) – The token passed by previous API calls until all requested bans are returned.

  • ChimeBearer (string) – The AppInstanceUserArn of the user that makes the API call.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelArn': 'string',
    'NextToken': 'string',
    'ChannelBans': [
        {
            'Member': {
                'Arn': 'string',
                'Name': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) –

    • ChannelArn (string) –

      The ARN of the channel.

    • NextToken (string) –

      The token passed by previous API calls until all requested bans are returned.

    • ChannelBans (list) –

      The information for each requested ban.

      • (dict) –

        Summary of the details of a ChannelBan.

        • Member (dict) –

          The member being banned from a channel.

          • Arn (string) –

            The ARN in an Identity.

          • Name (string) –

            The name in an Identity.

Exceptions