amazonka-cost-explorer-2.0: Amazon Cost Explorer Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CostExplorer.GetDimensionValues

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.

Synopsis

Creating a Request

data GetDimensionValues Source #

See: newGetDimensionValues smart constructor.

Constructors

GetDimensionValues' 

Fields

  • context :: 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.

    • 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.
  • filter' :: Maybe Expression
     
  • maxResults :: Maybe Natural

    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.

  • nextPageToken :: Maybe Text

    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.

  • searchString :: Maybe Text

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

  • sortBy :: Maybe [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.

  • 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.

  • 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.

Instances

Instances details
ToJSON GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

toJSON :: GetDimensionValues -> Value #

toEncoding :: GetDimensionValues -> Encoding #

toJSONList :: [GetDimensionValues] -> Value #

toEncodingList :: [GetDimensionValues] -> Encoding #

ToHeaders GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

toHeaders :: GetDimensionValues -> [Header] #

ToPath GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

toPath :: GetDimensionValues -> ByteString #

ToQuery GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

toQuery :: GetDimensionValues -> QueryString #

AWSRequest GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Associated Types

type AWSResponse GetDimensionValues #

Methods

request :: (Service -> Service) -> GetDimensionValues -> Request GetDimensionValues #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDimensionValues -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDimensionValues))) #

Generic GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Associated Types

type Rep GetDimensionValues :: Type -> Type #

Methods

from :: GetDimensionValues -> Rep GetDimensionValues x #

to :: Rep GetDimensionValues x -> GetDimensionValues #

Read GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

readsPrec :: Int -> ReadS GetDimensionValues #

readList :: ReadS [GetDimensionValues] #

readPrec :: ReadPrec GetDimensionValues #

readListPrec :: ReadPrec [GetDimensionValues] #

Show GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

showsPrec :: Int -> GetDimensionValues -> ShowS #

show :: GetDimensionValues -> String #

showList :: [GetDimensionValues] -> ShowS #

NFData GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

rnf :: GetDimensionValues -> () #

Eq GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

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

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

Hashable GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

hashWithSalt :: Int -> GetDimensionValues -> Int #

hash :: GetDimensionValues -> Int #

type AWSResponse GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

type AWSResponse GetDimensionValues = GetDimensionValuesResponse
type Rep GetDimensionValues Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

type Rep GetDimensionValues = D1 ('MetaData "GetDimensionValues" "Amazonka.CostExplorer.GetDimensionValues" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetDimensionValues'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Context)) :*: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Expression))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "searchString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SortDefinition]))) :*: (S1 ('MetaSel ('Just "timePeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DateInterval) :*: S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Dimension)))))

newGetDimensionValues Source #

Arguments

:: DateInterval

GetDimensionValues

-> Dimension

$sel:dimension:GetDimensionValues'

-> GetDimensionValues 

Create a value of GetDimensionValues with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:context:GetDimensionValues', getDimensionValues_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.

$sel:filter':GetDimensionValues', getDimensionValues_filter - Undocumented member.

$sel:maxResults:GetDimensionValues', getDimensionValues_maxResults - 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.

GetDimensionValues, getDimensionValues_nextPageToken - 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.

$sel:searchString:GetDimensionValues', getDimensionValues_searchString - The value that you want to search the filter values for.

$sel:sortBy:GetDimensionValues', getDimensionValues_sortBy - 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.

GetDimensionValues, getDimensionValues_timePeriod - 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.

$sel:dimension:GetDimensionValues', getDimensionValues_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.

Request Lenses

getDimensionValues_context :: 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.

  • 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.

getDimensionValues_filter :: Lens' GetDimensionValues (Maybe Expression) Source #

Undocumented member.

getDimensionValues_maxResults :: Lens' GetDimensionValues (Maybe Natural) Source #

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.

getDimensionValues_nextPageToken :: Lens' GetDimensionValues (Maybe Text) Source #

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.

getDimensionValues_searchString :: Lens' GetDimensionValues (Maybe Text) Source #

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

getDimensionValues_sortBy :: Lens' GetDimensionValues (Maybe [SortDefinition]) Source #

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.

getDimensionValues_timePeriod :: Lens' GetDimensionValues DateInterval Source #

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.

getDimensionValues_dimension :: Lens' GetDimensionValues Dimension Source #

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.

Destructuring the Response

data GetDimensionValuesResponse Source #

