AWS Kinesis · Schema

UpdateDataRetentionInput

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
StreamName object
StreamARN object
CurrentVersion object
Operation object
DataRetentionChangeInHours object
View JSON Schema on GitHub

JSON Schema

kinesis-updatedataretentioninput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateDataRetentionInput",
  "title": "UpdateDataRetentionInput",
  "type": "object",
  "required": [
    "CurrentVersion",
    "Operation",
    "DataRetentionChangeInHours"
  ],
  "properties": {
    "StreamName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamName"
        },
        {
          "description": "The name of the stream whose retention period you want to change."
        }
      ]
    },
    "StreamARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the stream whose retention period you want to change."
        }
      ]
    },
    "CurrentVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Version"
        },
        {
          "description": "The version of the stream whose retention period you want to change. To get the version, call either the <code>DescribeStream</code> or the <code>ListStreams</code> API."
        }
      ]
    },
    "Operation": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UpdateDataRetentionOperation"
        },
        {
          "description": "Indicates whether you want to increase or decrease the retention period."
        }
      ]
    },
    "DataRetentionChangeInHours": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DataRetentionChangeInHours"
        },
        {
          "description": "The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years)."
        }
      ]
    }
  }
}