Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeCustomPlugin

A summary description of the custom plugin.

Request Syntax


GET /v1/custom-plugins/customPluginArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

customPluginArn

Returns information about a custom plugin.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "creationTime": "string",
   "customPluginArn": "string",
   "customPluginState": "string",
   "description": "string",
   "latestRevision": { 
      "contentType": "string",
      "creationTime": "string",
      "description": "string",
      "fileDescription": { 
         "fileMd5": "string",
         "fileSize": number
      },
      "location": { 
         "s3Location": { 
            "bucketArn": "string",
            "fileKey": "string",
            "objectVersion": "string"
         }
      },
      "revision": number
   },
   "name": "string",
   "stateDescription": { 
      "code": "string",
      "message": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

creationTime

The time that the custom plugin was created.

Type: Timestamp

customPluginArn

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

Type: String

customPluginState

The state of the custom plugin.

Type: String

description

The description of the custom plugin.

Type: String

latestRevision

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

Type: CustomPluginRevisionSummary object

name

The name of the custom plugin.

Type: String

stateDescription

Details about the state of a custom plugin.

Type: StateDescription object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

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

HTTP Status Code: 400

ForbiddenException

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

HTTP Status Code: 403

InternalServerErrorException

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

HTTP Status Code: 500

NotFoundException

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

HTTP Status Code: 404

ServiceUnavailableException

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

HTTP Status Code: 503

TooManyRequestsException

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

HTTP Status Code: 429

UnauthorizedException

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

HTTP Status Code: 401