KafkaConnect / Client / create_custom_plugin

create_custom_plugin

KafkaConnect.Client.create_custom_plugin(**kwargs)

Creates a custom plugin using the specified properties.

See also: AWS API Documentation

Request Syntax

response = client.create_custom_plugin(
    contentType='JAR'|'ZIP',
    description='string',
    location={
        's3Location': {
            'bucketArn': 'string',
            'fileKey': 'string',
            'objectVersion': 'string'
        }
    },
    name='string',
    tags={
        'string': 'string'
    }
)

Parameters:

• contentType (string) –

  [REQUIRED]

  The type of the plugin file.

• description (string) – A summary description of the custom plugin.

• location (dict) –

  [REQUIRED]

  Information about the location of a custom plugin.

  • s3Location (dict) – [REQUIRED]

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

    • bucketArn (string) – [REQUIRED]

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

    • fileKey (string) – [REQUIRED]

      The file key for an object in an S3 bucket.

    • objectVersion (string) –

      The version of an object in an S3 bucket.

• name (string) –

  [REQUIRED]

  The name of the custom plugin.

• tags (dict) –

  The tags you want to attach to the custom plugin.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'customPluginArn': 'string',
    'customPluginState': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING',
    'name': 'string',
    'revision': 123
}

Response Structure

• (dict) –

  • customPluginArn (string) –

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

  • customPluginState (string) –

    The state of the custom plugin.

  • name (string) –

    The name of the custom plugin.

  • revision (integer) –

    The revision of the custom plugin.

Exceptions

• KafkaConnect.Client.exceptions.NotFoundException

• KafkaConnect.Client.exceptions.ConflictException

• KafkaConnect.Client.exceptions.BadRequestException

• KafkaConnect.Client.exceptions.ForbiddenException

• KafkaConnect.Client.exceptions.ServiceUnavailableException

• KafkaConnect.Client.exceptions.TooManyRequestsException

• KafkaConnect.Client.exceptions.UnauthorizedException

• KafkaConnect.Client.exceptions.InternalServerErrorException