Skip to content
AWS for Query.Farm

aws.apigateway.get_stages

Example SQL Queries

SELECT * FROM
aws.apigateway.get_stages
WHERE
"rest_api_id" = 'VALUE';

Description

Gets information about one or more Stage resources.

Table Definition

Column NameColumn Data Type
rest_api_id Required Input Column

The string identifier of the associated RestApi.

VARCHAR
deployment_id Input Column

The stages' deployment identifiers.

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
item

The current page of elements from this collection.

STRUCT(
    "deployment_id" VARCHAR,
    "client_certificate_id" VARCHAR,
    "stage_name" VARCHAR,
    "description" VARCHAR,
    "cache_cluster_enabled" BOOLEAN,
    "cache_cluster_size" VARCHAR,
    "cache_cluster_status" VARCHAR,
    "method_settings" MAP(VARCHAR, STRUCT(
            "metrics_enabled" BOOLEAN,
            "logging_level" VARCHAR,
            "data_trace_enabled" BOOLEAN,
            "throttling_burst_limit" BIGINT,
            "throttling_rate_limit" DOUBLE,
            "caching_enabled" BOOLEAN,
            "cache_ttl_in_seconds" BIGINT,
            "cache_data_encrypted" BOOLEAN,
            "require_authorization_for_cache_control" BOOLEAN,
            "unauthorized_cache_control_header_strategy" VARCHAR
        )),
    "variables" MAP(VARCHAR, VARCHAR),
    "documentation_version" VARCHAR,
    "access_log_settings" STRUCT(
        "format" VARCHAR,
        "destination_arn" VARCHAR
    ),
    "canary_settings" STRUCT(
        "percent_traffic" DOUBLE,
        "deployment_id" VARCHAR,
        "stage_variable_overrides" MAP(VARCHAR, VARCHAR),
        "use_stage_cache" BOOLEAN
    ),
    "tracing_enabled" BOOLEAN,
    "web_acl_arn" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "created_date" TIMESTAMP_S,
    "last_updated_date" TIMESTAMP_S
)[]
Show child fields
item[]
Show child fields
item[].access_log_settings

Settings for logging access in this stage.

Show child fields
item[].access_log_settings.destination_arn

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

item[].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.

item[].cache_cluster_enabled

Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.

item[].cache_cluster_size

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

item[].cache_cluster_status

The status of the cache cluster for the stage, if enabled.

item[].canary_settings

Settings for the canary deployment in this stage.

Show child fields
item[].canary_settings.deployment_id

The ID of the canary deployment.

item[].canary_settings.percent_traffic

The percent (0-100) of traffic diverted to a canary deployment.

item[].canary_settings.stage_variable_overrides

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

item[].canary_settings.use_stage_cache

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

item[].client_certificate_id

The identifier of a client certificate for an API stage.

item[].created_date

The timestamp when the stage was created.

item[].deployment_id

The identifier of the Deployment that the stage points to.

item[].description

The stage's description.

item[].documentation_version

The version of the associated API documentation.

item[].last_updated_date

The timestamp when the stage last updated.

item[].method_settings

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

item[].stage_name

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

item[].tags

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

item[].tracing_enabled

Specifies whether active tracing with X-ray is enabled for the Stage.

item[].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-._~:/?#&=,]+.

item[].web_acl_arn

The ARN of the WebAcl associated with the Stage.