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

CreateCustomPlugin

Creates a custom plugin using the specified properties.

Request Syntax


POST /v1/custom-plugins HTTP/1.1
Content-type: application/json

{
   "contentType": "string",
   "description": "string",
   "location": { 
      "s3Location": { 
         "bucketArn": "string",
         "fileKey": "string",
         "objectVersion": "string"
      }
   },
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

contentType

The type of the plugin file.

Type: String

Valid Values: JAR | ZIP

Required: Yes

description

A summary description of the custom plugin.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

location

Information about the location of a custom plugin.

Type: CustomPluginLocation object

Required: Yes

name

The name of the custom plugin.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

tags

The tags you want to attach to the custom plugin.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "customPluginArn": "string",
   "customPluginState": "string",
   "name": "string",
   "revision": number
}

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.

customPluginArn

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

Type: String

customPluginState

The state of the custom plugin.

Type: String

name

The name of the custom plugin.

Type: String

revision

The revision of the custom plugin.

Type: Long

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

ConflictException

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

HTTP Status Code: 409

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