update_channel¶
Operation¶
update_channel
async
¶
update_channel(request: UpdateChannelInput | UpdateChannelInputDict, /, *, plugins: list[Plugin] | None = None) -> UpdateChannelOutput
update_channel(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateChannelInputDict]) -> UpdateChannelOutput
Updates the data freshness interval or the Amazon CloudWatch Logs configuration of an existing channel. You cannot change the destination, source stream, record format, schema, encryption configuration, or service execution role of an existing channel. To change any other setting, delete the channel and create a new one.
Updating a channel is an asynchronous operation. Upon receiving the
request, Amazon Kinesis Data Streams sets the channel to the UPDATING
state and returns immediately. After the change is applied, Amazon
Kinesis Data Streams sets the channel back to the ACTIVE state.
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 |
|---|---|
UpdateChannelOutput
|
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¶
UpdateChannelInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateChannelInput structure.
Attributes¶
channel_arn
class-attribute
instance-attribute
¶
channel_arn: str | None = ...
The Amazon Resource Name (ARN) of the channel to update.
logging_configuration
class-attribute
instance-attribute
¶
logging_configuration: ChannelLoggingUpdateInput | None = ...
The updated Amazon CloudWatch Logs configuration for the channel.
s3_destination_configuration
class-attribute
instance-attribute
¶
s3_destination_configuration: S3DestinationUpdateInput | None = ...
The updated configuration for a general purpose Amazon S3 destination.
Specify this parameter when the channel delivers to a general purpose
Amazon S3 bucket. Only DataFreshnessInSeconds can be updated.
s3_tables_destination_configuration
class-attribute
instance-attribute
¶
s3_tables_destination_configuration: S3TablesDestinationUpdateInput | None = ...
The updated configuration for a streaming table destination. Specify
this parameter when the channel delivers to streaming tables on Apache
Iceberg in Amazon S3 Tables. Only DataFreshnessInSeconds can be
updated.
Dictionaries¶
UpdateChannelInputDict
¶
Bases: TypedDict
Dictionary form of UpdateChannelInput.
Attributes¶
channel_arn
instance-attribute
¶
The Amazon Resource Name (ARN) of the channel to update.
logging_configuration
instance-attribute
¶
logging_configuration: ChannelLoggingUpdateInput | ChannelLoggingUpdateInputDict | None
The updated Amazon CloudWatch Logs configuration for the channel.
s3_destination_configuration
instance-attribute
¶
s3_destination_configuration: S3DestinationUpdateInput | S3DestinationUpdateInputDict | None
The updated configuration for a general purpose Amazon S3 destination.
Specify this parameter when the channel delivers to a general purpose
Amazon S3 bucket. Only DataFreshnessInSeconds can be updated.
s3_tables_destination_configuration
instance-attribute
¶
s3_tables_destination_configuration: S3TablesDestinationUpdateInput | S3TablesDestinationUpdateInputDict | None
The updated configuration for a streaming table destination. Specify
this parameter when the channel delivers to streaming tables on Apache
Iceberg in Amazon S3 Tables. Only DataFreshnessInSeconds can be
updated.
Output¶
UpdateChannelOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateChannelOutput structure.
Attributes¶
channel_description
instance-attribute
¶
channel_description: ChannelDescription
The configuration and current status of the channel after the update,
including its ARN, destination configuration, and lifecycle state.
Immediately after the request, the state is UPDATING.
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.