Get-CEUsageForecast Cmdlet

Amazon.PowerShell.Cmdlets.CE.AmazonCostExplorerClientCmdlet.ClientConfig

The filters that you want to use to filter your forecast. The GetUsageForecast API supports filtering by the following dimensions:

• AZ
• INSTANCE_TYPE
• LINKED_ACCOUNT
• LINKED_ACCOUNT_NAME
• OPERATION
• PURCHASE_TYPE
• REGION
• SERVICE
• USAGE_TYPE
• USAGE_TYPE_GROUP
• RECORD_TYPE
• OPERATING_SYSTEM
• TENANCY
• SCOPE
• PLATFORM
• SUBSCRIPTION_ID
• LEGAL_ENTITY_NAME
• DEPLOYMENT_OPTION
• DATABASE_ENGINE
• INSTANCE_TYPE_FAMILY
• BILLING_ENTITY
• RESERVATION_ID
• SAVINGS_PLAN_ARN

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

Which metric Cost Explorer uses to create your forecast.Valid values for a GetUsageForecast call are the following:

• USAGE_QUANTITY
• NORMALIZED_USAGE_AMOUNT

Changes the cmdlet behavior to return the value passed to the Metric parameter. The -PassThru parameter is deprecated, use -Select '^Metric' instead. This parameter will be removed in a future version.

Amazon Web Services Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CostExplorer.Model.GetUsageForecastResponse). Specifying the name of a property of type Amazon.CostExplorer.Model.GetUsageForecastResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.

The start and end dates of the period that you want to retrieve usage forecast for. The start date is included in the period, but the end date isn't included in the period. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01. The start date must be equal to or later than the current date to avoid a validation error.

The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.

An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.

The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.

The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.

The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.

The session token if the access and secret keys are temporary session-based credentials.