create_channel¶
Operation¶
create_channel
async
¶
create_channel(request: CreateChannelInput | CreateChannelInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateChannelOutput
create_channel(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateChannelInputDict]) -> CreateChannelOutput
Creates a channel that delivers records from a Kinesis data stream to a destination. A channel reads records from the specified stream and writes them to streaming tables on Apache Iceberg (Amazon S3 Tables) or to a general purpose Amazon S3 bucket.
You must specify either S3DestinationConfiguration or
S3TablesDestinationConfiguration, but not both.
To use this operation, you must have permission to pass the specified
service execution IAM role to Amazon Kinesis Data Streams (the
iam:PassRole permission on that role).
Creating a channel is an asynchronous operation. Upon receiving the
request, Amazon Kinesis Data Streams returns immediately with the
channel in the CREATING state. After provisioning is complete, Amazon
Kinesis Data Streams sets the state to ACTIVE. You can use
DescribeChannel to check the current state.
This operation is only supported for data streams with the on-demand capacity mode.
This operation has a call limit of 5 transactions per second (TPS) for
each Amazon Web Services account. Exceeding 5 TPS results in a
LimitExceededException.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
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 |
|---|---|
CreateChannelOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
CreateChannelInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateChannelInput structure.
Attributes¶
channel_name
class-attribute
instance-attribute
¶
channel_name: str | None = ...
The name of the channel. The name is unique within your Amazon Web Services account and Amazon Web Services Region.
encryption_configuration
class-attribute
instance-attribute
¶
encryption_configuration: ChannelEncryptionConfiguration | None = ...
The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.
logging_configuration
class-attribute
instance-attribute
¶
logging_configuration: ChannelLoggingConfiguration | None = ...
The Amazon CloudWatch Logs configuration for the channel.
s3_destination_configuration
class-attribute
instance-attribute
¶
s3_destination_configuration: S3DestinationConfiguration | None = ...
The configuration for delivery to a general purpose Amazon S3 bucket.
Specify this parameter when S3TablesDestinationConfiguration is not
specified.
s3_tables_destination_configuration
class-attribute
instance-attribute
¶
s3_tables_destination_configuration: S3TablesDestinationConfiguration | None = ...
The configuration for delivery to streaming tables on Apache Iceberg in
Amazon S3 Tables. Specify this parameter when
S3DestinationConfiguration is not specified.
service_execution_role_arn
class-attribute
instance-attribute
¶
service_execution_role_arn: str | None = ...
The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.
stream_configuration_list
class-attribute
instance-attribute
¶
stream_configuration_list: list[ChannelStreamConfiguration] | None = ...
The source stream configuration for the channel. Currently, one stream is supported per channel.
Dictionaries¶
CreateChannelInputDict
¶
Bases: TypedDict
Dictionary form of CreateChannelInput.
Attributes¶
channel_name
instance-attribute
¶
The name of the channel. The name is unique within your Amazon Web Services account and Amazon Web Services Region.
encryption_configuration
instance-attribute
¶
encryption_configuration: ChannelEncryptionConfiguration | ChannelEncryptionConfigurationDict | None
The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.
logging_configuration
instance-attribute
¶
logging_configuration: ChannelLoggingConfiguration | ChannelLoggingConfigurationDict | None
The Amazon CloudWatch Logs configuration for the channel.
s3_destination_configuration
instance-attribute
¶
s3_destination_configuration: S3DestinationConfiguration | S3DestinationConfigurationDict | None
The configuration for delivery to a general purpose Amazon S3 bucket.
Specify this parameter when S3TablesDestinationConfiguration is not
specified.
s3_tables_destination_configuration
instance-attribute
¶
s3_tables_destination_configuration: S3TablesDestinationConfiguration | S3TablesDestinationConfigurationDict | None
The configuration for delivery to streaming tables on Apache Iceberg in
Amazon S3 Tables. Specify this parameter when
S3DestinationConfiguration is not specified.
service_execution_role_arn
instance-attribute
¶
The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.
stream_configuration_list
instance-attribute
¶
stream_configuration_list: Required[Sequence[ChannelStreamConfiguration | ChannelStreamConfigurationDict]]
The source stream configuration for the channel. Currently, one stream is supported per channel.
Output¶
CreateChannelOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateChannelOutput structure.
Attributes¶
channel_description
instance-attribute
¶
channel_description: ChannelDescription
The configuration and current status of the channel, including its ARN,
destination configuration, and lifecycle state. Immediately after
creation, the state is CREATING.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.