ChimeSDKMessaging / Client / describe_channel

describe_channel#

ChimeSDKMessaging.Client.describe_channel(**kwargs)#

Returns the full details of a channel in an Amazon Chime AppInstance.

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.describe_channel(
    ChannelArn='string',
    ChimeBearer='string'
)
Parameters:

  • ChannelArn (string) –

    [REQUIRED]

    The ARN of the channel.

  • ChimeBearer (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Channel': {
        'Name': 'string',
        'ChannelArn': 'string',
        'Mode': 'UNRESTRICTED'|'RESTRICTED',
        'Privacy': 'PUBLIC'|'PRIVATE',
        'Metadata': 'string',
        'CreatedBy': {
            'Arn': 'string',
            'Name': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastMessageTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'ChannelFlowArn': 'string',
        'ElasticChannelConfiguration': {
            'MaximumSubChannels': 123,
            'TargetMembershipsPerSubChannel': 123,
            'MinimumMembershipPercentage': 123
        },
        'ExpirationSettings': {
            'ExpirationDays': 123,
            'ExpirationCriterion': 'CREATED_TIMESTAMP'|'LAST_MESSAGE_TIMESTAMP'
        }
    }
}

Response Structure

  • (dict) –

    • Channel (dict) –

      The channel details.

      • Name (string) –

        The name of a channel.

      • ChannelArn (string) –

        The ARN of a channel.

      • Mode (string) –

        The mode of the channel.

      • Privacy (string) –

        The channel’s privacy setting.

      • Metadata (string) –

        The channel’s metadata.

      • CreatedBy (dict) –

        The AppInstanceUser who created the channel.

        • Arn (string) –

          The ARN in an Identity.

        • Name (string) –

          The name in an Identity.

      • CreatedTimestamp (datetime) –

        The time at which the AppInstanceUser created the channel.

      • LastMessageTimestamp (datetime) –

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

      • LastUpdatedTimestamp (datetime) –

        The time at which a channel was last updated.

      • ChannelFlowArn (string) –

        The ARN of the channel flow.

      • ElasticChannelConfiguration (dict) –

        The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

        • MaximumSubChannels (integer) –

          The maximum number of SubChannels that you want to allow in the elastic channel.

        • TargetMembershipsPerSubChannel (integer) –

          The maximum number of members allowed in a SubChannel.

        • MinimumMembershipPercentage (integer) –

          The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.

      • ExpirationSettings (dict) –

        Settings that control when a channel expires.

        • ExpirationDays (integer) –

          The period in days after which the system automatically deletes a channel.

        • ExpirationCriterion (string) –

          The conditions that must be met for a channel to expire.

Exceptions