describe_channel_moderator

ChimeSDKMessaging.Client.describe_channel_moderator(**kwargs)

Returns the full details of a single ChannelModerator.

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_moderator(
    ChannelArn='string',
    ChannelModeratorArn='string',
    ChimeBearer='string'
)

Parameters

• ChannelArn (string) --

  [REQUIRED]

  The ARN of the channel.

• ChannelModeratorArn (string) --

  [REQUIRED]

  The AppInstanceUserArn of the channel moderator.

• ChimeBearer (string) --

  [REQUIRED]

  The AppInstanceUserArn of the user that makes the API call.

Return type

dict

Returns

Response Syntax

{
    'ChannelModerator': {
        'Moderator': {
            'Arn': 'string',
            'Name': 'string'
        },
        'ChannelArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'CreatedBy': {
            'Arn': 'string',
            'Name': 'string'
        }
    }
}

Response Structure

• (dict) --

  • ChannelModerator (dict) --

    The details of the channel moderator.

    • Moderator (dict) --

      The moderator's data.

      • Arn (string) --

        The ARN in an Identity.

      • Name (string) --

        The name in an Identity.

    • ChannelArn (string) --

      The ARN of the moderator's channel.

    • CreatedTimestamp (datetime) --

      The time at which the moderator was created.

    • CreatedBy (dict) --

      The AppInstanceUser who created the 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.NotFoundException
• ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException
• ChimeSDKMessaging.Client.exceptions.ThrottledClientException
• ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException
• ChimeSDKMessaging.Client.exceptions.ServiceFailureException