KafkaConnect / Client / describe_connector_operation

describe_connector_operation#

KafkaConnect.Client.describe_connector_operation(**kwargs)#

Returns information about the specified connector’s operations.

See also: AWS API Documentation

Request Syntax

response = client.describe_connector_operation(
    connectorOperationArn='string'
)
Parameters:

connectorOperationArn (string) –

[REQUIRED]

ARN of the connector operation to be described.

Return type:

dict

Returns:

Response Syntax

{
    'connectorArn': 'string',
    'connectorOperationArn': 'string',
    'connectorOperationState': 'PENDING'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_FAILED'|'ROLLBACK_COMPLETE',
    'connectorOperationType': 'UPDATE_WORKER_SETTING'|'UPDATE_CONNECTOR_CONFIGURATION'|'ISOLATE_CONNECTOR'|'RESTORE_CONNECTOR',
    'operationSteps': [
        {
            'stepType': 'INITIALIZE_UPDATE'|'FINALIZE_UPDATE'|'UPDATE_WORKER_SETTING'|'UPDATE_CONNECTOR_CONFIGURATION'|'VALIDATE_UPDATE',
            'stepState': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELLED'
        },
    ],
    'originWorkerSetting': {
        'capacity': {
            'autoScaling': {
                'maxWorkerCount': 123,
                'mcuCount': 123,
                'minWorkerCount': 123,
                'scaleInPolicy': {
                    'cpuUtilizationPercentage': 123
                },
                'scaleOutPolicy': {
                    'cpuUtilizationPercentage': 123
                }
            },
            'provisionedCapacity': {
                'mcuCount': 123,
                'workerCount': 123
            }
        }
    },
    'originConnectorConfiguration': {
        'string': 'string'
    },
    'targetWorkerSetting': {
        'capacity': {
            'autoScaling': {
                'maxWorkerCount': 123,
                'mcuCount': 123,
                'minWorkerCount': 123,
                'scaleInPolicy': {
                    'cpuUtilizationPercentage': 123
                },
                'scaleOutPolicy': {
                    'cpuUtilizationPercentage': 123
                }
            },
            'provisionedCapacity': {
                'mcuCount': 123,
                'workerCount': 123
            }
        }
    },
    'targetConnectorConfiguration': {
        'string': 'string'
    },
    'errorInfo': {
        'code': 'string',
        'message': 'string'
    },
    'creationTime': datetime(2015, 1, 1),
    'endTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • connectorArn (string) –

      The Amazon Resource Name (ARN) of the connector.

    • connectorOperationArn (string) –

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

    • connectorOperationState (string) –

      The state of the connector operation.

    • connectorOperationType (string) –

      The type of connector operation performed.

    • operationSteps (list) –

      The array of operation steps taken.

      • (dict) –

        Details of a step that is involved in a connector’s operation.

        • stepType (string) –

          The step type of the operation.

        • stepState (string) –

          The step state of the operation.

    • originWorkerSetting (dict) –

      The origin worker setting.

      • capacity (dict) –

        A description of the connector’s capacity.

        • autoScaling (dict) –

          Describes the connector’s auto scaling capacity.

          • maxWorkerCount (integer) –

            The maximum number of workers allocated to the connector.

          • mcuCount (integer) –

            The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

          • minWorkerCount (integer) –

            The minimum number of workers allocated to the connector.

          • scaleInPolicy (dict) –

            The sacle-in policy for the connector.

            • cpuUtilizationPercentage (integer) –

              Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

          • scaleOutPolicy (dict) –

            The sacle-out policy for the connector.>

            • cpuUtilizationPercentage (integer) –

              The CPU utilization percentage threshold at which you want connector scale out to be triggered.

        • provisionedCapacity (dict) –

          Describes a connector’s provisioned capacity.

          • mcuCount (integer) –

            The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

          • workerCount (integer) –

            The number of workers that are allocated to the connector.

    • originConnectorConfiguration (dict) –

      The origin connector configuration.

      • (string) –

        • (string) –

    • targetWorkerSetting (dict) –

      The target worker setting.

      • capacity (dict) –

        A description of the connector’s capacity.

        • autoScaling (dict) –

          Describes the connector’s auto scaling capacity.

          • maxWorkerCount (integer) –

            The maximum number of workers allocated to the connector.

          • mcuCount (integer) –

            The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

          • minWorkerCount (integer) –

            The minimum number of workers allocated to the connector.

          • scaleInPolicy (dict) –

            The sacle-in policy for the connector.

            • cpuUtilizationPercentage (integer) –

              Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

          • scaleOutPolicy (dict) –

            The sacle-out policy for the connector.>

            • cpuUtilizationPercentage (integer) –

              The CPU utilization percentage threshold at which you want connector scale out to be triggered.

        • provisionedCapacity (dict) –

          Describes a connector’s provisioned capacity.

          • mcuCount (integer) –

            The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

          • workerCount (integer) –

            The number of workers that are allocated to the connector.

    • targetConnectorConfiguration (dict) –

      The target connector configuration.

      • (string) –

        • (string) –

    • errorInfo (dict) –

      Details about the state of a resource.

      • code (string) –

        A code that describes the state of a resource.

      • message (string) –

        A message that describes the state of a resource.

    • creationTime (datetime) –

      The time when the operation was created.

    • endTime (datetime) –

      The time when the operation ended.

Exceptions