Chime / Client / describe_channel

describe_channel#

Chime.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 AppInstanceUserArn of the user that makes the API call as the value in the header.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannel, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

response = client.describe_channel(
    ChannelArn='string',
    ChimeBearer='string'
)

Parameters:

ChannelArn (string) –
[REQUIRED]

The ARN of the channel.
ChimeBearer (string) – The AppInstanceUserArn of the user 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)
    }
}

Response Structure

(dict) –
- Channel (dict) –
  
  The channel details.
  - Name (string) –
    
    The name of the channel.
  - ChannelArn (string) –
    
    The ARN of the 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.

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