{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-interactive-video-service/refs/heads/main/json-schema/ivs-recording-configuration-schema.json",
"title": "RecordingConfiguration",
"description": "An object representing a configuration to record a channel stream.",
"type": "object",
"properties": {
"arn": {
"allOf": [
{
"$ref": "#/components/schemas/RecordingConfigurationArn"
},
{
"description": "Recording-configuration ARN."
}
]
},
"destinationConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/DestinationConfiguration"
},
{
"description": "A complex type that contains information about where recorded video will be stored."
}
]
},
"name": {
"allOf": [
{
"$ref": "#/components/schemas/RecordingConfigurationName"
},
{
"description": "Recording-configuration name. The value does not need to be unique."
}
]
},
"recordingReconnectWindowSeconds": {
"allOf": [
{
"$ref": "#/components/schemas/RecordingReconnectWindowSeconds"
},
{
"description": "If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0."
}
]
},
"renditionConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/RenditionConfiguration"
},
{
"description": "Object that describes which renditions should be recorded for a stream."
}
]
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/RecordingConfigurationState"
},
{
"description": "Indicates the current state of the recording configuration. When the state is ACTIVE, the configuration is ready for recording a channel stream."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/Tags"
},
{
"description": "Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no service-specific constraints beyond what is documented there."
}
]
},
"thumbnailConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/ThumbnailConfiguration"
},
{
"description": "A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session."
}
]
}
},
"required": [
"arn",
"destinationConfiguration",
"state"
]
}