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

UpdatePackage

Updates 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/update HTTP/1.1
Content-type: application/json

{
   "CommitMessage": "string",
   "PackageConfiguration": { 
      "ConfigurationRequirement": "string",
      "LicenseFilepath": "string",
      "LicenseRequirement": "string",
      "RequiresRestartForConfigurationUpdate": boolean
   },
   "PackageDescription": "string",
   "PackageEncryptionOptions": { 
      "EncryptionEnabled": boolean,
      "KmsKeyIdentifier": "string"
   },
   "PackageID": "string",
   "PackageSource": { 
      "S3BucketName": "string",
      "S3Key": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

CommitMessage

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

Type: String

Length Constraints: Maximum length of 160.

Required: No

PackageConfiguration

The updated configuration details for a package.

Type: PackageConfiguration object

Required: No

PackageDescription

A new description of the package.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

PackageEncryptionOptions

Encryption options for a package.

Type: PackageEncryptionOptions object

Required: No

PackageID

The unique identifier for the package.

Type: String

Pattern: ^([FG][0-9]+)$|^(pkg-[a-f0-9]+)$

Required: Yes

PackageSource

Amazon S3 bucket and key for the package.

Type: PackageSource object

Required: Yes

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

Information about a 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

LimitExceededException

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

HTTP Status Code: 409

ResourceNotFoundException

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

HTTP Status Code: 409

ValidationException

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

HTTP Status Code: 400