updateChannel

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.

Samples

// To update a channel
val resp = kinesisClient.updateChannel {
    channelArn = "arn:aws:kinesis:us-east-1:123456789012:channel/my-channel-id"
    s3DestinationConfiguration = S3DestinationUpdateInput {
        dataFreshnessInSeconds = 600
    }
    loggingConfiguration = ChannelLoggingUpdateInput {
        cloudWatchLogs = CloudWatchLogsUpdateInput {
            enabled = true
            logGroupName = "/aws/kinesis/my-channel"
            logStreamName = "my-channel-log-stream"
        }
    }
}