Describe Domain
opensearch.describe_domain
ActionAmazon Web Servicesconnection required
Calls the AWS opensearch API (SigV4).
Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon OpenSearch Service
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
domain_name The name of the domain that you want information about. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
DomainStatus | object | — |
{
"DomainStatus": {}
}Related Amazon OpenSearch Service nodes
See Describe Domain run in a workflow.
In a technical demo we add the Amazon OpenSearch Service connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.