ChimeSDKMessaging / Client / list_channel_moderators

list_channel_moderators#

ChimeSDKMessaging.Client.list_channel_moderators(**kwargs)#

Lists all the moderators for a 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.

See also: AWS API Documentation

Request Syntax

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

  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel.

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

  • NextToken (string) – The token passed by previous API calls until all requested moderators 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',
    'ChannelModerators': [
        {
            'Moderator': {
                '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 moderators are returned.

    • ChannelModerators (list) –

      The information about and names of each moderator.

      • (dict) –

        Summary of the details of a ChannelModerator.

        • Moderator (dict) –

          The data for a moderator.

          • 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