channel_message_status

Creates, updates, deletes, gets or lists a channel_message_status resource.

Overview

Name	channel_message_status
Type	Resource
Id	aws.chime_sdk_messaging.channel_message_status

Fields

The following fields are returned by SELECT queries:

get_channel_message_status

Name	Datatype	Description
detail	string	Contains more details about the message status. (pattern: <code>[\s\S]*</code>)
value	string	The message status value. (SENT, PENDING, FAILED, DENIED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_channel_message_status	select	channel_arn, message_id, x-amz-chime-bearer, region	sub-channel-id	Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket. Messages can have any one of these statuses. SENT Message processed successfully PENDING Ongoing processing FAILED Processing failed DENIED Message denied by the processor This API does not return statuses for denied messages, because we don't store them once the processor denies them. Only the message sender can invoke this API. 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
channel_arn	string	The ARN of the channel
message_id	string	The ID of the message.
region	string	AWS region (default: us-east-1)
x-amz-chime-bearer	string	The AppInstanceUserArn of the user making the API call.
sub-channel-id	string	The ID of the SubChannel in the request. Only required when getting message status in a SubChannel that the user belongs to.

SELECT examples

get_channel_message_status

Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket. Messages can have any one of these statuses. SENT Message processed successfully PENDING Ongoing processing FAILED Processing failed DENIED Message denied by the processor This API does not return statuses for denied messages, because we don't store them once the processor denies them. Only the message sender can invoke this API. 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.

SELECT
detail,
value
FROM aws.chime_sdk_messaging.channel_message_status
WHERE channel_arn = '{{ channel_arn }}' -- required
AND message_id = '{{ message_id }}' -- required
AND `x-amz-chime-bearer` = '{{ x-amz-chime-bearer }}' -- required
AND region = '{{ region }}' -- required
AND `sub-channel-id` = '{{ sub-channel-id }}'
;