create_stream¶
Operation¶
async
¶
create_stream(input: CreateStreamInput, plugins: list[Plugin] | None = None) -> CreateStreamOutput
Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.
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.
If you'd still like to proactively scale your on-demand data stream's
capacity, you can unlock the warm throughput feature for on-demand data
streams by enabling MinimumThroughputBillingCommitment for your
account. Once your account has MinimumThroughputBillingCommitment
enabled, you can specify the warm throughput in MiB per second that your
stream can support in writes.
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.
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.
CreateStream is an asynchronous operation. Upon receiving a
CreateStream request, Kinesis Data Streams immediately returns and
sets the stream status to CREATING. After the stream is created,
Kinesis Data Streams sets the stream status to ACTIVE. You should
perform read and write operations only on an ACTIVE stream.
You receive a LimitExceededException when making a CreateStream
request when you try to do one of the following:
-
Have more than five streams in the
CREATINGstate at any point in time. -
Create more shards than are authorized for your account.
For the default shard or on-demand throughput limits for an Amazon Web Services account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
You can use DescribeStreamSummary to check the stream status, which is
returned in StreamStatus.
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 the Tags parameter, in
addition to having the kinesis:CreateStream permission, you must also
have the kinesis:AddTagsToStream permission for the stream that will
be created. The kinesis:TagResource permission won't work to tag
streams on creation. Tags will take effect from the CREATING status of
the stream, but you can't make any updates to the tags until the stream
is in ACTIVE state.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateStreamInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateStreamOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Represents the input for CreateStream.
Attributes¶
class-attribute
instance-attribute
¶
max_record_size_in_ki_b: int | None = ...
The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
class-attribute
instance-attribute
¶
record_distribution_strategy: str | None = ...
The record distribution strategy for the stream, which determines how Amazon Kinesis Data Streams distributes records across shards. Specify one of the following values:
-
AUTO-- Amazon Kinesis Data Streams distributes records evenly across shards and ignores any partition key andExplicitHashKeythat producers supply. Use this value for stateless workloads that do not require partition-key ordering. -
USER_PARTITION_KEY-- Producers must supply a partition key, which Amazon Kinesis Data Streams uses to determine shard placement. This is the default.
The record distribution strategy is only supported for streams that use
the on-demand capacity mode. If you do not specify this parameter, the
stream uses USER_PARTITION_KEY.
class-attribute
instance-attribute
¶
shard_count: int | None = ...
The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.
class-attribute
instance-attribute
¶
stream_mode_details: StreamModeDetails | None = ...
Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
class-attribute
instance-attribute
¶
stream_name: str | None = ...
A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services account but in two different Regions can also have the same name.
class-attribute
instance-attribute
¶
A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateStreamOutput structure.