Skip to content

restart_connector 

restart_connector(
    connector_arn: __string,
    *,
    config_overrides: Optional[KafkaConnectClientConfig] = None,
    only_failed_tasks: Optional[__boolean] = None,
) -> RestartConnectorResponse

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.

Parameters:

  • connector_arn (__string) –

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

  • only_failed_tasks (Optional[__boolean], default: None ) –

    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.

Raises:

  • BadRequestException –

    HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.

  • ForbiddenException –

    HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.

  • InternalServerErrorException –

    HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

  • NotFoundException –

    HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.

  • ServiceUnavailableException –

    HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

  • TooManyRequestsException –

    HTTP Status Code 429: Limit exceeded. Resource limit reached.

  • UnauthorizedException –

    HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_kafkaconnect/_services/kafka_connect.py 
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
def restart_connector(
    self,
    connector_arn: "capo_kafkaconnect.types.__string.__string",
    *,
    config_overrides: Optional[KafkaConnectClientConfig] = None,
    only_failed_tasks: Optional[
        "capo_kafkaconnect.types.__boolean.__boolean"
    ] = None,
) -> "capo_kafkaconnect.types.restart_connector_response.RestartConnectorResponse":
    """<p>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 <code>DescribeConnectorOperation</code> to track the state of the restart.</p>

    Args:
        connector_arn: <p>The Amazon Resource Name (ARN) of the connector that you want to restart.</p>
        only_failed_tasks: <p>Specifies whether to restart only the connector's failed tasks. If <code>true</code>, the operation restarts only the tasks that are currently in a failed state, and healthy tasks continue running. If <code>false</code> or not specified, the operation restarts the connector and all of its tasks.</p>

    Raises:
        capo_kafkaconnect.errors.bad_request_exception.BadRequestException: <p>HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.</p>
        capo_kafkaconnect.errors.forbidden_exception.ForbiddenException: <p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.</p>
        capo_kafkaconnect.errors.internal_server_error_exception.InternalServerErrorException: <p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.</p>
        capo_kafkaconnect.errors.not_found_exception.NotFoundException: <p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.</p>
        capo_kafkaconnect.errors.service_unavailable_exception.ServiceUnavailableException: <p>HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.</p>
        capo_kafkaconnect.errors.too_many_requests_exception.TooManyRequestsException: <p>HTTP Status Code 429: Limit exceeded. Resource limit reached.</p>
        capo_kafkaconnect.errors.unauthorized_exception.UnauthorizedException: <p>HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.</p>
        capo_kafkaconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kafkaconnect.types.restart_connector_request.RestartConnectorRequest]",
    ) -> OperationResponse[
        "capo_kafkaconnect.types.restart_connector_response.RestartConnectorResponse"
    ]:
        import capo_kafkaconnect._operations.kafka_connect.restart_connector

        output, http_response = (
            capo_kafkaconnect._operations.kafka_connect.restart_connector.restart_connector(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RestartConnector")
    )
    input_: capo_kafkaconnect.types.restart_connector_request.RestartConnectorRequest = {
        "connector_arn": connector_arn
    }
    if only_failed_tasks is not None:
        input_["only_failed_tasks"] = only_failed_tasks

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output