Skip to content
AWS for Query.Farm

aws.apigatewayv2.get_stage

Example SQL Queries

SELECT * FROM
aws.apigatewayv2.get_stage
WHERE
"stage_name" = 'VALUE'
AND "api_id" = 'VALUE';

Description

Gets a Stage.

Table Definition

Column NameColumn Data Type
api_id Required Input Column

The API identifier.

VARCHAR
stage_name Required Input Column

The name of the stage.

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.

access_log_settings

Settings for logging access in this stage.

STRUCT(
    "destination_arn" VARCHAR,
    "format" VARCHAR
)
Show child fields
access_log_settings.destination_arn

The ARN of the CloudWatch Logs log group to receive access logs.

access_log_settings.format

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

api_gateway_managed

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

BOOLEAN
auto_deploy

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

BOOLEAN
client_certificate_id

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

VARCHAR
created_date

The timestamp when the stage was created.

TIMESTAMP_S
default_route_settings

Default route settings for the stage.

STRUCT(
    "data_trace_enabled" BOOLEAN,
    "detailed_metrics_enabled" BOOLEAN,
    "logging_level" VARCHAR,
    "throttling_burst_limit" BIGINT,
    "throttling_rate_limit" DOUBLE
)
Show child fields
default_route_settings.data_trace_enabled

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

default_route_settings.detailed_metrics_enabled

Specifies whether detailed metrics are enabled.

default_route_settings.logging_level

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

default_route_settings.throttling_burst_limit

Specifies the throttling burst limit.

default_route_settings.throttling_rate_limit

Specifies the throttling rate limit.

deployment_id

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

VARCHAR
description

The description of the stage.

VARCHAR
last_deployment_status_message

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

VARCHAR
last_updated_date

The timestamp when the stage was last updated.

TIMESTAMP_S
route_settings

Route settings for the stage, by routeKey.

MAP(VARCHAR, STRUCT(
        "data_trace_enabled" BOOLEAN,
        "detailed_metrics_enabled" BOOLEAN,
        "logging_level" VARCHAR,
        "throttling_burst_limit" BIGINT,
        "throttling_rate_limit" DOUBLE
    ))
stage_variables

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

MAP(VARCHAR, VARCHAR)
tags

The collection of tags. Each tag element is associated with a given resource.

MAP(VARCHAR, VARCHAR)