update_channel_read_marker

update_channel_read_marker(**kwargs)

The details of the time when a user last read messages in a channel.

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.update_channel_read_marker(
    ChannelArn='string',
    ChimeBearer='string',
    SubChannelId='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • ChimeBearer (string) --

    [REQUIRED]

    The AppInstanceUserArn of the user that makes the API call.

  • SubChannelId (string) -- The ID of the SubChannel in the request.
Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'SubChannelId': 'string'
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

    • SubChannelId (string) --

      The ID of the SubChannel in the response.

Exceptions

  • ChimeSDKMessaging.Client.exceptions.BadRequestException
  • ChimeSDKMessaging.Client.exceptions.ForbiddenException
  • ChimeSDKMessaging.Client.exceptions.ConflictException
  • ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException
  • ChimeSDKMessaging.Client.exceptions.ThrottledClientException
  • ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException
  • ChimeSDKMessaging.Client.exceptions.ServiceFailureException