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

ListDomainsForPackage

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.

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 ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.

PackageID

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DomainPackageDetailsList": [ 
      { 
         "AssociationConfiguration": { 
            "KeyStoreAccessOption": { 
               "KeyAccessRoleArn": "string",
               "KeyStoreAccessEnabled": boolean
            }
         },
         "DomainName": "string",
         "DomainPackageStatus": "string",
         "ErrorDetails": { 
            "ErrorMessage": "string",
            "ErrorType": "string"
         },
         "LastUpdated": number,
         "PackageID": "string",
         "PackageName": "string",
         "PackageType": "string",
         "PackageVersion": "string",
         "PrerequisitePackageIDList": [ "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

Information about all domains associated with a package.

Type: Array of DomainPackageDetails objects

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

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