Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.
Synopsis
- getDimensionValues :: DateInterval -> Dimension -> GetDimensionValues
- data GetDimensionValues
- gdvNextPageToken :: Lens' GetDimensionValues (Maybe Text)
- gdvContext :: Lens' GetDimensionValues (Maybe Context)
- gdvSearchString :: Lens' GetDimensionValues (Maybe Text)
- gdvTimePeriod :: Lens' GetDimensionValues DateInterval
- gdvDimension :: Lens' GetDimensionValues Dimension
- getDimensionValuesResponse :: Int -> Int -> Int -> GetDimensionValuesResponse
- data GetDimensionValuesResponse
- gdvrsNextPageToken :: Lens' GetDimensionValuesResponse (Maybe Text)
- gdvrsResponseStatus :: Lens' GetDimensionValuesResponse Int
- gdvrsDimensionValues :: Lens' GetDimensionValuesResponse [DimensionValuesWithAttributes]
- gdvrsReturnSize :: Lens' GetDimensionValuesResponse Int
- gdvrsTotalSize :: Lens' GetDimensionValuesResponse Int
Creating a Request
Creates a value of GetDimensionValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdvNextPageToken
- 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.gdvContext
- The context for the call toGetDimensionValues
. This can beRESERVATIONS
orCOST_AND_USAGE
. The default value isCOST_AND_USAGE
. If the context is set toRESERVATIONS
, the resulting dimension values can be used in theGetReservationUtilization
operation. If the context is set toCOST_AND_USAGE
the resulting dimension values can be used in theGetCostAndUsage
operation. If you set the context toCOST_AND_USAGE
, you can use the following dimensions for searching: * AZ - The Availability Zone. An example isus-east-1a
. * DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL. * INSTANCE_TYPE - The type of EC2 instance. An example ism4.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 includeRunInstance
andCreateBucket
. * 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 theGetDimensionValues
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 toRESERVATIONS
, you can use the following dimensions for searching: * AZ - The Availability Zone. An example isus-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 areSingleAZ
andMultiAZ
. * INSTANCE_TYPE - The type of EC2 instance. An example ism4.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.gdvSearchString
- The value that you want to search the filter values for.gdvTimePeriod
- The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, ifstart
is2017-01-01
andend
is2017-05-01
, then the cost and usage data is retrieved from2017-01-01
up to and including2017-04-30
but not including2017-05-01
.gdvDimension
- The name of the dimension. EachDimension
is available for different aContext
. For more information, seeContext
.
data GetDimensionValues Source #
See: getDimensionValues
smart constructor.
Instances
Request Lenses
gdvNextPageToken :: Lens' GetDimensionValues (Maybe Text) Source #
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.
gdvContext :: Lens' GetDimensionValues (Maybe Context) Source #
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.
gdvSearchString :: Lens' GetDimensionValues (Maybe Text) Source #
The value that you want to search the filter values for.
gdvTimePeriod :: Lens' GetDimensionValues DateInterval Source #
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
.
gdvDimension :: Lens' GetDimensionValues Dimension Source #
The name of the dimension. Each Dimension
is available for different a Context
. For more information, see Context
.
Destructuring the Response
getDimensionValuesResponse Source #
Creates a value of GetDimensionValuesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdvrsNextPageToken
- The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.gdvrsResponseStatus
- -- | The response status code.gdvrsDimensionValues
- The filters that you used to filter your request. Some dimensions are available only for a specific context: If you set the context toCOST_AND_USAGE
, you can use the following dimensions for searching: * AZ - The Availability Zone. An example isus-east-1a
. * DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL. * INSTANCE_TYPE - The type of EC2 instance. An example ism4.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 includeRunInstance
andCreateBucket
. * 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 theGetDimensionValues
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 toRESERVATIONS
, you can use the following dimensions for searching: * AZ - The Availability Zone. An example isus-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 areSingleAZ
andMultiAZ
. * INSTANCE_TYPE - The type of EC2 instance. An example ism4.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.gdvrsReturnSize
- The number of results that AWS returned at one time.gdvrsTotalSize
- The total number of search results.
data GetDimensionValuesResponse Source #
See: getDimensionValuesResponse
smart constructor.
Instances
Response Lenses
gdvrsNextPageToken :: Lens' GetDimensionValuesResponse (Maybe Text) Source #
The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.
gdvrsResponseStatus :: Lens' GetDimensionValuesResponse Int Source #
- - | The response status code.
gdvrsDimensionValues :: Lens' GetDimensionValuesResponse [DimensionValuesWithAttributes] Source #
The filters that you used to filter your request. Some dimensions are available only for a specific context: 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.
gdvrsReturnSize :: Lens' GetDimensionValuesResponse Int Source #
The number of results that AWS returned at one time.
gdvrsTotalSize :: Lens' GetDimensionValuesResponse Int Source #
The total number of search results.