View a markdown version of this page

SavingsPlansPurchaseAnalysisConfiguration - Amazon Billing and Cost Management
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

SavingsPlansPurchaseAnalysisConfiguration

The configuration for the Savings Plans purchase analysis.

Contents

AnalysisType

The type of analysis.

Type: String

Valid Values: MAX_SAVINGS | CUSTOM_COMMITMENT | TARGET_AVERAGE_COVERAGE

Required: Yes

LookBackTimePeriod

The time period associated with the analysis.

Type: DateInterval object

Required: Yes

SavingsPlansToAdd

Savings Plans to include in the analysis.

Type: Array of SavingsPlans objects

Array Members: Fixed number of 1 item.

Required: Yes

AccountId

The account that the analysis is for.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

AccountScope

The account scope that you want your analysis for.

Type: String

Valid Values: PAYER | LINKED

Required: No

SavingsPlansTargetCoverage

Specifies the target Savings Plans coverage as a percentage from 10 to 100. This field is required when AnalysisType is TARGET_AVERAGE_COVERAGE. It defines the target average hourly coverage that the recommended Savings Plans commitment should achieve over the lookback period.

Type: Integer

Valid Range: Minimum value of 10. Maximum value of 100.

Required: No

SavingsPlansToExclude

Savings Plans to exclude from the analysis.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1000 items.

Length Constraints: Fixed length of 36.

Pattern: ^[\S\s]{8}-[\S\s]{4}-[\S\s]{4}-[\S\s]{4}-[\S\s]{12}$

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: