openapi: 3.0.0
info:
version: 2013-12-02
x-release: v4
title: Amazon Kinesis
description: <fullname>Amazon Kinesis Data Streams Service API Reference</fullname> <p>Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: "#FFFFFF"
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: [email protected]
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: kinesis
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/kinesis-2013-12-02.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/kinesis/
servers:
- url: http://kinesis.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Kinesis multi-region endpoint
- url: https://kinesis.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Kinesis multi-region endpoint
- url: http://kinesis.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Kinesis endpoint for China (Beijing) and China (Ningxia)
- url: https://kinesis.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Kinesis endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
/#X-Amz-Target=Kinesis_20131202.AddTagsToStream:
post:
operationId: AddTagsToStream
description: <p>Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream.</p> <note> <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input parameter rather than the <code>StreamName</code> input parameter.</p> </note> <p>If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys.</p> <p> <a>AddTagsToStream</a> has a limit of five transactions per second per account.</p>
responses:
"200":
description: Success
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: ResourceInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceInUseException"
"482":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
"483":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"484":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AddTagsToStreamInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.AddTagsToStream
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.CreateStream:
post:
operationId: CreateStream
description: <p>Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.</p> <p>You can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput. For the data streams with a provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.</p> <p>The stream name identifies the stream. The name is scoped to the Amazon Web Services account used by the application. It is also scoped by Amazon Web Services Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.</p> <p> <code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Kinesis Data Streams immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Kinesis Data Streams sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </p> <p>You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request when you try to do one of the following:</p> <ul> <li> <p>Have more than five streams in the <code>CREATING</code> state at any point in time.</p> </li> <li> <p>Create more shards than are authorized for your account.</p> </li> </ul> <p>For the default shard limit for an Amazon Web Services account, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html">Amazon Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>. To increase this limit, <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">contact Amazon Web Services Support</a>.</p> <p>You can use <a>DescribeStreamSummary</a> to check the stream status, which is returned in <code>StreamStatus</code>.</p> <p> <a>CreateStream</a> has a limit of five transactions per second per account.</p>
responses:
"200":
description: Success
"480":
description: ResourceInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceInUseException"
"481":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"482":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateStreamInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.CreateStream
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.DecreaseStreamRetentionPeriod:
post:
operationId: DecreaseStreamRetentionPeriod
description: <p>Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.</p> <note> <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input parameter rather than the <code>StreamName</code> input parameter.</p> </note> <p>This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.</p>
responses:
"200":
description: Success
"480":
description: ResourceInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceInUseException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"483":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
"484":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DecreaseStreamRetentionPeriodInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.DecreaseStreamRetentionPeriod
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.DeleteStream:
post:
operationId: DeleteStream
description: <p>Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception <code>ResourceNotFoundException</code>.</p> <note> <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input parameter rather than the <code>StreamName</code> input parameter.</p> </note> <p>If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Kinesis Data Streams completes the deletion.</p> <p> <b>Note:</b> Kinesis Data Streams might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete.</p> <p>When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.</p> <p>You can use the <a>DescribeStreamSummary</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p> <a>DeleteStream</a> has a limit of five transactions per second per account.</p>
responses:
"200":
description: Success
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"482":
description: ResourceInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceInUseException"
"483":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
"484":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteStreamInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.DeleteStream
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.DeregisterStreamConsumer:
post:
operationId: DeregisterStreamConsumer
description: <p>To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the <a>ListStreamConsumers</a> 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 name and ARN.</p> <p>This operation has a limit of five transactions per second per stream.</p>
responses:
"200":
description: Success
"480":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DeregisterStreamConsumerInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.DeregisterStreamConsumer
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.DescribeLimits:
post:
operationId: DescribeLimits
description: <p>Describes the shard limits and usage for the account.</p> <p>If you update your account limits, the old limits might be returned for a few minutes.</p> <p>This operation has a limit of one transaction per second per account.</p>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeLimitsOutput"
"480":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeLimitsInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.DescribeLimits
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.DescribeStream:
post:
operationId: DescribeStream
description: <p>Describes the specified Kinesis data stream.</p> <note> <p>This API has been revised. It's highly recommended that you use the <a>DescribeStreamSummary</a> API to get a summarized description of the specified Kinesis data stream and the <a>ListShards</a> API to list the shards in a specified data stream and obtain information about each shard. </p> </note> <note> <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input parameter rather than the <code>StreamName</code> input parameter.</p> </note> <p>The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.</p> <p>You can limit the number of shards returned by each call. For more information, see <a href="https://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html">Retrieving Shards from a Stream</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.</p> <p>This operation has a limit of 10 transactions per second per account.</p>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeStreamOutput"
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"482":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
"483":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeStreamInput"
parameters:
- name: Limit
in: query
schema:
type: string
description: Pagination limit
required: false
- name: ExclusiveStartShardId
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.DescribeStream
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.DescribeStreamConsumer:
post:
operationId: DescribeStreamConsumer
description: <p>To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the <a>ListStreamConsumers</a> operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.</p> <p>This operation has a limit of 20 transactions per second per stream.</p>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeStreamConsumerOutput"
"480":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"481":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"482":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeStreamConsumerInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.DescribeStreamConsumer
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.DescribeStreamSummary:
post:
operationId: DescribeStreamSummary
description: <p>Provides a summarized description of the specified Kinesis data stream without the shard list.</p> <note> <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input parameter rather than the <code>StreamName</code> input parameter.</p> </note> <p>The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count. </p> <p> <a>DescribeStreamSummary</a> has a limit of 20 transactions per second per account.</p>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeStreamSummaryOutput"
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"482":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
"483":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeStreamSummaryInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.DescribeStreamSummary
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.DisableEnhancedMonitoring:
post:
operationId: DisableEnhancedMonitoring
description: <p>Disables enhanced monitoring.</p> <note> <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input parameter rather than the <code>StreamName</code> input parameter.</p> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/EnhancedMonitoringOutput"
"480":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
"481":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"482":
description: ResourceInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceInUseException"
"483":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"484":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DisableEnhancedMonitoringInput"
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Kinesis_20131202.DisableEnhancedMonitoring
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/#X-Amz-Target=Kinesis_20131202.EnableEnhancedMonitoring:
post:
operationId: EnableEnhancedMonitoring
description: <p>Enables enhanced Kinesis data stream monitoring for shard-level metrics.</p> <note> <p>When invoking this API, it is recommended you use the <code>StreamARN</code> input parameter rather than the <code>StreamName</code> input parameter.</p> </note>
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/EnhancedMonitoringOutput"
"480":
description: InvalidArgumentException
content:
application/json:
schema:
$ref: "#/components/schemas/InvalidArgumentException"
"481":
description: LimitExceededException
content:
application/json:
schema:
$ref: "#/components/schemas/LimitExceededException"
"482":
description: ResourceInUseException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceInUseException"
"483":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"484":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/sc
# --- truncated at 32 KB (182 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kinesis/refs/heads/main/openapi/amazon-kinesis-data-streams-openapi-original.yml