AWS SDK for PHP 3.x

Client: Aws\KafkaConnect\KafkaConnectClient

Service ID: kafkaconnect

Version: 2021-09-14

This page describes the parameters and results for the operations of the Managed Streaming for Kafka Connect (2021-09-14), and shows how to use the Aws\KafkaConnect\KafkaConnectClient object to call the described operations. This documentation is specific to the 2021-09-14 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateConnector ( array $params = [] ): Creates a connector using the specified properties.
CreateCustomPlugin ( array $params = [] ): Creates a custom plugin using the specified properties.
CreateWorkerConfiguration ( array $params = [] ): Creates a worker configuration using the specified properties.
DeleteConnector ( array $params = [] ): Deletes the specified connector.
DeleteCustomPlugin ( array $params = [] ): Deletes a custom plugin.
DeleteWorkerConfiguration ( array $params = [] ): Deletes the specified worker configuration.
DescribeConnector ( array $params = [] ): Returns summary information about the connector.
DescribeConnectorOperation ( array $params = [] ): Returns information about the specified connector's operations.
DescribeCustomPlugin ( array $params = [] ): A summary description of the custom plugin.
DescribeWorkerConfiguration ( array $params = [] ): Returns information about a worker configuration.
ListConnectorOperations ( array $params = [] ): Lists information about a connector's operation(s).
ListConnectors ( array $params = [] ): Returns a list of all the connectors in this account and Region.
ListCustomPlugins ( array $params = [] ): Returns a list of all of the custom plugins in this account and Region.
ListTagsForResource ( array $params = [] ): Lists all the tags attached to the specified resource.
ListWorkerConfigurations ( array $params = [] ): Returns a list of all of the worker configurations in this account and Region.
TagResource ( array $params = [] ): Attaches tags to the specified resource.
UntagResource ( array $params = [] ): Removes tags from the specified resource.
UpdateConnector ( array $params = [] ): Updates the specified connector.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListConnectorOperations
ListConnectors
ListCustomPlugins
ListWorkerConfigurations

Operations

CreateConnector

$result = $client->createConnector([/* ... */]);
$promise = $client->createConnectorAsync([/* ... */]);

Creates a connector using the specified properties.

Parameter Syntax

