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

CreatePackage

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

Request Syntax


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

{
   "EngineVersion": "string",
   "PackageConfiguration": { 
      "ConfigurationRequirement": "string",
      "LicenseFilepath": "string",
      "LicenseRequirement": "string",
      "RequiresRestartForConfigurationUpdate": boolean
   },
   "PackageDescription": "string",
   "PackageEncryptionOptions": { 
      "EncryptionEnabled": boolean,
      "KmsKeyIdentifier": "string"
   },
   "PackageName": "string",
   "PackageSource": { 
      "S3BucketName": "string",
      "S3Key": "string"
   },
   "PackageType": "string",
   "PackageVendingOptions": { 
      "VendingEnabled": boolean
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

EngineVersion

The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN

Type: String

Pattern: ^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$

Required: No

PackageConfiguration

The configuration parameters for the package being created.

Type: PackageConfiguration object

Required: No

PackageDescription

Description of the package.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

PackageEncryptionOptions

The encryption parameters for the package being created.

Type: PackageEncryptionOptions object

Required: No

PackageName

Unique name for the package.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 256.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

PackageSource

The Amazon S3 location from which to import the package.

Type: PackageSource object

Required: Yes

PackageType

The type of package.

Type: String

Valid Values: TXT-DICTIONARY | ZIP-PLUGIN | PACKAGE-LICENSE | PACKAGE-CONFIG

Required: Yes

PackageVendingOptions

The vending options for the package being created. They determine if the package can be vended to other users.

Type: PackageVendingOptions object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "PackageDetails": { 
      "AllowListedUserList": [ "string" ],
      "AvailablePackageConfiguration": { 
         "ConfigurationRequirement": "string",
         "LicenseFilepath": "string",
         "LicenseRequirement": "string",
         "RequiresRestartForConfigurationUpdate": boolean
      },
      "AvailablePackageVersion": "string",
      "AvailablePluginProperties": { 
         "ClassName": "string",
         "Description": "string",
         "Name": "string",
         "UncompressedSizeInBytes": number,
         "Version": "string"
      },
      "CreatedAt": number,
      "EngineVersion": "string",
      "ErrorDetails": { 
         "ErrorMessage": "string",
         "ErrorType": "string"
      },
      "LastUpdatedAt": number,
      "PackageDescription": "string",
      "PackageEncryptionOptions": { 
         "EncryptionEnabled": boolean,
         "KmsKeyIdentifier": "string"
      },
      "PackageID": "string",
      "PackageName": "string",
      "PackageOwner": "string",
      "PackageStatus": "string",
      "PackageType": "string",
      "PackageVendingOptions": { 
         "VendingEnabled": boolean
      }
   }
}

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.

PackageDetails

Basic information about an OpenSearch Service package.

Type: PackageDetails object

Errors

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

AccessDeniedException

An error occurred because you don't have permissions to access the resource.

HTTP Status Code: 403

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

InvalidTypeException

An exception for trying to create or access a sub-resource that's either invalid or not supported.

HTTP Status Code: 409

LimitExceededException

An exception for trying to create more than the allowed number of resources or sub-resources.

HTTP Status Code: 409

ResourceAlreadyExistsException

An exception for creating a resource that already exists.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400