ListDomainsForPackage - Amazon OpenSearch Service


Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

Request Syntax

GET /2021-01-01/packages/PackageID/domains?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


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.


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


The unique identifier of the package for which to list associated domains.

Pattern: ^([FG][0-9]+)$

Required: Yes

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.


Information about all domains associated with a package.

Type: Array of DomainPackageDetails objects


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


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


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

HTTP Status Code: 403


An error occurred while processing the request.

HTTP Status Code: 400


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

HTTP Status Code: 500


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

HTTP Status Code: 409


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: