ChimeSDKMessaging / Client / list_channel_bans

list_channel_bans#

ChimeSDKMessaging.Client.list_channel_bans(**kwargs)#

Lists all the users and bots banned from a particular channel.

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.

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) –
[REQUIRED]

The ARN of the AppInstanceUser or AppInstanceBot 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

ChimeSDKMessaging.Client.exceptions.BadRequestException
ChimeSDKMessaging.Client.exceptions.ForbiddenException
ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException
ChimeSDKMessaging.Client.exceptions.ThrottledClientException
ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException
ChimeSDKMessaging.Client.exceptions.ServiceFailureException