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

CreatePackage

Creates a package and storage location in an Amazon S3 access point.

Request Syntax


POST /packages HTTP/1.1
Content-type: application/json

{
   "PackageName": "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.

PackageName

A name for the package.

Type: String

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

Pattern: ^[a-zA-Z0-9\-\_]+$

Required: Yes

Tags

Tags for the package.

Type: String to string map

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

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

Key Pattern: ^.+$

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

Value Pattern: ^.*$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "PackageId": "string",
   "StorageLocation": { 
      "BinaryPrefixLocation": "string",
      "Bucket": "string",
      "GeneratedPrefixLocation": "string",
      "ManifestPrefixLocation": "string",
      "RepoPrefixLocation": "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.

Arn

The package's ARN.

Type: String

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

PackageId

The package's ID.

Type: String

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

Pattern: ^[a-zA-Z0-9\-\_\/]+$

StorageLocation

The package's storage location.

Type: StorageLocation object

Errors

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

AccessDeniedException

The requestor does not have permission to access the target action or resource.

HTTP Status Code: 403

ConflictException

The target resource is in use.

HTTP Status Code: 409

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400