Skip to content

DeleteMessageRequest

Source code in docs_src/capo_ivschat/types/delete_message_request.py 
15
16
17
18
19
20
21
class DeleteMessageRequest(TypedDict, closed=True):
    room_identifier: "capo_ivschat.types.room_identifier.RoomIdentifier"
    """<p>Identifier of the room where the message should be deleted. Currently this must be an ARN. </p>"""
    id: "capo_ivschat.types.message_id.MessageID"
    """<p>ID of the message to be deleted. This is the <code>Id</code> field in the received message (see <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html"> Message (Subscribe)</a> in the Chat Messaging API).</p>"""
    reason: NotRequired["capo_ivschat.types.reason.Reason"]
    """<p>Reason for deleting the message.</p>"""

id instance-attribute 

id: MessageID

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 instance-attribute 

reason: NotRequired[Reason]

Reason for deleting the message.

room_identifier instance-attribute 

room_identifier: RoomIdentifier

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