Skip to content

aws.opensearch.describe_packages

Example SQL Queries

SELECT * FROM
aws.opensearch.describe_packages;

Description

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

Table Definition

Column NameColumn Data Type
filters Input Column

Only returns packages that match the DescribePackagesFilterList values.

STRUCT(
"name" VARCHAR,
"value" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

Any field from PackageDetails.

filters[].value[]
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.

package_details_list

Basic information about a package.

STRUCT(
"package_id" VARCHAR,
"package_name" VARCHAR,
"package_type" VARCHAR,
"package_description" VARCHAR,
"package_status" VARCHAR,
"created_at" TIMESTAMP_S,
"last_updated_at" TIMESTAMP_S,
"available_package_version" VARCHAR,
"error_details" STRUCT(
"error_type" VARCHAR,
"error_message" VARCHAR
),
"engine_version" VARCHAR,
"available_plugin_properties" STRUCT(
"name" VARCHAR,
"description" VARCHAR,
"version" VARCHAR,
"class_name" VARCHAR,
"uncompressed_size_in_bytes" BIGINT
)
)[]
Show child fields
package_details_list[]
Show child fields
package_details_list[].available_package_version

The package version.

package_details_list[].available_plugin_properties

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

Show child fields
package_details_list[].available_plugin_properties.class_name

The name of the class to load.

package_details_list[].available_plugin_properties.description

The description of the plugin.

package_details_list[].available_plugin_properties.name

The name of the plugin.

package_details_list[].available_plugin_properties.uncompressed_size_in_bytes

The uncompressed size of the plugin.

package_details_list[].available_plugin_properties.version

The version of the plugin.

package_details_list[].created_at

The timestamp when the package was created.

package_details_list[].engine_version

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

package_details_list[].error_details

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

Show child fields
package_details_list[].error_details.error_message

A message describing the error.

package_details_list[].error_details.error_type

The type of error that occurred.

package_details_list[].last_updated_at

Date and time when the package was last updated.

package_details_list[].package_description

User-specified description of the package.

package_details_list[].package_id

The unique identifier of the package.

package_details_list[].package_name

The user-specified name of the package.

package_details_list[].package_status

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

package_details_list[].package_type

The type of package.