diff --git a/clients/client-kinesis/src/commands/CreateStreamCommand.ts b/clients/client-kinesis/src/commands/CreateStreamCommand.ts index 88f083c257e0..733a1a6fd9d2 100644 --- a/clients/client-kinesis/src/commands/CreateStreamCommand.ts +++ b/clients/client-kinesis/src/commands/CreateStreamCommand.ts @@ -72,6 +72,11 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {} *

* CreateStream has a limit of five transactions per second per * account.

+ *

You can add tags to the stream when making a CreateStream request by + * setting the Tags parameter. If you pass Tags parameter, in + * addition to having kinesis:createStream permission, you must also have + * kinesis:addTagsToStream permission for the stream that will be created. + * Tags will take effect from the CREATING status of the stream.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -84,6 +89,9 @@ export interface CreateStreamCommandOutput extends __MetadataBearer {} * StreamModeDetails: { // StreamModeDetails * StreamMode: "PROVISIONED" || "ON_DEMAND", // required * }, + * Tags: { // TagMap + * "": "STRING_VALUE", + * }, * }; * const command = new CreateStreamCommand(input); * const response = await client.send(command); diff --git a/clients/client-kinesis/src/commands/GetResourcePolicyCommand.ts b/clients/client-kinesis/src/commands/GetResourcePolicyCommand.ts index 121351400f44..b3f39fe6b284 100644 --- a/clients/client-kinesis/src/commands/GetResourcePolicyCommand.ts +++ b/clients/client-kinesis/src/commands/GetResourcePolicyCommand.ts @@ -74,6 +74,10 @@ export interface GetResourcePolicyCommandOutput extends GetResourcePolicyOutput, *

The requested resource exceeds the maximum number allowed, or the number of concurrent * stream requests exceeds the maximum number allowed.

* + * @throws {@link ResourceInUseException} (client fault) + *

The resource is not available for this operation. For successful operation, the + * resource must be in the ACTIVE state.

+ * * @throws {@link ResourceNotFoundException} (client fault) *

The requested resource could not be found. The stream might not be specified * correctly.

diff --git a/clients/client-kinesis/src/commands/RegisterStreamConsumerCommand.ts b/clients/client-kinesis/src/commands/RegisterStreamConsumerCommand.ts index d4ddc0c7be69..ebaaba2af050 100644 --- a/clients/client-kinesis/src/commands/RegisterStreamConsumerCommand.ts +++ b/clients/client-kinesis/src/commands/RegisterStreamConsumerCommand.ts @@ -35,7 +35,7 @@ export interface RegisterStreamConsumerCommandOutput extends RegisterStreamConsu * read from the same stream.

*

You can register up to 20 consumers per stream. A given consumer can only be * registered with one stream at a time.

- *

For an example of how to use this operations, see Enhanced Fan-Out + *

For an example of how to use this operation, see Enhanced Fan-Out * Using the Kinesis Data Streams API.

*

The use of this operation has a limit of five transactions per second per account. * Also, only 5 consumers can be created simultaneously. In other words, you cannot have diff --git a/clients/client-kinesis/src/commands/SubscribeToShardCommand.ts b/clients/client-kinesis/src/commands/SubscribeToShardCommand.ts index 64350a45d976..d165e4f10edd 100644 --- a/clients/client-kinesis/src/commands/SubscribeToShardCommand.ts +++ b/clients/client-kinesis/src/commands/SubscribeToShardCommand.ts @@ -53,7 +53,7 @@ export interface SubscribeToShardCommandOutput extends SubscribeToShardOutput, _ * seconds or more after a successful call, the second call takes over the subscription and * the previous connection expires or fails with a * ResourceInUseException.

- *

For an example of how to use this operations, see Enhanced Fan-Out + *

For an example of how to use this operation, see Enhanced Fan-Out * Using the Kinesis Data Streams API.

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-kinesis/src/models/models_0.ts b/clients/client-kinesis/src/models/models_0.ts index ccd4f1edf7e9..aa2f65328f21 100644 --- a/clients/client-kinesis/src/models/models_0.ts +++ b/clients/client-kinesis/src/models/models_0.ts @@ -330,6 +330,12 @@ export interface CreateStreamInput { * @public */ StreamModeDetails?: StreamModeDetails; + + /** + *

A set of up to 10 key-value pairs to use to create the tags.

+ * @public + */ + Tags?: Record; } /** diff --git a/codegen/sdk-codegen/aws-models/kinesis.json b/codegen/sdk-codegen/aws-models/kinesis.json index 34f7434c1a95..1f50a8b24bbf 100644 --- a/codegen/sdk-codegen/aws-models/kinesis.json +++ b/codegen/sdk-codegen/aws-models/kinesis.json @@ -300,7 +300,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You can create your data stream using either on-demand or provisioned capacity mode.\n Data streams with an on-demand mode require no capacity planning and automatically scale\n to handle gigabytes of write and read throughput per minute. With the on-demand mode,\n Kinesis Data Streams automatically manages the shards in order to provide the necessary\n throughput. For the data streams with a provisioned mode, you must specify the number of\n shards for the data stream. Each shard can support reads up to five transactions per\n second, up to a maximum data read total of 2 MiB per second. Each shard can support\n writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per\n second. If the amount of data input increases or decreases, you can add or remove\n shards.

\n

The stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n \n

For the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

You can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

" + "smithy.api#documentation": "

Creates a Kinesis data stream. A stream captures and transports data records that are\n continuously emitted from different data sources or producers.\n Scale-out within a stream is explicitly supported by means of shards, which are uniquely\n identified groups of data records in a stream.

\n

You can create your data stream using either on-demand or provisioned capacity mode.\n Data streams with an on-demand mode require no capacity planning and automatically scale\n to handle gigabytes of write and read throughput per minute. With the on-demand mode,\n Kinesis Data Streams automatically manages the shards in order to provide the necessary\n throughput. For the data streams with a provisioned mode, you must specify the number of\n shards for the data stream. Each shard can support reads up to five transactions per\n second, up to a maximum data read total of 2 MiB per second. Each shard can support\n writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per\n second. If the amount of data input increases or decreases, you can add or remove\n shards.

\n

The stream name identifies the stream. The name is scoped to the Amazon Web Services\n account used by the application. It is also scoped by Amazon Web Services Region. That\n is, two streams in two different accounts can have the same name, and two streams in the\n same account, but in two different Regions, can have the same name.

\n

\n CreateStream is an asynchronous operation. Upon receiving a\n CreateStream request, Kinesis Data Streams immediately returns and sets\n the stream status to CREATING. After the stream is created, Kinesis Data\n Streams sets the stream status to ACTIVE. You should perform read and write\n operations only on an ACTIVE stream.

\n

You receive a LimitExceededException when making a\n CreateStream request when you try to do one of the following:

\n \n

For the default shard limit for an Amazon Web Services account, see Amazon\n Kinesis Data Streams Limits in the Amazon Kinesis Data Streams\n Developer Guide. To increase this limit, contact Amazon Web Services\n Support.

\n

You can use DescribeStreamSummary to check the stream status, which\n is returned in StreamStatus.

\n

\n CreateStream has a limit of five transactions per second per\n account.

\n

You can add tags to the stream when making a CreateStream request by\n setting the Tags parameter. If you pass Tags parameter, in\n addition to having kinesis:createStream permission, you must also have\n kinesis:addTagsToStream permission for the stream that will be created.\n Tags will take effect from the CREATING status of the stream.

" } }, "com.amazonaws.kinesis#CreateStreamInput": { @@ -324,6 +324,12 @@ "traits": { "smithy.api#documentation": "

Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams,\n you can choose between an on-demand capacity mode and a\n provisioned capacity mode for your data\n streams.

" } + }, + "Tags": { + "target": "com.amazonaws.kinesis#TagMap", + "traits": { + "smithy.api#documentation": "

A set of up to 10 key-value pairs to use to create the tags.

" + } } }, "traits": { @@ -1296,6 +1302,9 @@ { "target": "com.amazonaws.kinesis#LimitExceededException" }, + { + "target": "com.amazonaws.kinesis#ResourceInUseException" + }, { "target": "com.amazonaws.kinesis#ResourceNotFoundException" } @@ -6924,7 +6933,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

", + "smithy.api#documentation": "

Registers a consumer with a Kinesis data stream. When you use this operation, the\n consumer you register can then call SubscribeToShard to receive data\n from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every\n shard you subscribe to. This rate is unaffected by the total number of consumers that\n read from the same stream.

\n

You can register up to 20 consumers per stream. A given consumer can only be\n registered with one stream at a time.

\n

For an example of how to use this operation, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

\n

The use of this operation has a limit of five transactions per second per account.\n Also, only 5 consumers can be created simultaneously. In other words, you cannot have\n more than 5 consumers in a CREATING status at the same time. Registering a\n 6th consumer while there are 5 in a CREATING status results in a\n LimitExceededException.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "control" @@ -7884,7 +7893,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.

\n

For an example of how to use this operations, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

", + "smithy.api#documentation": "

This operation establishes an HTTP/2 connection between the consumer you specify in\n the ConsumerARN parameter and the shard you specify in the\n ShardId parameter. After the connection is successfully established,\n Kinesis Data Streams pushes records from the shard to the consumer over this connection.\n Before you call this operation, call RegisterStreamConsumer to\n register the consumer with Kinesis Data Streams.

\n

When the SubscribeToShard call succeeds, your consumer starts receiving\n events of type SubscribeToShardEvent over the HTTP/2 connection for up\n to 5 minutes, after which time you need to call SubscribeToShard again to\n renew the subscription if you want to continue to receive records.

\n

You can make one call to SubscribeToShard per second per registered\n consumer per shard. For example, if you have a 4000 shard stream and two registered\n stream consumers, you can make one SubscribeToShard request per second for\n each combination of shard and registered consumer, allowing you to subscribe both\n consumers to all 4000 shards in one second.

\n

If you call SubscribeToShard again with the same ConsumerARN\n and ShardId within 5 seconds of a successful call, you'll get a\n ResourceInUseException. If you call SubscribeToShard 5\n seconds or more after a successful call, the second call takes over the subscription and\n the previous connection expires or fails with a\n ResourceInUseException.

\n

For an example of how to use this operation, see Enhanced Fan-Out\n Using the Kinesis Data Streams API.

", "smithy.rules#staticContextParams": { "OperationType": { "value": "data"