Kafka / Client / update_channel

update_channel

Kafka.Client.update_channel(**kwargs)

Updates the destination configuration of an existing channel. Exactly one of icebergDestinationUpdate or s3DestinationUpdate must be supplied.

See also: AWS API Documentation

Request Syntax

response = client.update_channel(
    ChannelArn='string',
    ClusterArn='string',
    IcebergDestinationUpdate={
        'DataFreshnessInSeconds': 123
    },
    S3DestinationUpdate={
        'DataFreshnessInSeconds': 123
    }
)

Parameters:

• ChannelArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) that uniquely identifies the channel.

• ClusterArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) that uniquely identifies the cluster.

• IcebergDestinationUpdate (dict) –

  Updates fields on an Apache Iceberg destination. Use only when the channel was created with an Iceberg destination.

  • DataFreshnessInSeconds (integer) – [REQUIRED]

    The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

• S3DestinationUpdate (dict) –

  Updates fields on an Amazon S3 destination. Use only when the channel was created with an Amazon S3 destination.

  • DataFreshnessInSeconds (integer) – [REQUIRED]

    The maximum time, in seconds, that records buffer in MSK before being flushed to the destination. Allowed range: 300 to 900.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelArn': 'string',
    'ClusterOperationArn': 'string'
}

Response Structure

• (dict) –

  Returns the channel ARN and the cluster-operation ARN that tracks the asynchronous update.

  • ChannelArn (string) –

    The Amazon Resource Name (ARN) that uniquely identifies the channel.

  • ClusterOperationArn (string) –

    The Amazon Resource Name (ARN) of the cluster operation.

Exceptions

• Kafka.Client.exceptions.BadRequestException

• Kafka.Client.exceptions.UnauthorizedException

• Kafka.Client.exceptions.InternalServerErrorException

• Kafka.Client.exceptions.ForbiddenException

• Kafka.Client.exceptions.NotFoundException

• Kafka.Client.exceptions.ServiceUnavailableException

• Kafka.Client.exceptions.TooManyRequestsException