AWS Kinesis · Schema

DeregisterStreamConsumerInput

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
StreamARN object
ConsumerName object
ConsumerARN object
View JSON Schema on GitHub

JSON Schema

kinesis-deregisterstreamconsumerinput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DeregisterStreamConsumerInput",
  "title": "DeregisterStreamConsumerInput",
  "type": "object",
  "properties": {
    "StreamARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamARN"
        },
        {
          "description": "The ARN of the Kinesis data stream that the consumer is registered with. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams\">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>."
        }
      ]
    },
    "ConsumerName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConsumerName"
        },
        {
          "description": "The name that you gave to the consumer."
        }
      ]
    },
    "ConsumerARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConsumerARN"
        },
        {
          "description": "The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN."
        }
      ]
    }
  }
}