Skip to content
AWS for Query.Farm

aws.events.list_api_destinations

Example SQL Queries

SELECT * FROM
aws.events.list_api_destinations;

Description

Retrieves a list of API destination in the account in the current Region.

Table Definition

Column NameColumn Data Type
connection_arn Input Column

The ARN of the connection specified for the API destination.

VARCHAR
limit Input Column

The maximum number of API destinations to include in the response.

BIGINT
name_prefix Input Column

A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.

VARCHAR
next_token Input Column

A token you can use in a subsequent request to retrieve the next set of results.

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
api_destinations

An array of ApiDestination objects that include information about an API destination.

STRUCT(
    "api_destination_arn" VARCHAR,
    "name" VARCHAR,
    "api_destination_state" VARCHAR,
    "connection_arn" VARCHAR,
    "invocation_endpoint" VARCHAR,
    "http_method" VARCHAR,
    "invocation_rate_limit_per_second" BIGINT,
    "creation_time" TIMESTAMP_S,
    "last_modified_time" TIMESTAMP_S
)[]
Show child fields
api_destinations[]
Show child fields
api_destinations[].api_destination_arn

The ARN of the API destination.

api_destinations[].api_destination_state

The state of the API destination.

api_destinations[].connection_arn

The ARN of the connection specified for the API destination.

api_destinations[].creation_time

A time stamp for the time that the API destination was created.

api_destinations[].http_method

The method to use to connect to the HTTP endpoint.

api_destinations[].invocation_endpoint

The URL to the endpoint for the API destination.

api_destinations[].invocation_rate_limit_per_second

The maximum number of invocations per second to send to the HTTP endpoint.

api_destinations[].last_modified_time

A time stamp for the time that the API destination was last modified.

api_destinations[].name

The name of the API destination.