Skip to content
AWS for Query.Farm

aws.opensearch.list_domains_for_package

Example SQL Queries

SELECT * FROM
aws.opensearch.list_domains_for_package
WHERE
"package_id" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
package_id Required Input Column

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

VARCHAR
max_results Input Column

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

BIGINT
next_token Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

domain_package_details_list

Information about all domains associated with a package.

STRUCT(
    "package_id" VARCHAR,
    "package_name" VARCHAR,
    "package_type" VARCHAR,
    "last_updated" TIMESTAMP_S,
    "domain_name" VARCHAR,
    "domain_package_status" VARCHAR,
    "package_version" VARCHAR,
    "reference_path" VARCHAR,
    "error_details" STRUCT(
        "error_type" VARCHAR,
        "error_message" VARCHAR
    )
)[]
Show child fields
domain_package_details_list[]
Show child fields
domain_package_details_list[].domain_name

Name of the domain that the package is associated with.

domain_package_details_list[].domain_package_status

State of the association.

domain_package_details_list[].error_details

Additional information if the package is in an error state. Null otherwise.

Show child fields
domain_package_details_list[].error_details.error_message

A message describing the error.

domain_package_details_list[].error_details.error_type

The type of error that occurred.

domain_package_details_list[].last_updated

Timestamp of the most recent update to the package association status.

domain_package_details_list[].package_id

Internal ID of the package.

domain_package_details_list[].package_name

User-specified name of the package.

domain_package_details_list[].package_type

The type of package.

domain_package_details_list[].package_version

The current version of the package.

domain_package_details_list[].reference_path

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.