Skip to content

aws.events.list_endpoints

Example SQL Queries

SELECT * FROM
aws.events.list_endpoints;

Description

List the global endpoints associated with this account. 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
home_region Input Column

The primary Region of the endpoints associated with this account. For example "HomeRegion": "us-east-1".

VARCHAR
max_results Input Column

The maximum number of results returned by the call.

BIGINT
name_prefix Input Column

A value that will return a subset of the endpoints associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

VARCHAR
next_token Input Column

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

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
endpoints

The endpoints returned by the call.

STRUCT(
"name" VARCHAR,
"description" VARCHAR,
"arn" VARCHAR,
"routing_config" STRUCT(
"failover_config" STRUCT(
"primary" STRUCT(
"health_check" VARCHAR
),
"secondary" STRUCT(
"route" VARCHAR
)
)
),
"replication_config" STRUCT(
"state" VARCHAR
),
"event_buses" STRUCT(
"event_bus_arn" VARCHAR
)[],
"role_arn" VARCHAR,
"endpoint_id" VARCHAR,
"endpoint_url" VARCHAR,
"state" VARCHAR,
"state_reason" VARCHAR,
"creation_time" TIMESTAMP_S,
"last_modified_time" TIMESTAMP_S
)[]
Show child fields
endpoints[]
Show child fields
endpoints[].arn

The ARN of the endpoint.

endpoints[].creation_time

The time the endpoint was created.

endpoints[].description

A description for the endpoint.

endpoints[].endpoint_id

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

endpoints[].endpoint_url

The URL of the endpoint.

endpoints[].event_buses[]
Show child fields
endpoints[].event_buses[].event_bus_arn

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

endpoints[].last_modified_time

The last time the endpoint was modified.

endpoints[].name

The name of the endpoint.

endpoints[].replication_config

Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.

Show child fields
endpoints[].replication_config.state

The state of event replication.

endpoints[].role_arn

The ARN of the role used by event replication for the endpoint.

endpoints[].routing_config

The routing configuration of the endpoint.

Show child fields
endpoints[].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
endpoints[].routing_config.failover_config.primary

The main Region of the endpoint.

Show child fields
endpoints[].routing_config.failover_config.primary.health_check

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

endpoints[].routing_config.failover_config.secondary

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

Show child fields
endpoints[].routing_config.failover_config.secondary.route

Defines the secondary Region.

endpoints[].state

The current state of the endpoint.

endpoints[].state_reason

The reason the endpoint is in its current state.