Skip to content
AWS for Query.Farm

aws.apigateway.get_usage_plan

Example SQL Queries

SELECT * FROM
aws.apigateway.get_usage_plan
WHERE
"usage_plan_id" = 'VALUE';

Description

Gets a usage plan of a given plan identifier.

Table Definition

Column NameColumn Data Type
usage_plan_id Required Input Column

The identifier of the UsagePlan resource to be retrieved.

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
api_stages

The associated API stages of a usage plan.

STRUCT(
    "api_id" VARCHAR,
    "stage" VARCHAR,
    "throttle" MAP(VARCHAR, STRUCT(
            "burst_limit" BIGINT,
            "rate_limit" DOUBLE
        ))
)[]
Show child fields
api_stages[]
Show child fields
api_stages[].api_id

API Id of the associated API stage in a usage plan.

api_stages[].stage

API stage name of the associated API stage in a usage plan.

api_stages[].throttle

Map containing method level throttling information for API stage in a usage plan.

description

The description of a usage plan.

VARCHAR
id

The identifier of a UsagePlan resource.

VARCHAR
name

The name of a usage plan.

VARCHAR
product_code

The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

VARCHAR
quota

The target maximum number of permitted requests per a given unit time interval.

STRUCT(
    "limit" BIGINT,
    "offset" BIGINT,
    "period" VARCHAR
)
Show child fields
quota.limit

The target maximum number of requests that can be made in a given time period.

quota.offset

The number of requests subtracted from the given limit in the initial time period.

quota.period

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

tags

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

MAP(VARCHAR, VARCHAR)
throttle

A map containing method level throttling information for API stage in a usage plan.

STRUCT(
    "burst_limit" BIGINT,
    "rate_limit" DOUBLE
)
Show child fields
throttle.burst_limit

The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

throttle.rate_limit

The API target request rate limit.