$result = $client->createConnector([
    'capacity' => [ // REQUIRED
        'autoScaling' => [
            'maxWorkerCount' => <integer>, // REQUIRED
            'mcuCount' => <integer>, // REQUIRED
            'minWorkerCount' => <integer>, // REQUIRED
            'scaleInPolicy' => [
                'cpuUtilizationPercentage' => <integer>, // REQUIRED
            ],
            'scaleOutPolicy' => [
                'cpuUtilizationPercentage' => <integer>, // REQUIRED
            ],
        ],
        'provisionedCapacity' => [
            'mcuCount' => <integer>, // REQUIRED
            'workerCount' => <integer>, // REQUIRED
        ],
    ],
    'connectorConfiguration' => ['<string>', ...], // REQUIRED
    'connectorDescription' => '<string>',
    'connectorName' => '<string>', // REQUIRED
    'kafkaCluster' => [ // REQUIRED
        'apacheKafkaCluster' => [ // REQUIRED
            'bootstrapServers' => '<string>', // REQUIRED
            'vpc' => [ // REQUIRED
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...], // REQUIRED
            ],
        ],
    ],
    'kafkaClusterClientAuthentication' => [ // REQUIRED
        'authenticationType' => 'NONE|IAM', // REQUIRED
    ],
    'kafkaClusterEncryptionInTransit' => [ // REQUIRED
        'encryptionType' => 'PLAINTEXT|TLS', // REQUIRED
    ],
    'kafkaConnectVersion' => '<string>', // REQUIRED
    'logDelivery' => [
        'workerLogDelivery' => [ // REQUIRED
            'cloudWatchLogs' => [
                'enabled' => true || false, // REQUIRED
                'logGroup' => '<string>',
            ],
            'firehose' => [
                'deliveryStream' => '<string>',
                'enabled' => true || false, // REQUIRED
            ],
            's3' => [
                'bucket' => '<string>',
                'enabled' => true || false, // REQUIRED
                'prefix' => '<string>',
            ],
        ],
    ],
    'plugins' => [ // REQUIRED
        [
            'customPlugin' => [ // REQUIRED
                'customPluginArn' => '<string>', // REQUIRED
                'revision' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'serviceExecutionRoleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'workerConfiguration' => [
        'revision' => <integer>, // REQUIRED
        'workerConfigurationArn' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

capacity

: Required: Yes
: Type: Capacity structure

Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.

connectorConfiguration

: Required: Yes
: Type: Associative array of custom strings keys (__string) to strings

A map of keys to values that represent the configuration for the connector.

connectorDescription

: Type: string

A summary description of the connector.

connectorName

: Required: Yes
: Type: string

The name of the connector.

kafkaCluster

: Required: Yes
: Type: KafkaCluster structure

Specifies which Apache Kafka cluster to connect to.

kafkaClusterClientAuthentication

: Required: Yes
: Type: KafkaClusterClientAuthentication structure

Details of the client authentication used by the Apache Kafka cluster.

kafkaClusterEncryptionInTransit

: Required: Yes
: Type: KafkaClusterEncryptionInTransit structure

Details of encryption in transit to the Apache Kafka cluster.

kafkaConnectVersion

: Required: Yes
: Type: string

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

logDelivery

: Type: LogDelivery structure

Details about log delivery.

plugins

: Required: Yes
: Type: Array of Plugin structures

Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together.

Specifies which plugin to use for the connector. You must specify a single-element list containing one customPlugin object.

serviceExecutionRoleArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags you want to attach to the connector.

workerConfiguration

: Type: WorkerConfiguration structure

Specifies which worker configuration to use with the connector.

Result Syntax

[
    'connectorArn' => '<string>',
    'connectorName' => '<string>',
    'connectorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
]

Result Details

Members

connectorArn

: Type: string

The Amazon Resource Name (ARN) that Amazon assigned to the connector.

connectorName

: Type: string

The name of the connector.

connectorState

: Type: string

The state of the connector.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
ConflictException:: HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

CreateCustomPlugin

$result = $client->createCustomPlugin([/* ... */]);
$promise = $client->createCustomPluginAsync([/* ... */]);

Creates a custom plugin using the specified properties.

Parameter Syntax

$result = $client->createCustomPlugin([
    'contentType' => 'JAR|ZIP', // REQUIRED
    'description' => '<string>',
    'location' => [ // REQUIRED
        's3Location' => [ // REQUIRED
            'bucketArn' => '<string>', // REQUIRED
            'fileKey' => '<string>', // REQUIRED
            'objectVersion' => '<string>',
        ],
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

contentType

: Required: Yes
: Type: string

The type of the plugin file.

description

: Type: string

A summary description of the custom plugin.

location

: Required: Yes
: Type: CustomPluginLocation structure

Information about the location of a custom plugin.

name

: Required: Yes
: Type: string

The name of the custom plugin.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags you want to attach to the custom plugin.

Result Syntax

[
    'customPluginArn' => '<string>',
    'customPluginState' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATE_FAILED|DELETING',
    'name' => '<string>',
    'revision' => <integer>,
]

Result Details

Members

customPluginArn

: Type: string

The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin.

customPluginState

: Type: string

The state of the custom plugin.

name

: Type: string

The name of the custom plugin.

revision

: Type: long (int|float)

The revision of the custom plugin.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
ConflictException:: HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

CreateWorkerConfiguration

$result = $client->createWorkerConfiguration([/* ... */]);
$promise = $client->createWorkerConfigurationAsync([/* ... */]);

Creates a worker configuration using the specified properties.

Parameter Syntax

$result = $client->createWorkerConfiguration([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'propertiesFileContent' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members

description

: Type: string

A summary description of the worker configuration.

name

: Required: Yes
: Type: string

The name of the worker configuration.

propertiesFileContent

: Required: Yes
: Type: string

Base64 encoded contents of connect-distributed.properties file.

tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags you want to attach to the worker configuration.

Result Syntax

[
    'creationTime' => <DateTime>,
    'latestRevision' => [
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'revision' => <integer>,
    ],
    'name' => '<string>',
    'workerConfigurationArn' => '<string>',
    'workerConfigurationState' => 'ACTIVE|DELETING',
]

Result Details

Members

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the worker configuration was created.

latestRevision

: Type: WorkerConfigurationRevisionSummary structure

The latest revision of the worker configuration.

name

: Type: string

The name of the worker configuration.

workerConfigurationArn

: Type: string

The Amazon Resource Name (ARN) that Amazon assigned to the worker configuration.

workerConfigurationState

: Type: string

The state of the worker configuration.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
ConflictException:: HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

DeleteConnector

$result = $client->deleteConnector([/* ... */]);
$promise = $client->deleteConnectorAsync([/* ... */]);

Deletes the specified connector.

Parameter Syntax

$result = $client->deleteConnector([
    'connectorArn' => '<string>', // REQUIRED
    'currentVersion' => '<string>',
]);

Parameter Details

Members

connectorArn

: Required: Yes
: Type: string

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

currentVersion

: Type: string

The current version of the connector that you want to delete.

Result Syntax

[
    'connectorArn' => '<string>',
    'connectorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
]

Result Details

Members

connectorArn

: Type: string

The Amazon Resource Name (ARN) of the connector that you requested to delete.

connectorState

: Type: string

The state of the connector that you requested to delete.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

DeleteCustomPlugin

$result = $client->deleteCustomPlugin([/* ... */]);
$promise = $client->deleteCustomPluginAsync([/* ... */]);

Deletes a custom plugin.

Parameter Syntax

$result = $client->deleteCustomPlugin([
    'customPluginArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

customPluginArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the custom plugin that you want to delete.

Result Syntax

[
    'customPluginArn' => '<string>',
    'customPluginState' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATE_FAILED|DELETING',
]

Result Details

Members

customPluginArn

: Type: string

The Amazon Resource Name (ARN) of the custom plugin that you requested to delete.

customPluginState

: Type: string

The state of the custom plugin.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

DeleteWorkerConfiguration

$result = $client->deleteWorkerConfiguration([/* ... */]);
$promise = $client->deleteWorkerConfigurationAsync([/* ... */]);

Deletes the specified worker configuration.

Parameter Syntax

$result = $client->deleteWorkerConfiguration([
    'workerConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

workerConfigurationArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the worker configuration that you want to delete.

Result Syntax

[
    'workerConfigurationArn' => '<string>',
    'workerConfigurationState' => 'ACTIVE|DELETING',
]

Result Details

Members

workerConfigurationArn

: Type: string

The Amazon Resource Name (ARN) of the worker configuration that you requested to delete.

workerConfigurationState

: Type: string

The state of the worker configuration.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

DescribeConnector

$result = $client->describeConnector([/* ... */]);
$promise = $client->describeConnectorAsync([/* ... */]);

Returns summary information about the connector.

Parameter Syntax

$result = $client->describeConnector([
    'connectorArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

connectorArn

: Required: Yes
: Type: string

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

Result Syntax

[
    'capacity' => [
        'autoScaling' => [
            'maxWorkerCount' => <integer>,
            'mcuCount' => <integer>,
            'minWorkerCount' => <integer>,
            'scaleInPolicy' => [
                'cpuUtilizationPercentage' => <integer>,
            ],
            'scaleOutPolicy' => [
                'cpuUtilizationPercentage' => <integer>,
            ],
        ],
        'provisionedCapacity' => [
            'mcuCount' => <integer>,
            'workerCount' => <integer>,
        ],
    ],
    'connectorArn' => '<string>',
    'connectorConfiguration' => ['<string>', ...],
    'connectorDescription' => '<string>',
    'connectorName' => '<string>',
    'connectorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
    'creationTime' => <DateTime>,
    'currentVersion' => '<string>',
    'kafkaCluster' => [
        'apacheKafkaCluster' => [
            'bootstrapServers' => '<string>',
            'vpc' => [
                'securityGroups' => ['<string>', ...],
                'subnets' => ['<string>', ...],
            ],
        ],
    ],
    'kafkaClusterClientAuthentication' => [
        'authenticationType' => 'NONE|IAM',
    ],
    'kafkaClusterEncryptionInTransit' => [
        'encryptionType' => 'PLAINTEXT|TLS',
    ],
    'kafkaConnectVersion' => '<string>',
    'logDelivery' => [
        'workerLogDelivery' => [
            'cloudWatchLogs' => [
                'enabled' => true || false,
                'logGroup' => '<string>',
            ],
            'firehose' => [
                'deliveryStream' => '<string>',
                'enabled' => true || false,
            ],
            's3' => [
                'bucket' => '<string>',
                'enabled' => true || false,
                'prefix' => '<string>',
            ],
        ],
    ],
    'plugins' => [
        [
            'customPlugin' => [
                'customPluginArn' => '<string>',
                'revision' => <integer>,
            ],
        ],
        // ...
    ],
    'serviceExecutionRoleArn' => '<string>',
    'stateDescription' => [
        'code' => '<string>',
        'message' => '<string>',
    ],
    'workerConfiguration' => [
        'revision' => <integer>,
        'workerConfigurationArn' => '<string>',
    ],
]

Result Details

Members

capacity

: Type: CapacityDescription structure

Information about the capacity of the connector, whether it is auto scaled or provisioned.

connectorArn

: Type: string

The Amazon Resource Name (ARN) of the connector.

connectorConfiguration

: Type: Associative array of custom strings keys (__string) to strings

A map of keys to values that represent the configuration for the connector.

connectorDescription

: Type: string

A summary description of the connector.

connectorName

: Type: string

The name of the connector.

connectorState

: Type: string

The state of the connector.

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the connector was created.

currentVersion

: Type: string

The current version of the connector.

kafkaCluster

: Type: KafkaClusterDescription structure

The Apache Kafka cluster that the connector is connected to.

kafkaClusterClientAuthentication

: Type: KafkaClusterClientAuthenticationDescription structure

The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

kafkaClusterEncryptionInTransit

: Type: KafkaClusterEncryptionInTransitDescription structure

Details of encryption in transit to the Apache Kafka cluster.

kafkaConnectVersion

: Type: string

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

logDelivery

: Type: LogDeliveryDescription structure

Details about delivering logs to Amazon CloudWatch Logs.

plugins

: Type: Array of PluginDescription structures

Specifies which plugins were used for this connector.

serviceExecutionRoleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

stateDescription

: Type: StateDescription structure

Details about the state of a connector.

workerConfiguration

: Type: WorkerConfigurationDescription structure

Specifies which worker configuration was used for the connector.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

DescribeConnectorOperation

$result = $client->describeConnectorOperation([/* ... */]);
$promise = $client->describeConnectorOperationAsync([/* ... */]);

Returns information about the specified connector's operations.

Parameter Syntax

$result = $client->describeConnectorOperation([
    'connectorOperationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

connectorOperationArn

: Required: Yes
: Type: string

ARN of the connector operation to be described.

Result 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',
    'creationTime' => <DateTime>,
    'endTime' => <DateTime>,
    'errorInfo' => [
        'code' => '<string>',
        'message' => '<string>',
    ],
    'operationSteps' => [
        [
            'stepState' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED|CANCELLED',
            'stepType' => 'INITIALIZE_UPDATE|FINALIZE_UPDATE|UPDATE_WORKER_SETTING|UPDATE_CONNECTOR_CONFIGURATION|VALIDATE_UPDATE',
        ],
        // ...
    ],
    'originConnectorConfiguration' => ['<string>', ...],
    'originWorkerSetting' => [
        'capacity' => [
            'autoScaling' => [
                'maxWorkerCount' => <integer>,
                'mcuCount' => <integer>,
                'minWorkerCount' => <integer>,
                'scaleInPolicy' => [
                    'cpuUtilizationPercentage' => <integer>,
                ],
                'scaleOutPolicy' => [
                    'cpuUtilizationPercentage' => <integer>,
                ],
            ],
            'provisionedCapacity' => [
                'mcuCount' => <integer>,
                'workerCount' => <integer>,
            ],
        ],
    ],
    'targetConnectorConfiguration' => ['<string>', ...],
    'targetWorkerSetting' => [
        'capacity' => [
            'autoScaling' => [
                'maxWorkerCount' => <integer>,
                'mcuCount' => <integer>,
                'minWorkerCount' => <integer>,
                'scaleInPolicy' => [
                    'cpuUtilizationPercentage' => <integer>,
                ],
                'scaleOutPolicy' => [
                    'cpuUtilizationPercentage' => <integer>,
                ],
            ],
            'provisionedCapacity' => [
                'mcuCount' => <integer>,
                'workerCount' => <integer>,
            ],
        ],
    ],
]

Result Details

Members

connectorArn

: Type: string

The Amazon Resource Name (ARN) of the connector.

connectorOperationArn

: Type: string

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

connectorOperationState

: Type: string

The state of the connector operation.

connectorOperationType

: Type: string

The type of connector operation performed.

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the operation was created.

endTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the operation ended.

errorInfo

: Type: StateDescription structure

Details about the state of a resource.

operationSteps

: Type: Array of ConnectorOperationStep structures

The array of operation steps taken.

originConnectorConfiguration

: Type: Associative array of custom strings keys (__string) to strings

The origin connector configuration.

originWorkerSetting

: Type: WorkerSetting structure

The origin worker setting.

targetConnectorConfiguration

: Type: Associative array of custom strings keys (__string) to strings

The target connector configuration.

targetWorkerSetting

: Type: WorkerSetting structure

The target worker setting.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

DescribeCustomPlugin

$result = $client->describeCustomPlugin([/* ... */]);
$promise = $client->describeCustomPluginAsync([/* ... */]);

A summary description of the custom plugin.

Parameter Syntax

$result = $client->describeCustomPlugin([
    'customPluginArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

customPluginArn

: Required: Yes
: Type: string

Returns information about a custom plugin.

Result Syntax

[
    'creationTime' => <DateTime>,
    'customPluginArn' => '<string>',
    'customPluginState' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATE_FAILED|DELETING',
    'description' => '<string>',
    'latestRevision' => [
        'contentType' => 'JAR|ZIP',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'fileDescription' => [
            'fileMd5' => '<string>',
            'fileSize' => <integer>,
        ],
        'location' => [
            's3Location' => [
                'bucketArn' => '<string>',
                'fileKey' => '<string>',
                'objectVersion' => '<string>',
            ],
        ],
        'revision' => <integer>,
    ],
    'name' => '<string>',
    'stateDescription' => [
        'code' => '<string>',
        'message' => '<string>',
    ],
]

Result Details

Members

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the custom plugin was created.

customPluginArn

: Type: string

The Amazon Resource Name (ARN) of the custom plugin.

customPluginState

: Type: string

The state of the custom plugin.

description

: Type: string

The description of the custom plugin.

latestRevision

: Type: CustomPluginRevisionSummary structure

The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.

name

: Type: string

The name of the custom plugin.

stateDescription

: Type: StateDescription structure

Details about the state of a custom plugin.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

DescribeWorkerConfiguration

$result = $client->describeWorkerConfiguration([/* ... */]);
$promise = $client->describeWorkerConfigurationAsync([/* ... */]);

Returns information about a worker configuration.

Parameter Syntax

$result = $client->describeWorkerConfiguration([
    'workerConfigurationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

workerConfigurationArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.

Result Syntax

[
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'latestRevision' => [
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'propertiesFileContent' => '<string>',
        'revision' => <integer>,
    ],
    'name' => '<string>',
    'workerConfigurationArn' => '<string>',
    'workerConfigurationState' => 'ACTIVE|DELETING',
]

Result Details

Members

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the worker configuration was created.

description

: Type: string

The description of the worker configuration.

latestRevision

: Type: WorkerConfigurationRevisionDescription structure

The latest revision of the custom configuration.

name

: Type: string

The name of the worker configuration.

workerConfigurationArn

: Type: string

The Amazon Resource Name (ARN) of the custom configuration.

workerConfigurationState

: Type: string

The state of the worker configuration.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

ListConnectorOperations

$result = $client->listConnectorOperations([/* ... */]);
$promise = $client->listConnectorOperationsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listConnectorOperations([
    'connectorArn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

connectorArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the connector for which to list operations.

maxResults

: Type: int

Maximum number of connector operations to fetch in one get request.

nextToken

: Type: 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.

Result Syntax

[
    'connectorOperations' => [
        [
            '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',
            'creationTime' => <DateTime>,
            'endTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

connectorOperations

: Type: Array of ConnectorOperationSummary structures

An array of connector operation descriptions.

nextToken

: Type: 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.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

ListConnectors

$result = $client->listConnectors([/* ... */]);
$promise = $client->listConnectorsAsync([/* ... */]);

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

Parameter Syntax

$result = $client->listConnectors([
    'connectorNamePrefix' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members

connectorNamePrefix

: Type: string

The name prefix that you want to use to search for and list connectors.

maxResults

: Type: int

The maximum number of connectors to list in one response.

nextToken

: Type: string

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Result Syntax

[
    'connectors' => [
        [
            'capacity' => [
                'autoScaling' => [
                    'maxWorkerCount' => <integer>,
                    'mcuCount' => <integer>,
                    'minWorkerCount' => <integer>,
                    'scaleInPolicy' => [
                        'cpuUtilizationPercentage' => <integer>,
                    ],
                    'scaleOutPolicy' => [
                        'cpuUtilizationPercentage' => <integer>,
                    ],
                ],
                'provisionedCapacity' => [
                    'mcuCount' => <integer>,
                    'workerCount' => <integer>,
                ],
            ],
            'connectorArn' => '<string>',
            'connectorDescription' => '<string>',
            'connectorName' => '<string>',
            'connectorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
            'creationTime' => <DateTime>,
            'currentVersion' => '<string>',
            'kafkaCluster' => [
                'apacheKafkaCluster' => [
                    'bootstrapServers' => '<string>',
                    'vpc' => [
                        'securityGroups' => ['<string>', ...],
                        'subnets' => ['<string>', ...],
                    ],
                ],
            ],
            'kafkaClusterClientAuthentication' => [
                'authenticationType' => 'NONE|IAM',
            ],
            'kafkaClusterEncryptionInTransit' => [
                'encryptionType' => 'PLAINTEXT|TLS',
            ],
            'kafkaConnectVersion' => '<string>',
            'logDelivery' => [
                'workerLogDelivery' => [
                    'cloudWatchLogs' => [
                        'enabled' => true || false,
                        'logGroup' => '<string>',
                    ],
                    'firehose' => [
                        'deliveryStream' => '<string>',
                        'enabled' => true || false,
                    ],
                    's3' => [
                        'bucket' => '<string>',
                        'enabled' => true || false,
                        'prefix' => '<string>',
                    ],
                ],
            ],
            'plugins' => [
                [
                    'customPlugin' => [
                        'customPluginArn' => '<string>',
                        'revision' => <integer>,
                    ],
                ],
                // ...
            ],
            'serviceExecutionRoleArn' => '<string>',
            'workerConfiguration' => [
                'revision' => <integer>,
                'workerConfigurationArn' => '<string>',
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

connectors

: Type: Array of ConnectorSummary structures

An array of connector descriptions.

nextToken

: Type: string

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

ListCustomPlugins

$result = $client->listCustomPlugins([/* ... */]);
$promise = $client->listCustomPluginsAsync([/* ... */]);

Returns a list of all of the custom plugins in this account and Region.

Parameter Syntax

$result = $client->listCustomPlugins([
    'maxResults' => <integer>,
    'namePrefix' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of custom plugins to list in one response.

namePrefix

: Type: string

Lists custom plugin names that start with the specified text string.

nextToken

: Type: string

If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Result Syntax

[
    'customPlugins' => [
        [
            'creationTime' => <DateTime>,
            'customPluginArn' => '<string>',
            'customPluginState' => 'CREATING|CREATE_FAILED|ACTIVE|UPDATING|UPDATE_FAILED|DELETING',
            'description' => '<string>',
            'latestRevision' => [
                'contentType' => 'JAR|ZIP',
                'creationTime' => <DateTime>,
                'description' => '<string>',
                'fileDescription' => [
                    'fileMd5' => '<string>',
                    'fileSize' => <integer>,
                ],
                'location' => [
                    's3Location' => [
                        'bucketArn' => '<string>',
                        'fileKey' => '<string>',
                        'objectVersion' => '<string>',
                    ],
                ],
                'revision' => <integer>,
            ],
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

customPlugins

: Type: Array of CustomPluginSummary structures

An array of custom plugin descriptions.

nextToken

: Type: string

If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all the tags attached to the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource for which you want to list all attached tags.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

: Type: Associative array of custom strings keys (TagKey) to strings

Lists the tags attached to the specified resource in the corresponding request.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

ListWorkerConfigurations

$result = $client->listWorkerConfigurations([/* ... */]);
$promise = $client->listWorkerConfigurationsAsync([/* ... */]);

Returns a list of all of the worker configurations in this account and Region.

Parameter Syntax

$result = $client->listWorkerConfigurations([
    'maxResults' => <integer>,
    'namePrefix' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members

maxResults

: Type: int

The maximum number of worker configurations to list in one response.

namePrefix

: Type: string

Lists worker configuration names that start with the specified text string.

nextToken

: Type: string

If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

Result Syntax

[
    'nextToken' => '<string>',
    'workerConfigurations' => [
        [
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'latestRevision' => [
                'creationTime' => <DateTime>,
                'description' => '<string>',
                'revision' => <integer>,
            ],
            'name' => '<string>',
            'workerConfigurationArn' => '<string>',
            'workerConfigurationState' => 'ACTIVE|DELETING',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

workerConfigurations

: Type: Array of WorkerConfigurationSummary structures

An array of worker configuration descriptions.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Attaches tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to which you want to attach tags.

tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

The tags that you want to attach to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
ConflictException:: HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

tagKeys

: Required: Yes
: Type: Array of strings

The keys of the tags that you want to remove from the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

UpdateConnector

$result = $client->updateConnector([/* ... */]);
$promise = $client->updateConnectorAsync([/* ... */]);

Updates the specified connector.

Parameter Syntax

$result = $client->updateConnector([
    'capacity' => [
        'autoScaling' => [
            'maxWorkerCount' => <integer>, // REQUIRED
            'mcuCount' => <integer>, // REQUIRED
            'minWorkerCount' => <integer>, // REQUIRED
            'scaleInPolicy' => [ // REQUIRED
                'cpuUtilizationPercentage' => <integer>, // REQUIRED
            ],
            'scaleOutPolicy' => [ // REQUIRED
                'cpuUtilizationPercentage' => <integer>, // REQUIRED
            ],
        ],
        'provisionedCapacity' => [
            'mcuCount' => <integer>, // REQUIRED
            'workerCount' => <integer>, // REQUIRED
        ],
    ],
    'connectorArn' => '<string>', // REQUIRED
    'connectorConfiguration' => ['<string>', ...],
    'currentVersion' => '<string>', // REQUIRED
]);

Parameter Details

Members

capacity

: Type: CapacityUpdate structure

The target capacity.

connectorArn

: Required: Yes
: Type: string

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

connectorConfiguration

: Type: Associative array of custom strings keys (__string) to strings

A map of keys to values that represent the configuration for the connector.

currentVersion

: Required: Yes
: Type: string

The current version of the connector that you want to update.

Result Syntax

[
    'connectorArn' => '<string>',
    'connectorOperationArn' => '<string>',
    'connectorState' => 'RUNNING|CREATING|UPDATING|DELETING|FAILED',
]

Result Details

Members

connectorArn

: Type: string

The Amazon Resource Name (ARN) of the connector.

connectorOperationArn

: Type: string

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

connectorState

: Type: string

The state of the connector.

Errors

NotFoundException:: HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
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.
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.
InternalServerErrorException:: HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.

Shapes

ApacheKafkaCluster

Description

The details of the Apache Kafka cluster to which the connector is connected.

Members

bootstrapServers

: Required: Yes
: Type: string

The bootstrap servers of the cluster.

vpc

: Required: Yes
: Type: Vpc structure

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

ApacheKafkaClusterDescription

Description

The description of the Apache Kafka cluster to which the connector is connected.

Members

bootstrapServers

: Type: string

The bootstrap servers of the cluster.

vpc

: Type: VpcDescription structure

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

AutoScaling

Description

Specifies how the connector scales.

Members

maxWorkerCount

: Required: Yes
: Type: int

The maximum number of workers allocated to the connector.

mcuCount

: Required: Yes
: Type: int

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

minWorkerCount

: Required: Yes
: Type: int

The minimum number of workers allocated to the connector.

scaleInPolicy

: Type: ScaleInPolicy structure

The sacle-in policy for the connector.

scaleOutPolicy

: Type: ScaleOutPolicy structure

The sacle-out policy for the connector.

AutoScalingDescription

Description

Information about the auto scaling parameters for the connector.

Members

maxWorkerCount

: Type: int

The maximum number of workers allocated to the connector.

mcuCount

: Type: int

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

minWorkerCount

: Type: int

The minimum number of workers allocated to the connector.

scaleInPolicy

: Type: ScaleInPolicyDescription structure

The sacle-in policy for the connector.

scaleOutPolicy

: Type: ScaleOutPolicyDescription structure

The sacle-out policy for the connector.>

AutoScalingUpdate

Description

The updates to the auto scaling parameters for the connector.

Members

maxWorkerCount

: Required: Yes
: Type: int

The target maximum number of workers allocated to the connector.

mcuCount

: Required: Yes
: Type: int

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

minWorkerCount

: Required: Yes
: Type: int

The target minimum number of workers allocated to the connector.

scaleInPolicy

: Required: Yes
: Type: ScaleInPolicyUpdate structure

The target sacle-in policy for the connector.

scaleOutPolicy

: Required: Yes
: Type: ScaleOutPolicyUpdate structure

The target sacle-out policy for the connector.

BadRequestException

Description

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

Members

message

: Type: string

Capacity

Description

Information about the capacity of the connector, whether it is auto scaled or provisioned.

Members

autoScaling

: Type: AutoScaling structure

Information about the auto scaling parameters for the connector.

provisionedCapacity

: Type: ProvisionedCapacity structure

Details about a fixed capacity allocated to a connector.

CapacityDescription

Description

A description of the connector's capacity.

Members

autoScaling

: Type: AutoScalingDescription structure

Describes the connector's auto scaling capacity.

provisionedCapacity

: Type: ProvisionedCapacityDescription structure

Describes a connector's provisioned capacity.

CapacityUpdate

Description

The target capacity for the connector. The capacity can be auto scaled or provisioned.

Members

autoScaling

: Type: AutoScalingUpdate structure

The target auto scaling setting.

provisionedCapacity

: Type: ProvisionedCapacityUpdate structure

The target settings for provisioned capacity.

CloudWatchLogsLogDelivery

Description

The settings for delivering connector logs to Amazon CloudWatch Logs.

Members

enabled

: Required: Yes
: Type: boolean

Whether log delivery to Amazon CloudWatch Logs is enabled.

logGroup

: Type: string

The name of the CloudWatch log group that is the destination for log delivery.

CloudWatchLogsLogDeliveryDescription

Description

A description of the log delivery settings.

Members

enabled

: Type: boolean

Whether log delivery to Amazon CloudWatch Logs is enabled.

logGroup

: Type: string

The name of the CloudWatch log group that is the destination for log delivery.

ConflictException

Description

HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.

Members

message

: Type: string

ConnectorOperationStep

Description

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

Members

stepState

: Type: string

The step state of the operation.

stepType

: Type: string

The step type of the operation.

ConnectorOperationSummary

Description

Summary of a connector operation.

Members

connectorOperationArn

: Type: string

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

connectorOperationState

: Type: string

The state of the connector operation.

connectorOperationType

: Type: string

The type of connector operation performed.

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when operation was created.

endTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when operation ended.

ConnectorSummary

Description

Summary of a connector.

Members

capacity

: Type: CapacityDescription structure

The connector's compute capacity settings.

connectorArn

: Type: string

The Amazon Resource Name (ARN) of the connector.

connectorDescription

: Type: string

The description of the connector.

connectorName

: Type: string

The name of the connector.

connectorState

: Type: string

The state of the connector.

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the connector was created.

currentVersion

: Type: string

The current version of the connector.

kafkaCluster

: Type: KafkaClusterDescription structure

The details of the Apache Kafka cluster to which the connector is connected.

kafkaClusterClientAuthentication

: Type: KafkaClusterClientAuthenticationDescription structure

The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

kafkaClusterEncryptionInTransit

: Type: KafkaClusterEncryptionInTransitDescription structure

Details of encryption in transit to the Apache Kafka cluster.

kafkaConnectVersion

: Type: string

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

logDelivery

: Type: LogDeliveryDescription structure

The settings for delivering connector logs to Amazon CloudWatch Logs.

plugins

: Type: Array of PluginDescription structures

Specifies which plugins were used for this connector.

serviceExecutionRoleArn

: Type: string

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

workerConfiguration

: Type: WorkerConfigurationDescription structure

The worker configurations that are in use with the connector.

CustomPlugin

Description

A plugin is an Amazon Web Services resource that contains the code that defines a connector's logic.

Members

customPluginArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the custom plugin.

revision

: Required: Yes
: Type: long (int|float)

The revision of the custom plugin.

CustomPluginDescription

Description

Details about a custom plugin.

Members

customPluginArn

: Type: string

The Amazon Resource Name (ARN) of the custom plugin.

revision

: Type: long (int|float)

The revision of the custom plugin.

CustomPluginFileDescription

Description

Details about a custom plugin file.

Members

fileMd5

: Type: string

The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.

fileSize

: Type: long (int|float)

The size in bytes of the custom plugin file. You can use it to validate the file.

CustomPluginLocation

Description

Information about the location of a custom plugin.

Members

s3Location

: Required: Yes
: Type: S3Location structure

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

CustomPluginLocationDescription

Description

Information about the location of a custom plugin.

Members

s3Location

: Type: S3LocationDescription structure

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.

CustomPluginRevisionSummary

Description

Details about the revision of a custom plugin.

Members

contentType

: Type: string

The format of the plugin file.

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the custom plugin was created.

description

: Type: string

The description of the custom plugin.

fileDescription

: Type: CustomPluginFileDescription structure

Details about the custom plugin file.

location

: Type: CustomPluginLocationDescription structure

Information about the location of the custom plugin.

revision

: Type: long (int|float)

The revision of the custom plugin.

CustomPluginSummary

Description

A summary of the custom plugin.

Members

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the custom plugin was created.

customPluginArn

: Type: string

The Amazon Resource Name (ARN) of the custom plugin.

customPluginState

: Type: string

The state of the custom plugin.

description

: Type: string

A description of the custom plugin.

latestRevision

: Type: CustomPluginRevisionSummary structure

The latest revision of the custom plugin.

name

: Type: string

The name of the custom plugin.

FirehoseLogDelivery

Description

The settings for delivering logs to Amazon Kinesis Data Firehose.

Members

deliveryStream

: Type: string

The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

enabled

: Required: Yes
: Type: boolean

Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

FirehoseLogDeliveryDescription

Description

A description of the settings for delivering logs to Amazon Kinesis Data Firehose.

Members

deliveryStream

: Type: string

The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

enabled

: Type: boolean

Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

ForbiddenException

Description

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

Members

message

: Type: string

InternalServerErrorException

Description

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

Members

message

: Type: string

KafkaCluster

Description

The details of the Apache Kafka cluster to which the connector is connected.

Members

apacheKafkaCluster

: Required: Yes
: Type: ApacheKafkaCluster structure

The Apache Kafka cluster to which the connector is connected.

KafkaClusterClientAuthentication

Description

The client authentication information used in order to authenticate with the Apache Kafka cluster.

Members

authenticationType

: Required: Yes
: Type: string

The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

KafkaClusterClientAuthenticationDescription

Description

The client authentication information used in order to authenticate with the Apache Kafka cluster.

Members

authenticationType

: Type: string

The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

KafkaClusterDescription

Description

Details of how to connect to the Apache Kafka cluster.

Members

apacheKafkaCluster

: Type: ApacheKafkaClusterDescription structure

The Apache Kafka cluster to which the connector is connected.

KafkaClusterEncryptionInTransit

Description

Details of encryption in transit to the Apache Kafka cluster.

Members

encryptionType

: Required: Yes
: Type: string

The type of encryption in transit to the Apache Kafka cluster.

KafkaClusterEncryptionInTransitDescription

Description

The description of the encryption in transit to the Apache Kafka cluster.

Members

encryptionType

: Type: string

The type of encryption in transit to the Apache Kafka cluster.

LogDelivery

Description

Details about log delivery.

Members

workerLogDelivery

: Required: Yes
: Type: WorkerLogDelivery structure

The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

LogDeliveryDescription

Description

The description of the log delivery settings.

Members

workerLogDelivery

: Type: WorkerLogDeliveryDescription structure

The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

NotFoundException

Description

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

Members

message

: Type: string

Plugin

Description

A plugin is an Amazon Web Services resource that contains the code that defines your connector logic.

Members

customPlugin

: Required: Yes
: Type: CustomPlugin structure

Details about a custom plugin.

PluginDescription

Description

The description of the plugin.

Members

customPlugin

: Type: CustomPluginDescription structure

Details about a custom plugin.

ProvisionedCapacity

Description

Details about a connector's provisioned capacity.

Members

mcuCount

: Required: Yes
: Type: int

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

workerCount

: Required: Yes
: Type: int

The number of workers that are allocated to the connector.

ProvisionedCapacityDescription

Description

The description of a connector's provisioned capacity.

Members

mcuCount

: Type: int

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

workerCount

: Type: int

The number of workers that are allocated to the connector.

ProvisionedCapacityUpdate

Description

An update to a connector's fixed capacity.

Members

mcuCount

: Required: Yes
: Type: int

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

workerCount

: Required: Yes
: Type: int

The number of workers that are allocated to the connector.

S3Location

Description

The location of an object in Amazon S3.

Members

bucketArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of an S3 bucket.

fileKey

: Required: Yes
: Type: string

The file key for an object in an S3 bucket.

objectVersion

: Type: string

The version of an object in an S3 bucket.

S3LocationDescription

Description

The description of the location of an object in Amazon S3.

Members

bucketArn

: Type: string

The Amazon Resource Name (ARN) of an S3 bucket.

fileKey

: Type: string

The file key for an object in an S3 bucket.

objectVersion

: Type: string

The version of an object in an S3 bucket.

S3LogDelivery

Description

Details about delivering logs to Amazon S3.

Members

bucket

: Type: string

The name of the S3 bucket that is the destination for log delivery.

enabled

: Required: Yes
: Type: boolean

Specifies whether connector logs get sent to the specified Amazon S3 destination.

prefix

: Type: string

The S3 prefix that is the destination for log delivery.

S3LogDeliveryDescription

Description

The description of the details about delivering logs to Amazon S3.

Members

bucket

: Type: string

The name of the S3 bucket that is the destination for log delivery.

enabled

: Type: boolean

Specifies whether connector logs get sent to the specified Amazon S3 destination.

prefix

: Type: string

The S3 prefix that is the destination for log delivery.

ScaleInPolicy

Description

The scale-in policy for the connector.

Members

cpuUtilizationPercentage

: Required: Yes
: Type: int

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

ScaleInPolicyDescription

Description

The description of the scale-in policy for the connector.

Members

cpuUtilizationPercentage

: Type: int

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

ScaleInPolicyUpdate

Description

An update to the connector's scale-in policy.

Members

cpuUtilizationPercentage

: Required: Yes
: Type: int

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

ScaleOutPolicy

Description

The scale-out policy for the connector.

Members

cpuUtilizationPercentage

: Required: Yes
: Type: int

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

ScaleOutPolicyDescription

Description

The description of the scale-out policy for the connector.

Members

cpuUtilizationPercentage

: Type: int

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

ScaleOutPolicyUpdate

Description

An update to the connector's scale-out policy.

Members

cpuUtilizationPercentage

: Required: Yes
: Type: int

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

ServiceUnavailableException

Description

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

Members

message

: Type: string

StateDescription

Description

Details about the state of a resource.

Members

code

: Type: string

A code that describes the state of a resource.

message

: Type: string

A message that describes the state of a resource.

TooManyRequestsException

Description

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

Members

message

: Type: string

UnauthorizedException

Description

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

Members

message

: Type: string

Vpc

Description

Information about the VPC in which the connector resides.

Members

securityGroups

: Type: Array of strings

The security groups for the connector.

subnets

: Required: Yes
: Type: Array of strings

The subnets for the connector.

VpcDescription

Description

The description of the VPC in which the connector resides.

Members

securityGroups

: Type: Array of strings

The security groups for the connector.

subnets

: Type: Array of strings

The subnets for the connector.

WorkerConfiguration

Description

The configuration of the workers, which are the processes that run the connector logic.

Members

revision

: Required: Yes
: Type: long (int|float)

The revision of the worker configuration.

workerConfigurationArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the worker configuration.

WorkerConfigurationDescription

Description

The description of the worker configuration.

Members

revision

: Type: long (int|float)

The revision of the worker configuration.

workerConfigurationArn

: Type: string

The Amazon Resource Name (ARN) of the worker configuration.

WorkerConfigurationRevisionDescription

Description

The description of the worker configuration revision.

Members

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the worker configuration was created.

description

: Type: string

The description of the worker configuration revision.

propertiesFileContent

: Type: string

Base64 encoded contents of the connect-distributed.properties file.

revision

: Type: long (int|float)

The description of a revision of the worker configuration.

WorkerConfigurationRevisionSummary

Description

The summary of a worker configuration revision.

Members

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that a worker configuration revision was created.

description

: Type: string

The description of a worker configuration revision.

revision

: Type: long (int|float)

The revision of a worker configuration.

WorkerConfigurationSummary

Description

The summary of a worker configuration.

Members

creationTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that a worker configuration was created.

description

: Type: string

The description of a worker configuration.

latestRevision

: Type: WorkerConfigurationRevisionSummary structure

The latest revision of a worker configuration.

name

: Type: string

The name of the worker configuration.

workerConfigurationArn

: Type: string

The Amazon Resource Name (ARN) of the worker configuration.

workerConfigurationState

: Type: string

The state of the worker configuration.

WorkerLogDelivery

Description

Workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

Members

cloudWatchLogs

: Type: CloudWatchLogsLogDelivery structure

Details about delivering logs to Amazon CloudWatch Logs.

firehose

: Type: FirehoseLogDelivery structure

Details about delivering logs to Amazon Kinesis Data Firehose.

s3

: Type: S3LogDelivery structure

Details about delivering logs to Amazon S3.

WorkerLogDeliveryDescription

Description

Workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

Members

cloudWatchLogs

: Type: CloudWatchLogsLogDeliveryDescription structure

Details about delivering logs to Amazon CloudWatch Logs.

firehose

: Type: FirehoseLogDeliveryDescription structure

Details about delivering logs to Amazon Kinesis Data Firehose.

s3

: Type: S3LogDeliveryDescription structure

Details about delivering logs to Amazon S3.

WorkerSetting

Description

Details about worker setting of a connector

Members

capacity

: Type: CapacityDescription structure

A description of the connector's capacity.

Managed Streaming for Kafka Connect 2021-09-14

Operation Summary

Paginators

Operations

CreateConnector

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCustomPlugin

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateWorkerConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteConnector

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteCustomPlugin

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteWorkerConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeConnector

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeConnectorOperation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeCustomPlugin

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeWorkerConfiguration

Parameter Syntax

Parameter Details

Members