packages_for_domains
Creates, updates, deletes, gets or lists a packages_for_domains resource.
Overview
| Name | packages_for_domains |
| Type | Resource |
| Id | aws.opensearch.packages_for_domains |
Fields
The following fields are returned by SELECT queries:
- list_packages_for_domain
| Name | Datatype | Description |
|---|---|---|
domain_package_details_list | array | List of all packages associated with a domain. |
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_packages_for_domain | select | domain_name, region | maxResults, nextToken | Lists all packages associated with an Amazon OpenSearch Service domain. 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 |
|---|---|---|
domain_name | string | The name of the domain for which you want to list associated packages. |
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 ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page. |
SELECT examples
- list_packages_for_domain
Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
SELECT
domain_package_details_list,
next_token
FROM aws.opensearch.packages_for_domains
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;