Asynchronous Message Reception - Kinesis Video Streams
Event
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Asynchronous Message Reception

All response messages are asynchronously delivered to the recipient as events (for example, an SDP offer or SDP answer delivery). The following is the event message structure.

Event

{
    "senderClientId": "string",
    "messageType": "string",
    "messagePayload": "string",
    "statusResponse": {
        "correlationId": "string",
        "errorType": "string",
        "statusCode": "string",
        "description": "string"
    }
}

  • senderClientId - A unique identifier for the sender client.

    • Type: String

    • Length constraints: Minimum length of 1. Maximum length of 256.

    • Pattern: [a-zA-Z0-9_.-]+

    • Required: No

  • messageType - Type of the event.

    • Type: ENUM

    • Valid Types: SDP_OFFER, SDP_ANSWER, ICE_CANDIDATE, GO_AWAY, RECONNECT_ICE_SERVER, STATUS_RESPONSE

    • Length constraints: Minimum length of 1. Maximum length of 256.

    • Pattern: [a-zA-Z0-9_.-]+

    • Required: Yes

  • messagePayload - The base64-encoded message content.

    • Type: String

    • Length constraints: Minimum length of 1. Maximum length of 10K.

    • Required: No

  • correlationId - An unique identifier of the message for which the status is meant. This is the same correlationId provided in the client messages (for example, SDP offer, SDP answer, or ICE candidate).

    • Type: String

    • Length constraints: Minimum length of 1. Maximum length of 256.

    • Pattern: [a-zA-Z0-9_.-]+

    • Required: Yes

  • errorType - A name to uniquely identify the error.

    • Type: String

    • Length constraints: Minimum length of 1. Maximum length of 256.

    • Pattern: [a-zA-Z0-9_.-]+

    • Required: No

  • statusCode - HTTP status code corresponding to the nature of the response.

    • Type: String

    • Length constraints: Minimum length of 1. Maximum length of 256.

    • Pattern: [a-zA-Z0-9_.-]+

    • Required: No

  • description - A string description explaining the status.

    • Type: String

    • Length constraints: Minimum length of 1. Maximum length of 1K.

    • Required: No