| Column Name | Column Data Type |
|---|
time_period Required Input Column
The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date. | STRUCT(
"start" VARCHAR,
"end" VARCHAR
) |
Show child fields- time_period.end
The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01. - time_period.start
The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.
|
filter Input Column
Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions: -
LINKED_ACCOUNT -
REGION -
SERVICE -
INSTANCE_FAMILY GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together. Cost category is also supported. | STRUCT(
"dimensions" STRUCT(
"key" VARCHAR,
"values" VARCHAR[],
"match_options" VARCHAR[]
),
"tags" STRUCT(
"key" VARCHAR,
"values" VARCHAR[],
"match_options" VARCHAR[]
),
"cost_categories" STRUCT(
"key" VARCHAR,
"values" VARCHAR[],
"match_options" VARCHAR[]
)
) |
Show child fields- filter.cost_categories
The filter that's based on CostCategory values. Show child fields- filter.cost_categories.key
The unique name of the Cost Category. - filter.cost_categories.match_options[]
- filter.cost_categories.values[]
- filter.dimensions
The specific Dimension to use for Expression. Show child fields- filter.dimensions.key
The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones. Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported. LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule. ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions. - filter.dimensions.match_options[]
- filter.dimensions.values[]
- filter.tags
The specific Tag to use for Expression. Show child fields- filter.tags.key
The key for the tag. - filter.tags.match_options[]
- filter.tags.values[]
|
granularity Input Column
The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set. The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY granularities. | VARCHAR |
group_by Input Column
You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE. | STRUCT(
"type" VARCHAR,
"key" VARCHAR
)[] |
Show child fields- group_by[]
Show child fields- group_by[].key
The string that represents a key for a specified group. - group_by[].type
The string that represents the type of group.
|
max_results Input Column
The number of items to be returned in a response. The default is 20, with a minimum value of 1. | BIGINT |
metrics Input Column
The measurement that you want your Savings Plans coverage reported in. The only valid value is SpendCoveredBySavingsPlans. | VARCHAR[] |
Show child fields- metrics[]
|
next_token Input Column
The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size. | VARCHAR |
sort_by Input Column
The value that you want to sort the data by. The following values are supported for Key: The supported values for SortOrder are ASCENDING and DESCENDING. | STRUCT(
"key" VARCHAR,
"sort_order" VARCHAR
) |
Show child fields- sort_by.key
The key that's used to sort the data. - sort_by.sort_order
The order that's used to sort the data.
|
_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_coverages
The amount of spend that your Savings Plans covered. | STRUCT(
"attributes" MAP(VARCHAR, VARCHAR),
"coverage" STRUCT(
"spend_covered_by_savings_plans" VARCHAR,
"on_demand_cost" VARCHAR,
"total_cost" VARCHAR,
"coverage_percentage" VARCHAR
),
"time_period" STRUCT(
"start" VARCHAR,
"end" VARCHAR
)
)[] |
Show child fields- savings_plans_coverages[]
Show child fields- savings_plans_coverages[].attributes
The attribute that applies to a specific Dimension. - savings_plans_coverages[].coverage
The amount of Savings Plans eligible usage that the Savings Plans covered. Show child fields- savings_plans_coverages[].coverage.coverage_percentage
The percentage of your existing Savings Plans covered usage, divided by all of your eligible Savings Plans usage in an account (or set of accounts). - savings_plans_coverages[].coverage.on_demand_cost
The cost of your Amazon Web Services usage at the public On-Demand rate. - savings_plans_coverages[].coverage.spend_covered_by_savings_plans
The amount of your Amazon Web Services usage that's covered by a Savings Plans. - savings_plans_coverages[].coverage.total_cost
The total cost of your Amazon Web Services usage, regardless of your purchase option.
- savings_plans_coverages[].time_period
The time period of the request. Show child fields- savings_plans_coverages[].time_period.end
The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01. - savings_plans_coverages[].time_period.start
The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.
|