Skip to content
AWS for Query.Farm

aws.apigateway.get_resources

Example SQL Queries

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

Description

Lists information about a collection of Resource resources.

Table Definition

Column NameColumn Data Type
rest_api_id Required Input Column

The string identifier of the associated RestApi.

VARCHAR
embed Input Column

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

VARCHAR[]
Show child fields
embed[]
_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
id

The resource's identifier.

VARCHAR
parent_id

The parent resource's identifier.

VARCHAR
path

The full path for this resource.

VARCHAR
path_part

The last path segment for this resource.

VARCHAR
resource_methods

Gets an API resource's method of a given HTTP verb.

MAP(VARCHAR, STRUCT(
        "http_method" VARCHAR,
        "authorization_type" VARCHAR,
        "authorizer_id" VARCHAR,
        "api_key_required" BOOLEAN,
        "request_validator_id" VARCHAR,
        "operation_name" VARCHAR,
        "request_parameters" MAP(VARCHAR, BOOLEAN),
        "request_models" MAP(VARCHAR, VARCHAR),
        "method_responses" MAP(VARCHAR, STRUCT(
                "status_code" VARCHAR,
                "response_parameters" MAP(VARCHAR, BOOLEAN),
                "response_models" MAP(VARCHAR, VARCHAR)
            )),
        "method_integration" STRUCT(
            "type" VARCHAR,
            "http_method" VARCHAR,
            "uri" VARCHAR,
            "connection_type" VARCHAR,
            "connection_id" VARCHAR,
            "credentials" VARCHAR,
            "request_parameters" MAP(VARCHAR, VARCHAR),
            "request_templates" MAP(VARCHAR, VARCHAR),
            "passthrough_behavior" VARCHAR,
            "content_handling" VARCHAR,
            "timeout_in_millis" BIGINT,
            "cache_namespace" VARCHAR,
            "cache_key_parameters" VARCHAR[],
            "integration_responses" MAP(VARCHAR, STRUCT(
                    "status_code" VARCHAR,
                    "selection_pattern" VARCHAR,
                    "response_parameters" MAP(VARCHAR, VARCHAR),
                    "response_templates" MAP(VARCHAR, VARCHAR),
                    "content_handling" VARCHAR
                )),
            "tls_config" STRUCT(
                "insecure_skip_verification" BOOLEAN
            )
        ),
        "authorization_scopes" VARCHAR[]
    ))