Kafka / Client / update_topic

update_topic

Kafka.Client.update_topic(**kwargs)

Updates the configuration of the specified topic.

See also: AWS API Documentation

Request Syntax

response = client.update_topic(
    ClusterArn='string',
    TopicName='string',
    Configs='string',
    PartitionCount=123
)

Parameters:

• ClusterArn (string) –

  [REQUIRED]

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

• TopicName (string) –

  [REQUIRED]

  The name of the topic to update configuration for.

• Configs (string) – The new topic configurations encoded as a Base64 string.

• PartitionCount (integer) – The new total number of partitions for the topic.

Return type:

dict

Returns:

Response Syntax

{
    'TopicArn': 'string',
    'TopicName': 'string',
    'Status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'
}

Response Structure

• (dict) –

  200 response

  • TopicArn (string) –

    The Amazon Resource Name (ARN) of the topic.

  • TopicName (string) –

    The name of the topic whose configuration was updated.

  • Status (string) –

    The status of the topic update.

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.ClusterConnectivityException

• Kafka.Client.exceptions.KafkaTimeoutException

• Kafka.Client.exceptions.UnknownTopicOrPartitionException

• Kafka.Client.exceptions.ControllerMovedException

• Kafka.Client.exceptions.NotControllerException

• Kafka.Client.exceptions.ReassignmentInProgressException

• Kafka.Client.exceptions.GroupSubscribedToTopicException

• Kafka.Client.exceptions.KafkaRequestException