Skip to content
AWS for Query.Farm

aws.apigatewayv2.get_api

Example SQL Queries

SELECT * FROM
aws.apigatewayv2.get_api
WHERE
"api_id" = 'VALUE';

Description

Gets an Api resource.

Table Definition

Column NameColumn Data Type
api_id Required Input Column

The API ID.

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.

api_endpoint

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

VARCHAR
api_gateway_managed

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

BOOLEAN
api_key_selection_expression

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

VARCHAR
cors_configuration

A CORS configuration. Supported only for HTTP APIs.

STRUCT(
    "allow_credentials" BOOLEAN,
    "allow_headers" VARCHAR[],
    "allow_methods" VARCHAR[],
    "allow_origins" VARCHAR[],
    "expose_headers" VARCHAR[],
    "max_age" BIGINT
)
Show child fields
cors_configuration.allow_credentials

Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

cors_configuration.allow_headers[]
cors_configuration.allow_methods[]
cors_configuration.allow_origins[]
cors_configuration.expose_headers[]
cors_configuration.max_age

The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.

created_date

The timestamp when the API was created.

TIMESTAMP_S
description

The description of the API.

VARCHAR
disable_execute_api_endpoint

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

BOOLEAN
disable_schema_validation

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

BOOLEAN
import_info

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

VARCHAR[]
Show child fields
import_info[]
name

The name of the API.

VARCHAR
protocol_type

The API protocol.

VARCHAR
route_selection_expression

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

VARCHAR
tags

A collection of tags associated with the API.

MAP(VARCHAR, VARCHAR)
version

A version identifier for the API.

VARCHAR
warnings

The warning messages reported when failonwarnings is turned on during API import.

VARCHAR[]
Show child fields
warnings[]