KafkaConnect / Client / list_custom_plugins
list_custom_plugins#
- KafkaConnect.Client.list_custom_plugins(**kwargs)#
Returns a list of all of the custom plugins in this account and Region.
See also: AWS API Documentation
Request Syntax
response = client.list_custom_plugins( maxResults=123, nextToken='string' )
- Parameters:
maxResults (integer) – The maximum number of custom plugins to list in one response.
nextToken (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.
- Return type:
dict
- Returns:
Response Syntax
{ 'customPlugins': [ { 'creationTime': datetime(2015, 1, 1), 'customPluginArn': 'string', 'customPluginState': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING', 'description': 'string', 'latestRevision': { 'contentType': 'JAR'|'ZIP', 'creationTime': datetime(2015, 1, 1), 'description': 'string', 'fileDescription': { 'fileMd5': 'string', 'fileSize': 123 }, 'location': { 's3Location': { 'bucketArn': 'string', 'fileKey': 'string', 'objectVersion': 'string' } }, 'revision': 123 }, 'name': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) –
customPlugins (list) –
An array of custom plugin descriptions.
(dict) –
A summary of the custom plugin.
creationTime (datetime) –
The time that the custom plugin was created.
customPluginArn (string) –
The Amazon Resource Name (ARN) of the custom plugin.
customPluginState (string) –
The state of the custom plugin.
description (string) –
A description of the custom plugin.
latestRevision (dict) –
The latest revision of the custom plugin.
contentType (string) –
The format of the plugin file.
creationTime (datetime) –
The time that the custom plugin was created.
description (string) –
The description of the custom plugin.
fileDescription (dict) –
Details about the custom plugin file.
fileMd5 (string) –
The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
fileSize (integer) –
The size in bytes of the custom plugin file. You can use it to validate the file.
location (dict) –
Information about the location of the custom plugin.
s3Location (dict) –
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
bucketArn (string) –
The Amazon Resource Name (ARN) of an S3 bucket.
fileKey (string) –
The file key for an object in an S3 bucket.
objectVersion (string) –
The version of an object in an S3 bucket.
revision (integer) –
The revision of the custom plugin.
name (string) –
The name of the custom plugin.
nextToken (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.
Exceptions
KafkaConnect.Client.exceptions.NotFoundException
KafkaConnect.Client.exceptions.BadRequestException
KafkaConnect.Client.exceptions.ForbiddenException
KafkaConnect.Client.exceptions.ServiceUnavailableException
KafkaConnect.Client.exceptions.TooManyRequestsException
KafkaConnect.Client.exceptions.UnauthorizedException
KafkaConnect.Client.exceptions.InternalServerErrorException