[ aws . kafkaconnect ]

describe-custom-plugin

Description

A summary description of the custom plugin.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-custom-plugin
--custom-plugin-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--custom-plugin-arn (string)

Returns information about a custom plugin.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

creationTime -> (timestamp)

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)

The description of the custom plugin.

latestRevision -> (structure)

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

contentType -> (string)

The format of the plugin file.

creationTime -> (timestamp)

The time that the custom plugin was created.

description -> (string)

The description of the custom plugin.

fileDescription -> (structure)

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 -> (long)

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

location -> (structure)

Information about the location of the custom plugin.

s3Location -> (structure)

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 -> (long)

The revision of the custom plugin.

name -> (string)

The name of the custom plugin.

stateDescription -> (structure)

Details about the state of a custom plugin.

code -> (string)

A code that describes the state of a resource.

message -> (string)

A message that describes the state of a resource.