send_event

send_event(**kwargs)

Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.

See also: AWS API Documentation

Request Syntax

response = client.send_event(
    attributes={
        'string': 'string'
    },
    eventName='string',
    roomIdentifier='string'
)

Parameters

• attributes (dict) --

  Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.

  • (string) --
    • (string) --
• eventName (string) --

  [REQUIRED]

  Application-defined name of the event to send to clients.

• roomIdentifier (string) --

  [REQUIRED]

  Identifier of the room to which the event will be sent. Currently this must be an ARN.

Return type

dict

Returns

Response Syntax

{
    'id': 'string'
}

Response Structure

• (dict) --

  • id (string) --

    An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent operations for this message, such as DeleteMessage.

Exceptions

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