list_channels_moderated_by_app_instance_user

Chime.Client.list_channels_moderated_by_app_instance_user(**kwargs)

A list of the channels moderated by an AppInstanceUser .

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.list_channels_moderated_by_app_instance_user(
    AppInstanceUserArn='string',
    MaxResults=123,
    NextToken='string',
    ChimeBearer='string'
)

Parameters

• AppInstanceUserArn (string) -- The ARN of the user in the moderated channel.
• MaxResults (integer) -- The maximum number of channels in the request.
• NextToken (string) -- The token returned from previous API requests until the number of channels moderated by the user is reached.
• ChimeBearer (string) -- The AppInstanceUserArn of the user that makes the API call.

Return type

dict

Returns

Response Syntax

{
    'Channels': [
        {
            'ChannelSummary': {
                'Name': 'string',
                'ChannelArn': 'string',
                'Mode': 'UNRESTRICTED'|'RESTRICTED',
                'Privacy': 'PUBLIC'|'PRIVATE',
                'Metadata': 'string',
                'LastMessageTimestamp': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Channels (list) --

    The moderated channels in the request.

    • (dict) --

      Summary of the details of a moderated channel.

      • ChannelSummary (dict) --

        Summary of the details of a Channel .

        • Name (string) --

          The name of the channel.

        • ChannelArn (string) --

          The ARN of the channel.

        • Mode (string) --

          The mode of the channel.

        • Privacy (string) --

          The privacy setting of the channel.

        • Metadata (string) --

          The metadata of the channel.

        • LastMessageTimestamp (datetime) --

          The time at which the last message in a channel was sent.

  • NextToken (string) --

    The token returned from previous API requests until the number of channels moderated by the user is reached.

Exceptions

• Chime.Client.exceptions.BadRequestException
• Chime.Client.exceptions.ForbiddenException
• Chime.Client.exceptions.UnauthorizedClientException
• Chime.Client.exceptions.ThrottledClientException
• Chime.Client.exceptions.ServiceUnavailableException
• Chime.Client.exceptions.ServiceFailureException