ChimeSDKMessaging / Client / create_channel_moderator

create_channel_moderator#

ChimeSDKMessaging.Client.create_channel_moderator(**kwargs)#

Creates a new ChannelModerator. A channel moderator can:

  • Add and remove other members of the channel.

  • Add and remove other moderators of the channel.

  • Add and remove user bans for the channel.

  • Redact messages in the channel.

  • List messages in the channel.

Note

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or ``AppInstanceBot``of the user that makes the API call as the value in the header.

See also: AWS API Documentation

Request Syntax

response = client.create_channel_moderator(
    ChannelArn='string',
    ChannelModeratorArn='string',
    ChimeBearer='string'
)
Parameters:
  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel.

  • ChannelModeratorArn (string) –

    [REQUIRED]

    The AppInstanceUserArn of the moderator.

  • ChimeBearer (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ChannelArn': 'string',
    'ChannelModerator': {
        'Arn': 'string',
        'Name': 'string'
    }
}

Response Structure

  • (dict) –

    • ChannelArn (string) –

      The ARN of the channel.

    • ChannelModerator (dict) –

      The ARNs of the channel and the moderator.

      • Arn (string) –

        The ARN in an Identity.

      • Name (string) –

        The name in an Identity.

Exceptions