Skip to content

aws.opensearch.describe_outbound_connections

Example SQL Queries

SELECT * FROM
aws.opensearch.describe_outbound_connections;

Description

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Table Definition

Column NameColumn Data Type
filters Input Column

List of filter names and values that you can use for requests.

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

The name of the filter.

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

connections

List of outbound connections that match the filter criteria.

STRUCT(
"local_domain_info" STRUCT(
"aws_domain_information" STRUCT(
"owner_id" VARCHAR,
"domain_name" VARCHAR,
"region" VARCHAR
)
),
"remote_domain_info" STRUCT(
"aws_domain_information" STRUCT(
"owner_id" VARCHAR,
"domain_name" VARCHAR,
"region" VARCHAR
)
),
"connection_id" VARCHAR,
"connection_alias" VARCHAR,
"connection_status" STRUCT(
"status_code" VARCHAR,
"message" VARCHAR
),
"connection_mode" VARCHAR,
"connection_properties" STRUCT(
"endpoint" VARCHAR,
"cross_cluster_search" STRUCT(
"skip_unavailable" VARCHAR
)
)
)[]
Show child fields
connections[]
Show child fields
connections[].connection_alias

Name of the connection.

connections[].connection_id

Unique identifier of the connection.

connections[].connection_mode

The connection mode.

connections[].connection_properties

Properties for the outbound connection.

Show child fields
connections[].connection_properties.cross_cluster_search

The connection properties for cross cluster search.

Show child fields
connections[].connection_properties.cross_cluster_search.skip_unavailable

The status of the SkipUnavailable setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters.

connections[].connection_properties.endpoint

The Endpoint attribute cannot be modified.

The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.

connections[].connection_status

Status of the connection.

Show child fields
connections[].connection_status.message

Verbose information for the outbound connection.

connections[].connection_status.status_code

The status code for the outbound connection. Can be one of the following:

  • VALIDATING - The outbound connection request is being validated.

  • VALIDATION_FAILED - Validation failed for the connection request.

  • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.

  • APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.

  • PROVISIONING - Outbound connection request is in process.

  • ACTIVE - Outbound connection is active and ready to use.

  • REJECTING - Outbound connection rejection by remote domain owner is in progress.

  • REJECTED - Outbound connection request is rejected by remote domain owner.

  • DELETING - Outbound connection deletion is in progress.

  • DELETED - Outbound connection is deleted and can no longer be used.

connections[].local_domain_info

Information about the source (local) domain.

Show child fields
connections[].local_domain_info.aws_domain_information

Information about an Amazon OpenSearch Service domain.

Show child fields
connections[].local_domain_info.aws_domain_information.domain_name

Name of the domain.

connections[].local_domain_info.aws_domain_information.owner_id

The Amazon Web Services account ID of the domain owner.

connections[].local_domain_info.aws_domain_information.region

The Amazon Web Services Region in which the domain is located.

connections[].remote_domain_info

Information about the destination (remote) domain.

Show child fields
connections[].remote_domain_info.aws_domain_information

Information about an Amazon OpenSearch Service domain.

Show child fields
connections[].remote_domain_info.aws_domain_information.domain_name

Name of the domain.

connections[].remote_domain_info.aws_domain_information.owner_id

The Amazon Web Services account ID of the domain owner.

connections[].remote_domain_info.aws_domain_information.region

The Amazon Web Services Region in which the domain is located.