Skip to content
AWS for Query.Farm

aws.apigateway.get_api_key

Example SQL Queries

SELECT * FROM
aws.apigateway.get_api_key
WHERE
"api_key" = 'VALUE';

Description

Gets information about the current ApiKey resource.

Table Definition

Column NameColumn Data Type
api_key Required Input Column

The identifier of the ApiKey resource.

VARCHAR
include_value Input Column

A boolean flag to specify whether (true) or not (false) the result contains the key value.

BOOLEAN
_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
created_date

The timestamp when the API Key was created.

TIMESTAMP_S
customer_id

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

VARCHAR
description

The description of the API Key.

VARCHAR
enabled

Specifies whether the API Key can be used by callers.

BOOLEAN
id

The identifier of the API Key.

VARCHAR
last_updated_date

The timestamp when the API Key was last updated.

TIMESTAMP_S
name

The name of the API Key.

VARCHAR
stage_keys

A list of Stage resources that are associated with the ApiKey resource.

VARCHAR[]
Show child fields
stage_keys[]
tags

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

MAP(VARCHAR, VARCHAR)
value

The value of the API Key.

VARCHAR