Skip to content
AWS for Query.Farm

aws.opensearch.describe_vpc_endpoints

Example SQL Queries

SELECT * FROM
aws.opensearch.describe_vpc_endpoints
WHERE
"vpc_endpoint_ids" = 'VALUE';

Description

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Table Definition

Column NameColumn Data Type
vpc_endpoint_ids Required Input Column

The unique identifiers of the endpoints to get information about.

VARCHAR[]
Show child fields
vpc_endpoint_ids[]
_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.

vpc_endpoint_errors

Any errors associated with the request.

STRUCT(
    "vpc_endpoint_id" VARCHAR,
    "error_code" VARCHAR,
    "error_message" VARCHAR
)[]
Show child fields
vpc_endpoint_errors[]
Show child fields
vpc_endpoint_errors[].error_code

The code associated with the error.

vpc_endpoint_errors[].error_message

A message describing the error.

vpc_endpoint_errors[].vpc_endpoint_id

The unique identifier of the endpoint.

vpc_endpoints

Information about each requested VPC endpoint.

STRUCT(
    "vpc_endpoint_id" VARCHAR,
    "vpc_endpoint_owner" VARCHAR,
    "domain_arn" VARCHAR,
    "vpc_options" STRUCT(
        "vpc_id" VARCHAR,
        "subnet_ids" VARCHAR[],
        "availability_zones" VARCHAR[],
        "security_group_ids" VARCHAR[]
    ),
    "status" VARCHAR,
    "endpoint" VARCHAR
)[]
Show child fields
vpc_endpoints[]
Show child fields
vpc_endpoints[].domain_arn

The Amazon Resource Name (ARN) of the domain associated with the endpoint.

vpc_endpoints[].endpoint

The connection endpoint ID for connecting to the domain.

vpc_endpoints[].status

The current status of the endpoint.

vpc_endpoints[].vpc_endpoint_id

The unique identifier of the endpoint.

vpc_endpoints[].vpc_endpoint_owner

The creator of the endpoint.

vpc_endpoints[].vpc_options

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

Show child fields
vpc_endpoints[].vpc_options.availability_zones[]
vpc_endpoints[].vpc_options.security_group_ids[]
vpc_endpoints[].vpc_options.subnet_ids[]
vpc_endpoints[].vpc_options.vpc_id

The ID for your VPC. Amazon VPC generates this value when you create a VPC.