Chime / Client / get_channel_message

get_channel_message#

Chime.Client.get_channel_message(**kwargs)#

Gets the full details of a channel message.

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, GetChannelMessage, 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.get_channel_message(
    ChannelArn='string',
    MessageId='string',
    ChimeBearer='string'
)

Parameters:

ChannelArn (string) –
[REQUIRED]

The ARN of the channel.
MessageId (string) –
[REQUIRED]

The ID of the message.
ChimeBearer (string) – The AppInstanceUserArn of the user that makes the API call.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelMessage': {
        'ChannelArn': 'string',
        'MessageId': 'string',
        'Content': 'string',
        'Metadata': 'string',
        'Type': 'STANDARD'|'CONTROL',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastEditedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'Sender': {
            'Arn': 'string',
            'Name': 'string'
        },
        'Redacted': True|False,
        'Persistence': 'PERSISTENT'|'NON_PERSISTENT'
    }
}

Response Structure

(dict) –
- ChannelMessage (dict) –
  
  The details of and content in the message.
  - ChannelArn (string) –
    
    The ARN of the channel.
  - MessageId (string) –
    
    The ID of a message.
  - Content (string) –
    
    The message content.
  - Metadata (string) –
    
    The message metadata.
  - Type (string) –
    
    The message type.
  - CreatedTimestamp (datetime) –
    
    The time at which the message was created.
  - LastEditedTimestamp (datetime) –
    
    The time at which a message was edited.
  - LastUpdatedTimestamp (datetime) –
    
    The time at which a message was updated.
  - Sender (dict) –
    
    The message sender.
    - Arn (string) –
      
      The ARN in an Identity.
    - Name (string) –
      
      The name in an Identity.
  - Redacted (boolean) –
    
    Hides the content of a message.
  - Persistence (string) –
    
    The persistence setting for a channel message.

Exceptions

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