domains_for_packages

Creates, updates, deletes, gets or lists a domains_for_packages resource.

Overview

Name	domains_for_packages
Type	Resource
Id	aws.opensearch.domains_for_packages

Fields

The following fields are returned by SELECT queries:

list_domains_for_package

Name	Datatype	Description
domain_package_details_list	array	Information about all domains associated with a package.
next_token	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_domains_for_package	select	package_id, region	maxResults, nextToken	Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
package_id	string	The unique identifier of the package for which to list associated domains.
region	string	AWS region (default: us-east-1)
maxResults	integer	An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
nextToken	string	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.

SELECT examples

list_domains_for_package

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

SELECT
domain_package_details_list,
next_token
FROM aws.opensearch.domains_for_packages
WHERE package_id = '{{ package_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;