AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Cost Explorer GetDimensionValues API operation.

Syntax

Get-CEDimensionValue
-TimePeriod <DateInterval>
-Context <Context>
-Dimension <Dimension>
-Filter <Expression>
-SearchString <String>
-SortBy <SortDefinition[]>
-MaxResult <Int32>
-NextPageToken <String>
-Select <String>
-PassThru <SwitchParameter>
-ClientConfig <AmazonCostExplorerConfig>

Description

Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

In the AWS.Tools.CostExplorer module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.

Parameters

-ClientConfig <AmazonCostExplorerConfig>
Amazon.PowerShell.Cmdlets.CE.AmazonCostExplorerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Context <Context>
The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
  • AZ - The Availability Zone. An example is us-east-1a.
  • BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible values are the following:- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting reseller for Amazon Web Services in India.- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on Amazon Web Services by third-party software providers.
  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
  • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
  • INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use cases. Examples are Compute Optimized (for example, C4, C5, C6g, and C7g), Memory Optimization (for example, R4, R5n, R5b, and R6g).
  • INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services invoice.
  • LEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services services, such as Amazon Web Services.
  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
  • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
  • OPERATION - The action performed. Examples include RunInstance and CreateBucket.
  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
  • PURCHASE_TYPE - The reservation type of the purchase that this usage is related to. Examples include On-Demand Instances and Standard Reserved Instances.
  • RESERVATION_ID - The unique identifier for an Amazon Web Services Reservation Instance.
  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
  • SERVICE - The Amazon Web Services service such as Amazon DynamoDB.
  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.
  • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
  • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
  • REGION - The Amazon Web Services Region.
  • RECORD_TYPE - The different types of charges such as Reserved Instance (RI) fees, usage costs, tax refunds, and credits.
  • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service.
If you set the context to RESERVATIONS, you can use the following dimensions for searching:
  • AZ - The Availability Zone. An example is us-east-1a.
  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.
  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
  • REGION - The Amazon Web Services Region.
  • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.
  • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.
If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
  • PAYMENT_OPTION - The payment option for the given Savings Plans (for example, All Upfront)
  • REGION - The Amazon Web Services Region.
  • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the Amazon Web Services ID of the member account.
  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Dimension <Dimension>
The name of the dimension. Each Dimension is available for a different Context. For more information, see Context. LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Filter <Expression>
The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxResult <Int32>
This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.For GetDimensionValues, MaxResults has an upper limit of 1000.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxResults
-NextPageToken <String>
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.
Note: In the AWS.Tools.CostExplorer module, this parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, use '-NextPageToken $null' for the first call and '-NextPageToken $AWSHistory.LastServiceResponse.NextPageToken' for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNextToken
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the TimePeriod parameter. The -PassThru parameter is deprecated, use -Select '^TimePeriod' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SearchString <String>
The value that you want to search the filter values for.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
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.GetDimensionValuesResponse). Specifying the name of a property of type Amazon.CostExplorer.Model.GetDimensionValuesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SortBy <SortDefinition[]>
The value that you want to sort the data by.The key represents cost and usage metrics. The following values are supported:
  • BlendedCost
  • UnblendedCost
  • AmortizedCost
  • NetAmortizedCost
  • NetUnblendedCost
  • UsageQuantity
  • NormalizedUsageAmount
The supported values for the SortOrder key are ASCENDING or DESCENDING.When you specify a SortBy paramater, the context must be COST_AND_USAGE. Further, when using SortBy, NextPageToken and SearchString aren't supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimePeriod <DateInterval>
The start date and end date for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. 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.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
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.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.CostExplorer.Model.GetDimensionValuesResponse
This cmdlet returns an Amazon.CostExplorer.Model.GetDimensionValuesResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z