public static interface GetDimensionValuesRequest.Builder extends CostExplorerRequest.Builder, SdkPojo, CopyableBuilder<GetDimensionValuesRequest.Builder,GetDimensionValuesRequest>
Modifier and Type | Method and Description |
---|---|
GetDimensionValuesRequest.Builder |
context(Context context)
The context for the call to
GetDimensionValues . |
GetDimensionValuesRequest.Builder |
context(String context)
The context for the call to
GetDimensionValues . |
GetDimensionValuesRequest.Builder |
dimension(Dimension dimension)
The name of the dimension.
|
GetDimensionValuesRequest.Builder |
dimension(String dimension)
The name of the dimension.
|
GetDimensionValuesRequest.Builder |
nextPageToken(String nextPageToken)
The token to retrieve the next set of results.
|
GetDimensionValuesRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
GetDimensionValuesRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
GetDimensionValuesRequest.Builder |
searchString(String searchString)
The value that you want to search the filter values for.
|
default GetDimensionValuesRequest.Builder |
timePeriod(Consumer<DateInterval.Builder> timePeriod)
The start and end dates for retrieving the dimension values.
|
GetDimensionValuesRequest.Builder |
timePeriod(DateInterval timePeriod)
The start and end dates for retrieving the dimension values.
|
build
overrideConfiguration
copy
applyMutation, build
GetDimensionValuesRequest.Builder searchString(String searchString)
The value that you want to search the filter values for.
searchString
- The value that you want to search the filter values for.GetDimensionValuesRequest.Builder timePeriod(DateInterval timePeriod)
The start and end dates 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
.
timePeriod
- The start and end dates 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
.default GetDimensionValuesRequest.Builder timePeriod(Consumer<DateInterval.Builder> timePeriod)
The start and end dates 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
.
DateInterval.Builder
avoiding the need to
create one manually via DateInterval.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to timePeriod(DateInterval)
.timePeriod
- a consumer that will call methods on DateInterval.Builder
timePeriod(DateInterval)
GetDimensionValuesRequest.Builder dimension(String dimension)
The name of the dimension. Each Dimension
is available for different a Context
. For
more information, see Context
.
GetDimensionValuesRequest.Builder dimension(Dimension dimension)
The name of the dimension. Each Dimension
is available for different a Context
. For
more information, see Context
.
GetDimensionValuesRequest.Builder context(String 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
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge
.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS 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 AWS 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 EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
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 EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
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 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 AWS ID of the member account.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
REGION - The AWS 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.
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
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge
.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS 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 AWS 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 EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
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 EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
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 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 AWS ID of the member account.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
REGION - The AWS 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.
Context
,
Context
GetDimensionValuesRequest.Builder context(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
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge
.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS 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 AWS 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 EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
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 EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
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 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 AWS ID of the member account.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
REGION - The AWS 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.
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
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge
.
LEGAL_ENTITY_NAME - The name of the organization that sells you AWS 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 AWS 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 EC2 operating system. Examples are Windows or Linux.
PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
SERVICE - The AWS service such as Amazon DynamoDB.
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 EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.
RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
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 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 AWS ID of the member account.
PLATFORM - The EC2 operating system. Examples are Windows or Linux.
REGION - The AWS 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.
Context
,
Context
GetDimensionValuesRequest.Builder nextPageToken(String nextPageToken)
The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.
nextPageToken
- The token to retrieve the next set of results. AWS provides the token when the response from a
previous call has more results than the maximum page size.GetDimensionValuesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.GetDimensionValuesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.