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

DescribePackages

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

Request Syntax


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

{
   "Filters": [ 
      { 
         "Name": "string",
         "Value": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Filters

Only returns packages that match the DescribePackagesFilterList values.

Type: Array of DescribePackagesFilter objects

Required: No

MaxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Type: Integer

Valid Range: Maximum value of 100.

Required: No

NextToken

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PackageDetailsList": [ 
      { 
         "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.

NextToken

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Type: String

PackageDetailsList

Basic information about a package.

Type: Array of PackageDetails objects

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

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