ListPackagesForDomain
Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
Request Syntax
GET /2021-01-01/domain/DomainName
/packages?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
The name of the domain for which you want to list associated packages.
Length Constraints: Minimum length of 3. Maximum length of 28.
Pattern:
[a-z][a-z0-9\-]+
Required: Yes
- MaxResults
-
An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.Valid Range: Maximum value of 100.
- NextToken
-
If your initial
ListPackagesForDomain
operation returns anextToken
, you can include the returnednextToken
in subsequentListPackagesForDomain
operations, which returns results in the next page.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DomainPackageDetailsList": [
{
"DomainName": "string",
"DomainPackageStatus": "string",
"ErrorDetails": {
"ErrorMessage": "string",
"ErrorType": "string"
},
"LastUpdated": number,
"PackageID": "string",
"PackageName": "string",
"PackageType": "string",
"PackageVersion": "string",
"ReferencePath": "string"
}
],
"NextToken": "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.
- DomainPackageDetailsList
-
List of all packages associated with a domain.
Type: Array of DomainPackageDetails objects
- NextToken
-
When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.Type: String
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: