KafkaConnect / Client / restart_connector

restart_connector

KafkaConnect.Client.restart_connector(**kwargs)

Restarts the specified connector. By default, this operation restarts the connector and all of its tasks. This operation is asynchronous and returns a connector operation ARN that you can pass to DescribeConnectorOperation to track the state of the restart.

See also: AWS API Documentation

Request Syntax

response = client.restart_connector(
    connectorArn='string',
    onlyFailedTasks=True|False
)
Parameters:

  • connectorArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the connector that you want to restart.

  • onlyFailedTasks (boolean) – Specifies whether to restart only the connector’s failed tasks. If true, the operation restarts only the tasks that are currently in a failed state, and healthy tasks continue running. If false or not specified, the operation restarts the connector and all of its tasks.

Return type:

dict

Returns:

Response Syntax

{
    'connectorArn': 'string',
    'connectorOperationArn': 'string'
}

Response Structure

  • (dict) –

    • connectorArn (string) –

      The Amazon Resource Name (ARN) of the connector.

    • connectorOperationArn (string) –

      The Amazon Resource Name (ARN) of the connector operation created to perform the restart.

Exceptions