connector_operations

Creates, updates, deletes, gets or lists a connector_operations resource.

Overview

Name	connector_operations
Type	Resource
Id	aws.kafkaconnect.connector_operations

Fields

The following fields are returned by SELECT queries:

describe_connector_operation

Name	Datatype	Description
connector_arn	string	The Amazon Resource Name (ARN) of the connector.
connector_operation_arn	string	The Amazon Resource Name (ARN) of the connector operation.
connector_operation_state	string	The state of the connector operation. (PENDING, UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE)
connector_operation_type	string	The type of connector operation performed. (UPDATE_WORKER_SETTING, UPDATE_CONNECTOR_CONFIGURATION, ISOLATE_CONNECTOR, RESTORE_CONNECTOR)
creation_time	string (date-time)	The time when the operation was created.
end_time	string (date-time)	The time when the operation ended.
error_info	object	Details about the state of a resource.
operation_steps	array	The array of operation steps taken.
origin_connector_configuration	object	The origin connector configuration.
origin_worker_setting	object	The origin worker setting.
target_connector_configuration	object	The target connector configuration.
target_worker_setting	object	The target worker setting.

list_connector_operations

Name	Datatype	Description
connector_operation_arn	string	The Amazon Resource Name (ARN) of the connector operation.
connector_operation_state	string	The state of the connector operation. (PENDING, UPDATE_IN_PROGRESS, UPDATE_COMPLETE, UPDATE_FAILED, ROLLBACK_IN_PROGRESS, ROLLBACK_FAILED, ROLLBACK_COMPLETE)
connector_operation_type	string	The type of connector operation performed. (UPDATE_WORKER_SETTING, UPDATE_CONNECTOR_CONFIGURATION, ISOLATE_CONNECTOR, RESTORE_CONNECTOR)
creation_time	string (date-time)	The time when operation was created.
end_time	string (date-time)	The time when operation ended.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_connector_operation	select	connector_operation_arn, region		Returns information about the specified connector's operations.
list_connector_operations	select	connector_arn, region	maxResults, nextToken	Lists information about a connector's operation(s).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connector_arn	string	The Amazon Resource Name (ARN) of the connector for which to list operations.
connector_operation_arn	string	ARN of the connector operation to be described.
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of connector operations to fetch in one get request.
nextToken	string	If the response is truncated, it includes a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

SELECT examples

describe_connector_operation

Returns information about the specified connector's operations.

SELECT
connector_arn,
connector_operation_arn,
connector_operation_state,
connector_operation_type,
creation_time,
end_time,
error_info,
operation_steps,
origin_connector_configuration,
origin_worker_setting,
target_connector_configuration,
target_worker_setting
FROM aws.kafkaconnect.connector_operations
WHERE connector_operation_arn = '{{ connector_operation_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_connector_operations

Lists information about a connector's operation(s).

SELECT
connector_operation_arn,
connector_operation_state,
connector_operation_type,
creation_time,
end_time
FROM aws.kafkaconnect.connector_operations
WHERE connector_arn = '{{ connector_arn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;