delete_message

ivschat.Client.delete_message(**kwargs)

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE . This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

See also: AWS API Documentation

Request Syntax

response = client.delete_message(
    id='string',
    reason='string',
    roomIdentifier='string'
)

Parameters

• id (string) --

  [REQUIRED]

  ID of the message to be deleted. This is the Id field in the received message (see Message (Subscribe) in the Chat Messaging API).

• reason (string) -- Reason for deleting the message.
• roomIdentifier (string) --

  [REQUIRED]

  Identifier of the room where the message should be deleted. Currently this must be an ARN.

Return type

dict

Returns

Response Syntax

{
    'id': 'string'
}

Response Structure

• (dict) --

  • id (string) --

    Operation identifier, generated by Amazon IVS Chat.

Exceptions

• ivschat.Client.exceptions.ThrottlingException
• ivschat.Client.exceptions.AccessDeniedException
• ivschat.Client.exceptions.ResourceNotFoundException
• ivschat.Client.exceptions.PendingVerification
• ivschat.Client.exceptions.ValidationException