See: newGetDimensionValuesResponse smart constructor.

Constructors

GetDimensionValuesResponse' 

Fields

  • nextPageToken :: Maybe Text

    The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

  • httpStatus :: Int

    The response's http status code.

  • dimensionValues :: [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 Amazon EC2 instance. An example is m4.xlarge.
    • 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 to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
    • SERVICE - The Amazon Web Services 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 Amazon 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.
    • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service. You can opt-in by enabling Hourly and Resource Level Data in Cost Management Console preferences.

    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 - 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 Plan
  • returnSize :: Int

    The number of results that Amazon Web Services returned at one time.

  • totalSize :: Int

    The total number of search results.

Instances

Instances details
Generic GetDimensionValuesResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Associated Types

type Rep GetDimensionValuesResponse :: Type -> Type #

Methods

from :: GetDimensionValuesResponse -> Rep GetDimensionValuesResponse x #

to :: Rep GetDimensionValuesResponse x -> GetDimensionValuesResponse #

Read GetDimensionValuesResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

readsPrec :: Int -> ReadS GetDimensionValuesResponse #

readList :: ReadS [GetDimensionValuesResponse] #

readPrec :: ReadPrec GetDimensionValuesResponse #

readListPrec :: ReadPrec [GetDimensionValuesResponse] #

Show GetDimensionValuesResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

showsPrec :: Int -> GetDimensionValuesResponse -> ShowS #

show :: GetDimensionValuesResponse -> String #

showList :: [GetDimensionValuesResponse] -> ShowS #

NFData GetDimensionValuesResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

rnf :: GetDimensionValuesResponse -> () #

Eq GetDimensionValuesResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

Methods

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

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

type Rep GetDimensionValuesResponse Source # 
Instance details

Defined in Amazonka.CostExplorer.GetDimensionValues

type Rep GetDimensionValuesResponse = D1 ('MetaData "GetDimensionValuesResponse" "Amazonka.CostExplorer.GetDimensionValues" "amazonka-cost-explorer-2.0-QqVzyVvst98QYs5s2Ea4h" 'False) (C1 ('MetaCons "GetDimensionValuesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "dimensionValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DimensionValuesWithAttributes]) :*: (S1 ('MetaSel ('Just "returnSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "totalSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetDimensionValuesResponse Source #

Arguments

:: Int

$sel:httpStatus:GetDimensionValuesResponse'

-> Int

$sel:returnSize:GetDimensionValuesResponse'

-> Int

$sel:totalSize:GetDimensionValuesResponse'

-> GetDimensionValuesResponse 

Create a value of GetDimensionValuesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDimensionValues, getDimensionValuesResponse_nextPageToken - The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

$sel:httpStatus:GetDimensionValuesResponse', getDimensionValuesResponse_httpStatus - The response's http status code.

$sel:dimensionValues:GetDimensionValuesResponse', getDimensionValuesResponse_dimensionValues - 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 Amazon EC2 instance. An example is m4.xlarge.
  • 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 to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
  • SERVICE - The Amazon Web Services 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 Amazon 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.
  • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service. You can opt-in by enabling Hourly and Resource Level Data in Cost Management Console preferences.

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 - 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 Plan

$sel:returnSize:GetDimensionValuesResponse', getDimensionValuesResponse_returnSize - The number of results that Amazon Web Services returned at one time.

$sel:totalSize:GetDimensionValuesResponse', getDimensionValuesResponse_totalSize - The total number of search results.

Response Lenses

getDimensionValuesResponse_nextPageToken :: Lens' GetDimensionValuesResponse (Maybe Text) Source #

The token for the next set of retrievable results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

getDimensionValuesResponse_httpStatus :: Lens' GetDimensionValuesResponse Int Source #

The response's http status code.

getDimensionValuesResponse_dimensionValues :: 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 Amazon EC2 instance. An example is m4.xlarge.
  • 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 to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.
  • SERVICE - The Amazon Web Services 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 Amazon 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.
  • RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14 days for EC2-Compute Service. You can opt-in by enabling Hourly and Resource Level Data in Cost Management Console preferences.

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 - 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 Plan

getDimensionValuesResponse_returnSize :: Lens' GetDimensionValuesResponse Int Source #

The number of results that Amazon Web Services returned at one time.

getDimensionValuesResponse_totalSize :: Lens' GetDimensionValuesResponse Int Source #

The total number of search results.