InvokeWithResponseStreamResponseEvent

An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a InvokeComplete object.

APIs.ioEngineeringPlatform

Properties

Name Type Description
PayloadChunk object
InvokeComplete object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-invokewithresponsestreamresponseevent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/InvokeWithResponseStreamResponseEvent",
  "title": "InvokeWithResponseStreamResponseEvent",
  "type": "object",
  "properties": {
    "PayloadChunk": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InvokeResponseStreamUpdate"
        },
        {
          "description": "A chunk of the streamed response payload."
        }
      ]
    },
    "InvokeComplete": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InvokeWithResponseStreamCompleteEvent"
        },
        {
          "description": "An object that's returned when the stream has ended and all the payload chunks have been returned."
        }
      ]
    }
  },
  "description": "An object that includes a chunk of the response payload. When the stream has ended, Lambda includes a <code>InvokeComplete</code> object."
}