Network.AWS.CostExplorer.GetDimensionValues

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

Creating a Request

getDimensionValues

Arguments

:: DateInterval

gdvTimePeriod

-> Dimension

gdvDimension

-> GetDimensionValues

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 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 - 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, 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 - The name of the dimension. Each Dimension is available for different a Context . For more information, see Context .

data GetDimensionValues

See: getDimensionValues smart constructor.

Instances

Eq GetDimensionValues

Methods

(==) :: GetDimensionValues -> GetDimensionValues -> Bool

(/=) :: GetDimensionValues -> GetDimensionValues -> Bool

Data GetDimensionValues

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDimensionValues -> c GetDimensionValues

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDimensionValues

toConstr :: GetDimensionValues -> Constr

dataTypeOf :: GetDimensionValues -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetDimensionValues)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDimensionValues)

gmapT :: (forall b. Data b => b -> b) -> GetDimensionValues -> GetDimensionValues

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDimensionValues -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDimensionValues -> r

gmapQ :: (forall d. Data d => d -> u) -> GetDimensionValues -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDimensionValues -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDimensionValues -> m GetDimensionValues

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDimensionValues -> m GetDimensionValues

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDimensionValues -> m GetDimensionValues

Read GetDimensionValues

Methods

readsPrec :: Int -> ReadS GetDimensionValues

readList :: ReadS [GetDimensionValues]

readPrec :: ReadPrec GetDimensionValues

readListPrec :: ReadPrec [GetDimensionValues]

Show GetDimensionValues

Methods

showsPrec :: Int -> GetDimensionValues -> ShowS

show :: GetDimensionValues -> String

showList :: [GetDimensionValues] -> ShowS

Generic GetDimensionValues

Associated Types

type Rep GetDimensionValues :: * -> *

Methods

from :: GetDimensionValues -> Rep GetDimensionValues x

to :: Rep GetDimensionValues x -> GetDimensionValues

Hashable GetDimensionValues

Methods

hashWithSalt :: Int -> GetDimensionValues -> Int

hash :: GetDimensionValues -> Int

ToJSON GetDimensionValues

Methods

toJSON :: GetDimensionValues -> Value

toEncoding :: GetDimensionValues -> Encoding

toJSONList :: [GetDimensionValues] -> Value

toEncodingList :: [GetDimensionValues] -> Encoding

NFData GetDimensionValues

Methods

rnf :: GetDimensionValues -> ()

AWSRequest GetDimensionValues

Associated Types

type Rs GetDimensionValues :: *

Methods

request :: GetDimensionValues -> Request GetDimensionValues

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetDimensionValues -> ClientResponse -> m (Response GetDimensionValues)

ToHeaders GetDimensionValues

Methods

toHeaders :: GetDimensionValues -> [Header]

ToPath GetDimensionValues

Methods

toPath :: GetDimensionValues -> ByteString

ToQuery GetDimensionValues

Methods

toQuery :: GetDimensionValues -> QueryString

type Rep GetDimensionValues

type Rep GetDimensionValues = D1 * (MetaData "GetDimensionValues" "Network.AWS.CostExplorer.GetDimensionValues" "amazonka-cost-explorer-1.6.0-1EmcUb6qhvECvPsx1AQih6" False) (C1 * (MetaCons "GetDimensionValues'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gdvNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gdvContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Context)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdvSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdvTimePeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * DateInterval)) (S1 * (MetaSel (Just Symbol "_gdvDimension") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Dimension))))))

type Rs GetDimensionValues

type Rs GetDimensionValues = GetDimensionValuesResponse

Request Lenses

gdvNextPageToken :: Lens' GetDimensionValues (Maybe Text)

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)

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)

The value that you want to search the filter values for.

gdvTimePeriod :: Lens' GetDimensionValues DateInterval

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

The name of the dimension. Each Dimension is available for different a Context . For more information, see Context .

Destructuring the Response

getDimensionValuesResponse

Arguments

:: Int

gdvrsResponseStatus

-> Int

gdvrsReturnSize

-> Int

gdvrsTotalSize

-> GetDimensionValuesResponse

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 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 - The number of results that AWS returned at one time.
• gdvrsTotalSize - The total number of search results.

data GetDimensionValuesResponse

See: getDimensionValuesResponse smart constructor.

Instances

Eq GetDimensionValuesResponse

Methods

(==) :: GetDimensionValuesResponse -> GetDimensionValuesResponse -> Bool

(/=) :: GetDimensionValuesResponse -> GetDimensionValuesResponse -> Bool

Data GetDimensionValuesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetDimensionValuesResponse -> c GetDimensionValuesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetDimensionValuesResponse

toConstr :: GetDimensionValuesResponse -> Constr

dataTypeOf :: GetDimensionValuesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetDimensionValuesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetDimensionValuesResponse)

gmapT :: (forall b. Data b => b -> b) -> GetDimensionValuesResponse -> GetDimensionValuesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetDimensionValuesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetDimensionValuesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetDimensionValuesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetDimensionValuesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetDimensionValuesResponse -> m GetDimensionValuesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDimensionValuesResponse -> m GetDimensionValuesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetDimensionValuesResponse -> m GetDimensionValuesResponse

Read GetDimensionValuesResponse

Methods

readsPrec :: Int -> ReadS GetDimensionValuesResponse

readList :: ReadS [GetDimensionValuesResponse]

readPrec :: ReadPrec GetDimensionValuesResponse

readListPrec :: ReadPrec [GetDimensionValuesResponse]

Show GetDimensionValuesResponse

Methods

showsPrec :: Int -> GetDimensionValuesResponse -> ShowS

show :: GetDimensionValuesResponse -> String

showList :: [GetDimensionValuesResponse] -> ShowS

Generic GetDimensionValuesResponse

Associated Types

type Rep GetDimensionValuesResponse :: * -> *

Methods

from :: GetDimensionValuesResponse -> Rep GetDimensionValuesResponse x

to :: Rep GetDimensionValuesResponse x -> GetDimensionValuesResponse

NFData GetDimensionValuesResponse

Methods

rnf :: GetDimensionValuesResponse -> ()

type Rep GetDimensionValuesResponse

type Rep GetDimensionValuesResponse = D1 * (MetaData "GetDimensionValuesResponse" "Network.AWS.CostExplorer.GetDimensionValues" "amazonka-cost-explorer-1.6.0-1EmcUb6qhvECvPsx1AQih6" False) (C1 * (MetaCons "GetDimensionValuesResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gdvrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gdvrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdvrsDimensionValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [DimensionValuesWithAttributes])) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdvrsReturnSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_gdvrsTotalSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))

Response Lenses

gdvrsNextPageToken :: Lens' GetDimensionValuesResponse (Maybe Text)

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

• - | The response status code.

gdvrsDimensionValues :: Lens' GetDimensionValuesResponse [DimensionValuesWithAttributes]

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

The number of results that AWS returned at one time.

gdvrsTotalSize :: Lens' GetDimensionValuesResponse Int

The total number of search results.