Skip to content
AWS for Query.Farm

aws.events.describe_endpoint

Example SQL Queries

SELECT * FROM
aws.events.describe_endpoint
WHERE
"name" = 'VALUE';

Description

Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the endpoint you asked for information about.

VARCHAR
home_region Input Column

The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

The ARN of the endpoint you asked for information about.

VARCHAR
creation_time

The time the endpoint you asked for information about was created.

TIMESTAMP_S
description

The description of the endpoint you asked for information about.

VARCHAR
endpoint_id

The ID of the endpoint you asked for information about.

VARCHAR
endpoint_url

The URL of the endpoint you asked for information about.

VARCHAR
event_buses

The event buses being used by the endpoint you asked for information about.

STRUCT(
    "event_bus_arn" VARCHAR
)[]
Show child fields
event_buses[]
Show child fields
event_buses[].event_bus_arn

The ARN of the event bus the endpoint is associated with.

last_modified_time

The last time the endpoint you asked for information about was modified.

TIMESTAMP_S
replication_config

Whether replication is enabled or disabled for the endpoint you asked for information about.

STRUCT(
    "state" VARCHAR
)
Show child fields
replication_config.state

The state of event replication.

role_arn

The ARN of the role used by the endpoint you asked for information about.

VARCHAR
routing_config

The routing configuration of the endpoint you asked for information about.

STRUCT(
    "failover_config" STRUCT(
        "primary" STRUCT(
            "health_check" VARCHAR
        ),
        "secondary" STRUCT(
            "route" VARCHAR
        )
    )
)
Show child fields
routing_config.failover_config

The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

Show child fields
routing_config.failover_config.primary

The main Region of the endpoint.

Show child fields
routing_config.failover_config.primary.health_check

The ARN of the health check used by the endpoint to determine whether failover is triggered.

routing_config.failover_config.secondary

The Region that events are routed to when failover is triggered or event replication is enabled.

Show child fields
routing_config.failover_config.secondary.route

Defines the secondary Region.

state

The current state of the endpoint you asked for information about.

VARCHAR
state_reason

The reason the endpoint you asked for information about is in its current state.

VARCHAR