Skip to content
AWS for Query.Farm

aws.savingsplans.describe_savings_plans

Example SQL Queries

SELECT * FROM
aws.savingsplans.describe_savings_plans;

Description

Describes the specified Savings Plans.

Table Definition

Column NameColumn Data Type
filters Input Column

The filters.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The filter name.

filters[].values[]
max_results Input Column

The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.

BIGINT
next_token Input Column

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

VARCHAR
savings_plan_arns Input Column

The Amazon Resource Names (ARN) of the Savings Plans.

VARCHAR[]
Show child fields
savings_plan_arns[]
savings_plan_ids Input Column

The IDs of the Savings Plans.

VARCHAR[]
Show child fields
savings_plan_ids[]
states Input Column

The current states of the Savings Plans.

VARCHAR[]
Show child fields
states[]
_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.

savings_plans

Information about the Savings Plans.

STRUCT(
    "offering_id" VARCHAR,
    "savings_plan_id" VARCHAR,
    "savings_plan_arn" VARCHAR,
    "description" VARCHAR,
    "start" VARCHAR,
    "end" VARCHAR,
    "state" VARCHAR,
    "region" VARCHAR,
    "ec2_instance_family" VARCHAR,
    "savings_plan_type" VARCHAR,
    "payment_option" VARCHAR,
    "product_types" VARCHAR[],
    "currency" VARCHAR,
    "commitment" VARCHAR,
    "upfront_payment_amount" VARCHAR,
    "recurring_payment_amount" VARCHAR,
    "term_duration_in_seconds" BIGINT,
    "tags" MAP(VARCHAR, VARCHAR),
    "returnable_until" VARCHAR
)[]
Show child fields
savings_plans[]
Show child fields
savings_plans[].commitment

The hourly commitment amount in the specified currency.

savings_plans[].currency

The currency.

savings_plans[].description

The description.

savings_plans[].ec2_instance_family

The EC2 instance family.

savings_plans[].end

The end time.

savings_plans[].offering_id

The ID of the offering.

savings_plans[].payment_option

The payment option.

savings_plans[].product_types[]
savings_plans[].recurring_payment_amount

The recurring payment amount.

savings_plans[].region

The Amazon Web Services Region.

savings_plans[].returnable_until

The time until when a return for the Savings Plan can be requested. If the Savings Plan is not returnable, the field reflects the Savings Plan start time.

savings_plans[].savings_plan_arn

The Amazon Resource Name (ARN) of the Savings Plan.

savings_plans[].savings_plan_id

The ID of the Savings Plan.

savings_plans[].savings_plan_type

The plan type.

savings_plans[].start

The start time.

savings_plans[].state

The current state.

savings_plans[].tags

One or more tags.

savings_plans[].term_duration_in_seconds

The duration of the term, in seconds.

savings_plans[].upfront_payment_amount

The up-front payment amount.