Class: AWS.CostExplorer

var params = {
  AnomalySubscription: { /* required */
    Frequency: DAILY | IMMEDIATE | WEEKLY, /* required */
    MonitorArnList: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    Subscribers: [ /* required */
      {
        Address: 'STRING_VALUE',
        Status: CONFIRMED | DECLINED,
        Type: EMAIL | SNS
      },
      /* more items */
    ],
    SubscriptionName: 'STRING_VALUE', /* required */
    AccountId: 'STRING_VALUE',
    SubscriptionArn: 'STRING_VALUE',
    Threshold: 'NUMBER_VALUE',
    ThresholdExpression: { /* Expression */
      And: [
        /* recursive Expression */,
        /* more items */
      ],
      CostCategories: {
        Key: 'STRING_VALUE',
        MatchOptions: [
          EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
          /* more items */
        ],
        Values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      Dimensions: {
        Key: AZ | INSTANCE_TYPE | LINKED_ACCOUNT | LINKED_ACCOUNT_NAME | OPERATION | PURCHASE_TYPE | REGION | SERVICE | SERVICE_CODE | USAGE_TYPE | USAGE_TYPE_GROUP | RECORD_TYPE | OPERATING_SYSTEM | TENANCY | SCOPE | PLATFORM | SUBSCRIPTION_ID | LEGAL_ENTITY_NAME | DEPLOYMENT_OPTION | DATABASE_ENGINE | CACHE_ENGINE | INSTANCE_TYPE_FAMILY | BILLING_ENTITY | RESERVATION_ID | RESOURCE_ID | RIGHTSIZING_TYPE | SAVINGS_PLANS_TYPE | SAVINGS_PLAN_ARN | PAYMENT_OPTION | AGREEMENT_END_DATE_TIME_AFTER | AGREEMENT_END_DATE_TIME_BEFORE | INVOICING_ENTITY | ANOMALY_TOTAL_IMPACT_ABSOLUTE | ANOMALY_TOTAL_IMPACT_PERCENTAGE,
        MatchOptions: [
          EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
          /* more items */
        ],
        Values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      Not: /* recursive Expression */,
      Or: [
        /* recursive Expression */,
        /* more items */
      ],
      Tags: {
        Key: 'STRING_VALUE',
        MatchOptions: [
          EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
          /* more items */
        ],
        Values: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  ResourceTags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
costexplorer.createAnomalySubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AnomalySubscription — (map)

    The cost anomaly subscription object that you want to create.

    • SubscriptionArn — (String)

      The AnomalySubscription Amazon Resource Name (ARN).

    • AccountId — (String)

      Your unique account identifier.

    • MonitorArnList — required — (Array<String>)

      A list of cost anomaly monitors.

    • Subscribers — required — (Array<map>)

      A list of subscribers to notify.

      • Address — (String)

        The email address or SNS Amazon Resource Name (ARN). This depends on the Type.

      • Type — (String)

        The notification delivery channel.

        Possible values include:
        • "EMAIL"
        • "SNS"
      • Status — (String)

        Indicates if the subscriber accepts the notifications.

        Possible values include:
        • "CONFIRMED"
        • "DECLINED"
    • Threshold — (Float)

      (deprecated)

      An absolute dollar value that must be exceeded by the anomaly's total impact (see Impact for more details) for an anomaly notification to be generated.

      This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.

      One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.

    • Frequency — required — (String)

      The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications.

      Possible values include:
      • "DAILY"
      • "IMMEDIATE"
      • "WEEKLY"
    • SubscriptionName — required — (String)

      The name for the subscription.

    • ThresholdExpression — (map)

      An Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000 in string format.

      One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.

      The following are examples of valid ThresholdExpressions:

      • Absolute threshold: { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }

      • Percentage threshold: { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }

      • AND two thresholds together: { "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }

      • OR two thresholds together: { "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }

      • Or — (Array<map>)

        Return results that match either Dimension object.

      • And — (Array<map>)

        Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

  • ResourceTags — (Array<map>)

    An optional list of tags to associate with the specified AnomalySubscription . You can use resource tags to control access to your subscription using IAM policies.

    Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

    • Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    • The maximum length of a key is 128 characters

    • The maximum length of a value is 256 characters

    • Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-

    • Keys and values are case sensitive

    • Keys and values are trimmed for any leading or trailing whitespaces

    • Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

    • Key — required — (String)

      The key that's associated with the tag.

    • Value — required — (String)

      The value that's associated with the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • SubscriptionArn — (String)

      The unique identifier of your newly created cost anomaly subscription.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  RuleVersion: CostCategoryExpression.v1, /* required */
  Rules: [ /* required */
    {
      InheritedValue: {
        DimensionKey: 'STRING_VALUE',
        DimensionName: LINKED_ACCOUNT_NAME | TAG
      },
      Rule: { /* Expression */
        And: [
          /* recursive Expression */,
          /* more items */
        ],
        CostCategories: {
          Key: 'STRING_VALUE',
          MatchOptions: [
            EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
            /* more items */
          ],
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Dimensions: {
          Key: AZ | INSTANCE_TYPE | LINKED_ACCOUNT | LINKED_ACCOUNT_NAME | OPERATION | PURCHASE_TYPE | REGION | SERVICE | SERVICE_CODE | USAGE_TYPE | USAGE_TYPE_GROUP | RECORD_TYPE | OPERATING_SYSTEM | TENANCY | SCOPE | PLATFORM | SUBSCRIPTION_ID | LEGAL_ENTITY_NAME | DEPLOYMENT_OPTION | DATABASE_ENGINE | CACHE_ENGINE | INSTANCE_TYPE_FAMILY | BILLING_ENTITY | RESERVATION_ID | RESOURCE_ID | RIGHTSIZING_TYPE | SAVINGS_PLANS_TYPE | SAVINGS_PLAN_ARN | PAYMENT_OPTION | AGREEMENT_END_DATE_TIME_AFTER | AGREEMENT_END_DATE_TIME_BEFORE | INVOICING_ENTITY | ANOMALY_TOTAL_IMPACT_ABSOLUTE | ANOMALY_TOTAL_IMPACT_PERCENTAGE,
          MatchOptions: [
            EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
            /* more items */
          ],
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        },
        Not: /* recursive Expression */,
        Or: [
          /* recursive Expression */,
          /* more items */
        ],
        Tags: {
          Key: 'STRING_VALUE',
          MatchOptions: [
            EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
            /* more items */
          ],
          Values: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      Type: REGULAR | INHERITED_VALUE,
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  DefaultValue: 'STRING_VALUE',
  EffectiveStart: 'STRING_VALUE',
  ResourceTags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  SplitChargeRules: [
    {
      Method: FIXED | PROPORTIONAL | EVEN, /* required */
      Source: 'STRING_VALUE', /* required */
      Targets: [ /* required */
        'STRING_VALUE',
        /* more items */
      ],
      Parameters: [
        {
          Type: ALLOCATION_PERCENTAGES, /* required */
          Values: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
costexplorer.createCostCategoryDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The unique name of the Cost Category.

  • EffectiveStart — (String)

    The Cost Category's effective start date. It can only be a billing start date (first day of the month). If the date isn't provided, it's the first day of the current month. Dates can't be before the previous twelve months, or in the future.

  • RuleVersion — (String)

    The rule schema version in this particular Cost Category.

    Possible values include:
    • "CostCategoryExpression.v1"
  • Rules — (Array<map>)

    The Cost Category rules used to categorize costs. For more information, see CostCategoryRule.

    • Value — (String)

      The default value for the cost category.

    • Rule — (map)

      An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT, SERVICE_CODE, RECORD_TYPE, LINKED_ACCOUNT_NAME, REGION, and USAGE_TYPE.

      RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide.

      • Or — (Array<map>)

        Return results that match either Dimension object.

      • And — (Array<map>)

        Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • InheritedValue — (map)

      The value the line item is categorized as if the line item contains the matched dimension.

      • DimensionName — (String)

        The name of the dimension that's used to group costs.

        If you specify LINKED_ACCOUNT_NAME, the cost category value is based on account name. If you specify TAG, the cost category value is based on the value of the specified tag key.

        Possible values include:
        • "LINKED_ACCOUNT_NAME"
        • "TAG"
      • DimensionKey — (String)

        The key to extract cost category values.

    • Type — (String)

      You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility to define a rule that dynamically inherits the cost category value. This value is from the dimension value that's defined by CostCategoryInheritedValueDimension. For example, suppose that you want to costs to be dynamically grouped based on the value of a specific tag key. First, choose an inherited value rule type, and then choose the tag dimension and specify the tag key to use.

      Possible values include:
      • "REGULAR"
      • "INHERITED_VALUE"
  • DefaultValue — (String)

    The default value for the cost category.

  • SplitChargeRules — (Array<map>)

    The split charge rules used to allocate your charges between your Cost Category values.

    • Source — required — (String)

      The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.

    • Targets — required — (Array<String>)

      The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.

    • Method — required — (String)

      The method that's used to define how to split your source costs across your targets.

      Proportional - Allocates charges across your targets based on the proportional weighted cost of each target.

      Fixed - Allocates charges across your targets based on your defined allocation percentage.

      >Even - Allocates costs evenly across all targets.

      Possible values include:
      • "FIXED"
      • "PROPORTIONAL"
      • "EVEN"
    • Parameters — (Array<map>)

      The parameters for a split charge method. This is only required for the FIXED method.

      • Type — required — (String)

        The parameter type.

        Possible values include:
        • "ALLOCATION_PERCENTAGES"
      • Values — required — (Array<String>)

        The parameter values.

  • ResourceTags — (Array<map>)

    An optional list of tags to associate with the specified CostCategory . You can use resource tags to control access to your cost category using IAM policies.

    Each tag consists of a key and a value, and each key must be unique for the resource. The following restrictions apply to resource tags:

    • Although the maximum number of array members is 200, you can assign a maximum of 50 user-tags to one resource. The remaining are reserved for Amazon Web Services use

    • The maximum length of a key is 128 characters

    • The maximum length of a value is 256 characters

    • Keys and values can only contain alphanumeric characters, spaces, and any of the following: _.:/=+@-

    • Keys and values are case sensitive

    • Keys and values are trimmed for any leading or trailing whitespaces

    • Don’t use aws: as a prefix for your keys. This prefix is reserved for Amazon Web Services use

    • Key — required — (String)

      The key that's associated with the tag.

    • Value — required — (String)

      The value that's associated with the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CostCategoryArn — (String)

      The unique identifier for your newly created Cost Category.

    • EffectiveStart — (String)

      The Cost Category's effective start date. It can only be a billing start date (first day of the month).

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MonitorArn: 'STRING_VALUE' /* required */
};
costexplorer.deleteAnomalyMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorArn — (String)

    The unique identifier of the cost anomaly monitor that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SubscriptionArn: 'STRING_VALUE' /* required */
};
costexplorer.deleteAnomalySubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SubscriptionArn — (String)

    The unique identifier of the cost anomaly subscription that you want to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CostCategoryArn: 'STRING_VALUE' /* required */
};
costexplorer.deleteCostCategoryDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CostCategoryArn — (String)

    The unique identifier for your Cost Category.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CostCategoryArn — (String)

      The unique identifier for your Cost Category.

    • EffectiveEnd — (String)

      The effective end date of the Cost Category as a result of deleting it. No costs after this date is categorized by the deleted Cost Category.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CostCategoryArn: 'STRING_VALUE', /* required */
  EffectiveOn: 'STRING_VALUE'
};
costexplorer.describeCostCategoryDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CostCategoryArn — (String)

    The unique identifier for your Cost Category.

  • EffectiveOn — (String)

    The date when the Cost Category was effective.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CostCategory — (map)

      The structure of Cost Categories. This includes detailed metadata and the set of rules for the CostCategory object.

      • CostCategoryArn — required — (String)

        The unique identifier for your Cost Category.

      • EffectiveStart — required — (String)

        The effective start date of your Cost Category.

      • EffectiveEnd — (String)

        The effective end date of your Cost Category.

      • Name — required — (String)

        The unique name of the Cost Category.

      • RuleVersion — required — (String)

        The rule schema version in this particular Cost Category.

        Possible values include:
        • "CostCategoryExpression.v1"
      • Rules — required — (Array<map>)

        The rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.

        • Value — (String)

          The default value for the cost category.

        • Rule — (map)

          An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT, SERVICE_CODE, RECORD_TYPE, LINKED_ACCOUNT_NAME, REGION, and USAGE_TYPE.

          RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the Billing and Cost Management User Guide.

          • Or — (Array<map>)

            Return results that match either Dimension object.

          • And — (Array<map>)

            Return results that match both Dimension objects.

          • Dimensions — (map)

            The specific Dimension to use for Expression.

            • Key — (String)

              The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

              Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

              LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

              ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

              Possible values include:
              • "AZ"
              • "INSTANCE_TYPE"
              • "LINKED_ACCOUNT"
              • "LINKED_ACCOUNT_NAME"
              • "OPERATION"
              • "PURCHASE_TYPE"
              • "REGION"
              • "SERVICE"
              • "SERVICE_CODE"
              • "USAGE_TYPE"
              • "USAGE_TYPE_GROUP"
              • "RECORD_TYPE"
              • "OPERATING_SYSTEM"
              • "TENANCY"
              • "SCOPE"
              • "PLATFORM"
              • "SUBSCRIPTION_ID"
              • "LEGAL_ENTITY_NAME"
              • "DEPLOYMENT_OPTION"
              • "DATABASE_ENGINE"
              • "CACHE_ENGINE"
              • "INSTANCE_TYPE_FAMILY"
              • "BILLING_ENTITY"
              • "RESERVATION_ID"
              • "RESOURCE_ID"
              • "RIGHTSIZING_TYPE"
              • "SAVINGS_PLANS_TYPE"
              • "SAVINGS_PLAN_ARN"
              • "PAYMENT_OPTION"
              • "AGREEMENT_END_DATE_TIME_AFTER"
              • "AGREEMENT_END_DATE_TIME_BEFORE"
              • "INVOICING_ENTITY"
              • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
              • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
            • Values — (Array<String>)

              The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

            • MatchOptions — (Array<String>)

              The match options that you can use to filter your results.

              MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

              The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

          • Tags — (map)

            The specific Tag to use for Expression.

            • Key — (String)

              The key for the tag.

            • Values — (Array<String>)

              The specific value of the tag.

            • MatchOptions — (Array<String>)

              The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

          • CostCategories — (map)

            The filter that's based on CostCategory values.

            • Key — (String)

              The unique name of the Cost Category.

            • Values — (Array<String>)

              The specific value of the Cost Category.

            • MatchOptions — (Array<String>)

              The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

        • InheritedValue — (map)

          The value the line item is categorized as if the line item contains the matched dimension.

          • DimensionName — (String)

            The name of the dimension that's used to group costs.

            If you specify LINKED_ACCOUNT_NAME, the cost category value is based on account name. If you specify TAG, the cost category value is based on the value of the specified tag key.

            Possible values include:
            • "LINKED_ACCOUNT_NAME"
            • "TAG"
          • DimensionKey — (String)

            The key to extract cost category values.

        • Type — (String)

          You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility to define a rule that dynamically inherits the cost category value. This value is from the dimension value that's defined by CostCategoryInheritedValueDimension. For example, suppose that you want to costs to be dynamically grouped based on the value of a specific tag key. First, choose an inherited value rule type, and then choose the tag dimension and specify the tag key to use.

          Possible values include:
          • "REGULAR"
          • "INHERITED_VALUE"
      • SplitChargeRules — (Array<map>)

        The split charge rules that are used to allocate your charges between your Cost Category values.

        • Source — required — (String)

          The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.

        • Targets — required — (Array<String>)

          The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.

        • Method — required — (String)

          The method that's used to define how to split your source costs across your targets.

          Proportional - Allocates charges across your targets based on the proportional weighted cost of each target.

          Fixed - Allocates charges across your targets based on your defined allocation percentage.

          >Even - Allocates costs evenly across all targets.

          Possible values include:
          • "FIXED"
          • "PROPORTIONAL"
          • "EVEN"
        • Parameters — (Array<map>)

          The parameters for a split charge method. This is only required for the FIXED method.

          • Type — required — (String)

            The parameter type.

            Possible values include:
            • "ALLOCATION_PERCENTAGES"
          • Values — required — (Array<String>)

            The parameter values.

      • ProcessingStatus — (Array<map>)

        The list of processing statuses for Cost Management products for a specific cost category.

        • Component — (String)

          The Cost Management product name of the applied status.

          Possible values include:
          • "COST_EXPLORER"
        • Status — (String)

          The process status for a specific cost category.

          Possible values include:
          • "PROCESSING"
          • "APPLIED"
      • DefaultValue — (String)

        The default value for the cost category.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DateInterval: { /* required */
    StartDate: 'STRING_VALUE', /* required */
    EndDate: 'STRING_VALUE'
  },
  Feedback: YES | NO | PLANNED_ACTIVITY,
  MaxResults: 'NUMBER_VALUE',
  MonitorArn: 'STRING_VALUE',
  NextPageToken: 'STRING_VALUE',
  TotalImpact: {
    NumericOperator: EQUAL | GREATER_THAN_OR_EQUAL | LESS_THAN_OR_EQUAL | GREATER_THAN | LESS_THAN | BETWEEN, /* required */
    StartValue: 'NUMBER_VALUE', /* required */
    EndValue: 'NUMBER_VALUE'
  }
};
costexplorer.getAnomalies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorArn — (String)

    Retrieves all of the cost anomalies detected for a specific cost anomaly monitor Amazon Resource Name (ARN).

  • DateInterval — (map)

    Assigns the start and end dates for retrieving cost anomalies. The returned anomaly object will have an AnomalyEndDate in the specified time range.

    • StartDate — required — (String)

      The first date an anomaly was observed.

    • EndDate — (String)

      The last date an anomaly was observed.

  • Feedback — (String)

    Filters anomaly results by the feedback field on the anomaly object.

    Possible values include:
    • "YES"
    • "NO"
    • "PLANNED_ACTIVITY"
  • TotalImpact — (map)

    Filters anomaly results by the total impact field on the anomaly object. For example, you can filter anomalies GREATER_THAN 200.00 to retrieve anomalies, with an estimated dollar impact greater than 200.

    • NumericOperator — required — (String)

      The comparing value that's used in the filter.

      Possible values include:
      • "EQUAL"
      • "GREATER_THAN_OR_EQUAL"
      • "LESS_THAN_OR_EQUAL"
      • "GREATER_THAN"
      • "LESS_THAN"
      • "BETWEEN"
    • StartValue — required — (Float)

      The lower bound dollar value that's used in the filter.

    • EndValue — (Float)

      The upper bound dollar value that's used in the filter.

  • NextPageToken — (String)

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

  • MaxResults — (Integer)

    The number of entries a paginated response contains.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Anomalies — (Array<map>)

      A list of cost anomalies.

      • AnomalyId — required — (String)

        The unique identifier for the anomaly.

      • AnomalyStartDate — (String)

        The first day the anomaly is detected.

      • AnomalyEndDate — (String)

        The last day the anomaly is detected.

      • DimensionValue — (String)

        The dimension for the anomaly (for example, an Amazon Web Service in a service monitor).

      • RootCauses — (Array<map>)

        The list of identified root causes for the anomaly.

        • Service — (String)

          The Amazon Web Service name that's associated with the cost anomaly.

        • Region — (String)

          The Amazon Web Services Region that's associated with the cost anomaly.

        • LinkedAccount — (String)

          The member account value that's associated with the cost anomaly.

        • UsageType — (String)

          The UsageType value that's associated with the cost anomaly.

        • LinkedAccountName — (String)

          The member account name value that's associated with the cost anomaly.

      • AnomalyScore — required — (map)

        The latest and maximum score for the anomaly.

        • MaxScore — required — (Float)

          The maximum score that's observed during the AnomalyDateInterval.

        • CurrentScore — required — (Float)

          The last observed score.

      • Impact — required — (map)

        The dollar impact for the anomaly.

        • MaxImpact — required — (Float)

          The maximum dollar value that's observed for an anomaly.

        • TotalImpact — (Float)

          The cumulative dollar difference between the total actual spend and total expected spend. It is calculated as TotalActualSpend - TotalExpectedSpend.

        • TotalActualSpend — (Float)

          The cumulative dollar amount that was actually spent during the anomaly.

        • TotalExpectedSpend — (Float)

          The cumulative dollar amount that was expected to be spent during the anomaly. It is calculated using advanced machine learning models to determine the typical spending pattern based on historical data for a customer.

        • TotalImpactPercentage — (Float)

          The cumulative percentage difference between the total actual spend and total expected spend. It is calculated as (TotalImpact / TotalExpectedSpend) * 100. When TotalExpectedSpend is zero, this field is omitted. Expected spend can be zero in situations such as when you start to use a service for the first time.

      • MonitorArn — required — (String)

        The Amazon Resource Name (ARN) for the cost monitor that generated this anomaly.

      • Feedback — (String)

        The feedback value.

        Possible values include:
        • "YES"
        • "NO"
        • "PLANNED_ACTIVITY"
    • NextPageToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  MonitorArnList: [
    'STRING_VALUE',
    /* more items */
  ],
  NextPageToken: 'STRING_VALUE'
};
costexplorer.getAnomalyMonitors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorArnList — (Array<String>)

    A list of cost anomaly monitor ARNs.

  • NextPageToken — (String)

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

  • MaxResults — (Integer)

    The number of entries that a paginated response contains.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalyMonitors — (Array<map>)

      A list of cost anomaly monitors that includes the detailed metadata for each monitor.

      • MonitorArn — (String)

        The Amazon Resource Name (ARN) value.

      • MonitorName — required — (String)

        The name of the monitor.

      • CreationDate — (String)

        The date when the monitor was created.

      • LastUpdatedDate — (String)

        The date when the monitor was last updated.

      • LastEvaluatedDate — (String)

        The date when the monitor last evaluated for anomalies.

      • MonitorType — required — (String)

        The possible type values.

        Possible values include:
        • "DIMENSIONAL"
        • "CUSTOM"
      • MonitorDimension — (String)

        The dimensions to evaluate.

        Possible values include:
        • "SERVICE"
      • MonitorSpecification — (map)

        Use Expression to filter in various Cost Explorer APIs.

        Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

        There are two patterns:

        • Simple dimension values.

          • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

            • Specify the CostCategories field to define a filter that acts on Cost Categories.

            • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

            • Specify the Dimensions field to define a filter that acts on the DimensionValues .

          • For each filter type, you can set the dimension name and values for the filters that you plan to use.

            • For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).

            • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }

            • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

          • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

            • For example, you can filter for linked account names that start with "a".

            • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }

        • Compound Expression types with logical operations.

          • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

          • For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).

          • The corresponding Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

          Note: Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
        Note: For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.
        • Or — (Array<map>)

          Return results that match either Dimension object.

        • And — (Array<map>)

          Return results that match both Dimension objects.

        • Dimensions — (map)

          The specific Dimension to use for Expression.

          • Key — (String)

            The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

            Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

            LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

            ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

            Possible values include:
            • "AZ"
            • "INSTANCE_TYPE"
            • "LINKED_ACCOUNT"
            • "LINKED_ACCOUNT_NAME"
            • "OPERATION"
            • "PURCHASE_TYPE"
            • "REGION"
            • "SERVICE"
            • "SERVICE_CODE"
            • "USAGE_TYPE"
            • "USAGE_TYPE_GROUP"
            • "RECORD_TYPE"
            • "OPERATING_SYSTEM"
            • "TENANCY"
            • "SCOPE"
            • "PLATFORM"
            • "SUBSCRIPTION_ID"
            • "LEGAL_ENTITY_NAME"
            • "DEPLOYMENT_OPTION"
            • "DATABASE_ENGINE"
            • "CACHE_ENGINE"
            • "INSTANCE_TYPE_FAMILY"
            • "BILLING_ENTITY"
            • "RESERVATION_ID"
            • "RESOURCE_ID"
            • "RIGHTSIZING_TYPE"
            • "SAVINGS_PLANS_TYPE"
            • "SAVINGS_PLAN_ARN"
            • "PAYMENT_OPTION"
            • "AGREEMENT_END_DATE_TIME_AFTER"
            • "AGREEMENT_END_DATE_TIME_BEFORE"
            • "INVOICING_ENTITY"
            • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
            • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
          • Values — (Array<String>)

            The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

          • MatchOptions — (Array<String>)

            The match options that you can use to filter your results.

            MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

            The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

        • Tags — (map)

          The specific Tag to use for Expression.

          • Key — (String)

            The key for the tag.

          • Values — (Array<String>)

            The specific value of the tag.

          • MatchOptions — (Array<String>)

            The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

        • CostCategories — (map)

          The filter that's based on CostCategory values.

          • Key — (String)

            The unique name of the Cost Category.

          • Values — (Array<String>)

            The specific value of the Cost Category.

          • MatchOptions — (Array<String>)

            The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

      • DimensionalValueCount — (Integer)

        The value for evaluated dimensions.

    • NextPageToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  MonitorArn: 'STRING_VALUE',
  NextPageToken: 'STRING_VALUE',
  SubscriptionArnList: [
    'STRING_VALUE',
    /* more items */
  ]
};
costexplorer.getAnomalySubscriptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SubscriptionArnList — (Array<String>)

    A list of cost anomaly subscription ARNs.

  • MonitorArn — (String)

    Cost anomaly monitor ARNs.

  • NextPageToken — (String)

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

  • MaxResults — (Integer)

    The number of entries a paginated response contains.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AnomalySubscriptions — (Array<map>)

      A list of cost anomaly subscriptions that includes the detailed metadata for each one.

      • SubscriptionArn — (String)

        The AnomalySubscription Amazon Resource Name (ARN).

      • AccountId — (String)

        Your unique account identifier.

      • MonitorArnList — required — (Array<String>)

        A list of cost anomaly monitors.

      • Subscribers — required — (Array<map>)

        A list of subscribers to notify.

        • Address — (String)

          The email address or SNS Amazon Resource Name (ARN). This depends on the Type.

        • Type — (String)

          The notification delivery channel.

          Possible values include:
          • "EMAIL"
          • "SNS"
        • Status — (String)

          Indicates if the subscriber accepts the notifications.

          Possible values include:
          • "CONFIRMED"
          • "DECLINED"
      • Threshold — (Float)

        (deprecated)

        An absolute dollar value that must be exceeded by the anomaly's total impact (see Impact for more details) for an anomaly notification to be generated.

        This field has been deprecated. To specify a threshold, use ThresholdExpression. Continued use of Threshold will be treated as shorthand syntax for a ThresholdExpression.

        One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.

      • Frequency — required — (String)

        The frequency that anomaly notifications are sent. Notifications are sent either over email (for DAILY and WEEKLY frequencies) or SNS (for IMMEDIATE frequency). For more information, see Creating an Amazon SNS topic for anomaly notifications.

        Possible values include:
        • "DAILY"
        • "IMMEDIATE"
        • "WEEKLY"
      • SubscriptionName — required — (String)

        The name for the subscription.

      • ThresholdExpression — (map)

        An Expression object used to specify the anomalies that you want to generate alerts for. This supports dimensions and nested expressions. The supported dimensions are ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE, corresponding to an anomaly’s TotalImpact and TotalImpactPercentage, respectively (see Impact for more details). The supported nested expression types are AND and OR. The match option GREATER_THAN_OR_EQUAL is required. Values must be numbers between 0 and 10,000,000,000 in string format.

        One of Threshold or ThresholdExpression is required for this resource. You cannot specify both.

        The following are examples of valid ThresholdExpressions:

        • Absolute threshold: { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }

        • Percentage threshold: { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }

        • AND two thresholds together: { "And": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }

        • OR two thresholds together: { "Or": [ { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_ABSOLUTE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } }, { "Dimensions": { "Key": "ANOMALY_TOTAL_IMPACT_PERCENTAGE", "MatchOptions": [ "GREATER_THAN_OR_EQUAL" ], "Values": [ "100" ] } } ] }

        • Or — (Array<map>)

          Return results that match either Dimension object.

        • And — (Array<map>)

          Return results that match both Dimension objects.

        • Dimensions — (map)

          The specific Dimension to use for Expression.

          • Key — (String)

            The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

            Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

            LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

            ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

            Possible values include:
            • "AZ"
            • "INSTANCE_TYPE"
            • "LINKED_ACCOUNT"
            • "LINKED_ACCOUNT_NAME"
            • "OPERATION"
            • "PURCHASE_TYPE"
            • "REGION"
            • "SERVICE"
            • "SERVICE_CODE"
            • "USAGE_TYPE"
            • "USAGE_TYPE_GROUP"
            • "RECORD_TYPE"
            • "OPERATING_SYSTEM"
            • "TENANCY"
            • "SCOPE"
            • "PLATFORM"
            • "SUBSCRIPTION_ID"
            • "LEGAL_ENTITY_NAME"
            • "DEPLOYMENT_OPTION"
            • "DATABASE_ENGINE"
            • "CACHE_ENGINE"
            • "INSTANCE_TYPE_FAMILY"
            • "BILLING_ENTITY"
            • "RESERVATION_ID"
            • "RESOURCE_ID"
            • "RIGHTSIZING_TYPE"
            • "SAVINGS_PLANS_TYPE"
            • "SAVINGS_PLAN_ARN"
            • "PAYMENT_OPTION"
            • "AGREEMENT_END_DATE_TIME_AFTER"
            • "AGREEMENT_END_DATE_TIME_BEFORE"
            • "INVOICING_ENTITY"
            • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
            • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
          • Values — (Array<String>)

            The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

          • MatchOptions — (Array<String>)

            The match options that you can use to filter your results.

            MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

            The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

        • Tags — (map)

          The specific Tag to use for Expression.

          • Key — (String)

            The key for the tag.

          • Values — (Array<String>)

            The specific value of the tag.

          • MatchOptions — (Array<String>)

            The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

        • CostCategories — (map)

          The filter that's based on CostCategory values.

          • Key — (String)

            The unique name of the Cost Category.

          • Values — (Array<String>)

            The specific value of the Cost Category.

          • MatchOptions — (Array<String>)

            The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • NextPageToken — (String)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApproximationDimension: SERVICE | RESOURCE, /* required */
  Granularity: DAILY | MONTHLY | HOURLY, /* required */
  Services: [
    'STRING_VALUE',
    /* more items */
  ]
};
costexplorer.getApproximateUsageRecords(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Granularity — (String)

    How granular you want the data to be. You can enable data at hourly or daily granularity.

    Possible values include:
    • "DAILY"
    • "MONTHLY"
    • "HOURLY"
  • Services — (Array<String>)

    The service metadata for the service or services you want to query. If not specified, all elements are returned.

  • ApproximationDimension — (String)

    The service to evaluate for the usage records. You can choose resource-level data at daily granularity, or hourly granularity with or without resource-level data.

    Possible values include:
    • "SERVICE"
    • "RESOURCE"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Services — (map<Integer>)

      The service metadata for the service or services in the response.

    • TotalRecords — (Integer)

      The total number of usage records for all services in the services list.

    • LookbackPeriod — (map)

      The lookback period that's used for the estimation.

      • Start — required — (String)

        The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

      • End — required — (String)

        The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Granularity: DAILY | MONTHLY | HOURLY, /* required */
  Metrics: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TimePeriod: { /* required */
    End: 'STRING_VALUE', /* required */
    Start: 'STRING_VALUE' /* required */
  },
  Filter: { /* Expression */
    And: [
      /* recursive Expression */,
      /* more items */
    ],
    CostCategories: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Dimensions: {
      Key: AZ | INSTANCE_TYPE | LINKED_ACCOUNT | LINKED_ACCOUNT_NAME | OPERATION | PURCHASE_TYPE | REGION | SERVICE | SERVICE_CODE | USAGE_TYPE | USAGE_TYPE_GROUP | RECORD_TYPE | OPERATING_SYSTEM | TENANCY | SCOPE | PLATFORM | SUBSCRIPTION_ID | LEGAL_ENTITY_NAME | DEPLOYMENT_OPTION | DATABASE_ENGINE | CACHE_ENGINE | INSTANCE_TYPE_FAMILY | BILLING_ENTITY | RESERVATION_ID | RESOURCE_ID | RIGHTSIZING_TYPE | SAVINGS_PLANS_TYPE | SAVINGS_PLAN_ARN | PAYMENT_OPTION | AGREEMENT_END_DATE_TIME_AFTER | AGREEMENT_END_DATE_TIME_BEFORE | INVOICING_ENTITY | ANOMALY_TOTAL_IMPACT_ABSOLUTE | ANOMALY_TOTAL_IMPACT_PERCENTAGE,
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Not: /* recursive Expression */,
    Or: [
      /* recursive Expression */,
      /* more items */
    ],
    Tags: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  GroupBy: [
    {
      Key: 'STRING_VALUE',
      Type: DIMENSION | TAG | COST_CATEGORY
    },
    /* more items */
  ],
  NextPageToken: 'STRING_VALUE'
};
costexplorer.getCostAndUsage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TimePeriod — (map)

    Sets the start date and end date for retrieving Amazon Web Services costs. 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.

    • Start — required — (String)

      The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

    • End — required — (String)

      The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

  • Granularity — (String)

    Sets the Amazon Web Services cost granularity to MONTHLY or DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY, or HOURLY.

    Possible values include:
    • "DAILY"
    • "MONTHLY"
    • "HOURLY"
  • Filter — (map)

    Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

    Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

    Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE.

    • Or — (Array<map>)

      Return results that match either Dimension object.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • And — (Array<map>)

      Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Not — (map)

      Return results that don't match a Dimension object.

      • Or — (Array<map>)

        Return results that match either Dimension object.

      • And — (Array<map>)

        Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Dimensions — (map)

      The specific Dimension to use for Expression.

      • Key — (String)

        The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

        Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

        LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

        ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

        Possible values include:
        • "AZ"
        • "INSTANCE_TYPE"
        • "LINKED_ACCOUNT"
        • "LINKED_ACCOUNT_NAME"
        • "OPERATION"
        • "PURCHASE_TYPE"
        • "REGION"
        • "SERVICE"
        • "SERVICE_CODE"
        • "USAGE_TYPE"
        • "USAGE_TYPE_GROUP"
        • "RECORD_TYPE"
        • "OPERATING_SYSTEM"
        • "TENANCY"
        • "SCOPE"
        • "PLATFORM"
        • "SUBSCRIPTION_ID"
        • "LEGAL_ENTITY_NAME"
        • "DEPLOYMENT_OPTION"
        • "DATABASE_ENGINE"
        • "CACHE_ENGINE"
        • "INSTANCE_TYPE_FAMILY"
        • "BILLING_ENTITY"
        • "RESERVATION_ID"
        • "RESOURCE_ID"
        • "RIGHTSIZING_TYPE"
        • "SAVINGS_PLANS_TYPE"
        • "SAVINGS_PLAN_ARN"
        • "PAYMENT_OPTION"
        • "AGREEMENT_END_DATE_TIME_AFTER"
        • "AGREEMENT_END_DATE_TIME_BEFORE"
        • "INVOICING_ENTITY"
        • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
        • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
      • Values — (Array<String>)

        The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results.

        MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

        The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • Tags — (map)

      The specific Tag to use for Expression.

      • Key — (String)

        The key for the tag.

      • Values — (Array<String>)

        The specific value of the tag.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • CostCategories — (map)

      The filter that's based on CostCategory values.

      • Key — (String)

        The unique name of the Cost Category.

      • Values — (Array<String>)

        The specific value of the Cost Category.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

  • Metrics — (Array<String>)

    Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

    Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

    Note: If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours and GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

    Metrics is required for GetCostAndUsage requests.

  • GroupBy — (Array<map>)

    You can group Amazon Web Services costs using up to two different groups, either dimensions, tag keys, cost categories, or any two group by types.

    Valid values for the DIMENSION type are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, INVOICING_ENTITY, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TENANCY, RECORD_TYPE, and USAGE_TYPE.

    When you group by the TAG type and include a valid tag key, you get all tag values, including empty strings.

    • Type — (String)

      The string that represents the type of group.

      Possible values include:
      • "DIMENSION"
      • "TAG"
      • "COST_CATEGORY"
    • Key — (String)

      The string that represents a key for a specified group.

  • NextPageToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextPageToken — (String)

      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.

    • GroupDefinitions — (Array<map>)

      The groups that are specified by the Filter or GroupBy parameters in the request.

      • Type — (String)

        The string that represents the type of group.

        Possible values include:
        • "DIMENSION"
        • "TAG"
        • "COST_CATEGORY"
      • Key — (String)

        The string that represents a key for a specified group.

    • ResultsByTime — (Array<map>)

      The time period that's covered by the results in the response.

      • TimePeriod — (map)

        The time period that the result covers.

        • Start — required — (String)

          The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

        • End — required — (String)

          The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

      • Total — (map<map>)

        The total amount of cost or usage accrued during the time period.

        • Amount — (String)

          The actual number that represents the metric.

        • Unit — (String)

          The unit that the metric is given in.

      • Groups — (Array<map>)

        The groups that this time period includes.

        • Keys — (Array<String>)

          The keys that are included in this group.

        • Metrics — (map<map>)

          The metrics that are included in this group.

          • Amount — (String)

            The actual number that represents the metric.

          • Unit — (String)

            The unit that the metric is given in.

      • Estimated — (Boolean)

        Determines whether the result is estimated.

    • DimensionValueAttributes — (Array<map>)

      The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.

      • Value — (String)

        The value of a dimension with a specific attribute.

      • Attributes — (map<String>)

        The attribute that applies to a specific Dimension.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filter: { /* Expression */ /* required */
    And: [
      /* recursive Expression */,
      /* more items */
    ],
    CostCategories: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Dimensions: {
      Key: AZ | INSTANCE_TYPE | LINKED_ACCOUNT | LINKED_ACCOUNT_NAME | OPERATION | PURCHASE_TYPE | REGION | SERVICE | SERVICE_CODE | USAGE_TYPE | USAGE_TYPE_GROUP | RECORD_TYPE | OPERATING_SYSTEM | TENANCY | SCOPE | PLATFORM | SUBSCRIPTION_ID | LEGAL_ENTITY_NAME | DEPLOYMENT_OPTION | DATABASE_ENGINE | CACHE_ENGINE | INSTANCE_TYPE_FAMILY | BILLING_ENTITY | RESERVATION_ID | RESOURCE_ID | RIGHTSIZING_TYPE | SAVINGS_PLANS_TYPE | SAVINGS_PLAN_ARN | PAYMENT_OPTION | AGREEMENT_END_DATE_TIME_AFTER | AGREEMENT_END_DATE_TIME_BEFORE | INVOICING_ENTITY | ANOMALY_TOTAL_IMPACT_ABSOLUTE | ANOMALY_TOTAL_IMPACT_PERCENTAGE,
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Not: /* recursive Expression */,
    Or: [
      /* recursive Expression */,
      /* more items */
    ],
    Tags: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  Granularity: DAILY | MONTHLY | HOURLY, /* required */
  TimePeriod: { /* required */
    End: 'STRING_VALUE', /* required */
    Start: 'STRING_VALUE' /* required */
  },
  GroupBy: [
    {
      Key: 'STRING_VALUE',
      Type: DIMENSION | TAG | COST_CATEGORY
    },
    /* more items */
  ],
  Metrics: [
    'STRING_VALUE',
    /* more items */
  ],
  NextPageToken: 'STRING_VALUE'
};
costexplorer.getCostAndUsageWithResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TimePeriod — (map)

    Sets the start and end dates for retrieving Amazon Web Services costs. The range must be within the last 14 days (the start date cannot be earlier than 14 days ago). 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.

    • Start — required — (String)

      The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

    • End — required — (String)

      The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

  • Granularity — (String)

    Sets the Amazon Web Services cost granularity to MONTHLY, DAILY, or HOURLY. If Granularity isn't set, the response object doesn't include the Granularity, MONTHLY, DAILY, or HOURLY.

    Possible values include:
    • "DAILY"
    • "MONTHLY"
    • "HOURLY"
  • Filter — (map)

    Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

    The GetCostAndUsageWithResources operation requires that you either group by or filter by a ResourceId. It requires the Expression "SERVICE = Amazon Elastic Compute Cloud - Compute" in the filter.

    Valid values for MatchOptions for Dimensions are EQUALS and CASE_SENSITIVE.

    Valid values for MatchOptions for CostCategories and Tags are EQUALS, ABSENT, and CASE_SENSITIVE. Default values are EQUALS and CASE_SENSITIVE.

    • Or — (Array<map>)

      Return results that match either Dimension object.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • And — (Array<map>)

      Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Not — (map)

      Return results that don't match a Dimension object.

      • Or — (Array<map>)

        Return results that match either Dimension object.

      • And — (Array<map>)

        Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Dimensions — (map)

      The specific Dimension to use for Expression.

      • Key — (String)

        The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

        Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

        LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

        ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

        Possible values include:
        • "AZ"
        • "INSTANCE_TYPE"
        • "LINKED_ACCOUNT"
        • "LINKED_ACCOUNT_NAME"
        • "OPERATION"
        • "PURCHASE_TYPE"
        • "REGION"
        • "SERVICE"
        • "SERVICE_CODE"
        • "USAGE_TYPE"
        • "USAGE_TYPE_GROUP"
        • "RECORD_TYPE"
        • "OPERATING_SYSTEM"
        • "TENANCY"
        • "SCOPE"
        • "PLATFORM"
        • "SUBSCRIPTION_ID"
        • "LEGAL_ENTITY_NAME"
        • "DEPLOYMENT_OPTION"
        • "DATABASE_ENGINE"
        • "CACHE_ENGINE"
        • "INSTANCE_TYPE_FAMILY"
        • "BILLING_ENTITY"
        • "RESERVATION_ID"
        • "RESOURCE_ID"
        • "RIGHTSIZING_TYPE"
        • "SAVINGS_PLANS_TYPE"
        • "SAVINGS_PLAN_ARN"
        • "PAYMENT_OPTION"
        • "AGREEMENT_END_DATE_TIME_AFTER"
        • "AGREEMENT_END_DATE_TIME_BEFORE"
        • "INVOICING_ENTITY"
        • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
        • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
      • Values — (Array<String>)

        The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results.

        MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

        The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • Tags — (map)

      The specific Tag to use for Expression.

      • Key — (String)

        The key for the tag.

      • Values — (Array<String>)

        The specific value of the tag.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • CostCategories — (map)

      The filter that's based on CostCategory values.

      • Key — (String)

        The unique name of the Cost Category.

      • Values — (Array<String>)

        The specific value of the Cost Category.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

  • Metrics — (Array<String>)

    Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

    Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

    Note: If you return the UsageQuantity metric, the service aggregates all usage numbers without taking the units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hour or GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

    Metrics is required for GetCostAndUsageWithResources requests.

  • GroupBy — (Array<map>)

    You can group Amazon Web Services costs using up to two different groups: DIMENSION, TAG, COST_CATEGORY.

    • Type — (String)

      The string that represents the type of group.

      Possible values include:
      • "DIMENSION"
      • "TAG"
      • "COST_CATEGORY"
    • Key — (String)

      The string that represents a key for a specified group.

  • NextPageToken — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextPageToken — (String)

      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.

    • GroupDefinitions — (Array<map>)

      The groups that are specified by the Filter or GroupBy parameters in the request.

      • Type — (String)

        The string that represents the type of group.

        Possible values include:
        • "DIMENSION"
        • "TAG"
        • "COST_CATEGORY"
      • Key — (String)

        The string that represents a key for a specified group.

    • ResultsByTime — (Array<map>)

      The time period that's covered by the results in the response.

      • TimePeriod — (map)

        The time period that the result covers.

        • Start — required — (String)

          The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

        • End — required — (String)

          The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

      • Total — (map<map>)

        The total amount of cost or usage accrued during the time period.

        • Amount — (String)

          The actual number that represents the metric.

        • Unit — (String)

          The unit that the metric is given in.

      • Groups — (Array<map>)

        The groups that this time period includes.

        • Keys — (Array<String>)

          The keys that are included in this group.

        • Metrics — (map<map>)

          The metrics that are included in this group.

          • Amount — (String)

            The actual number that represents the metric.

          • Unit — (String)

            The unit that the metric is given in.

      • Estimated — (Boolean)

        Determines whether the result is estimated.

    • DimensionValueAttributes — (Array<map>)

      The attributes that apply to a specific dimension value. For example, if the value is a linked account, the attribute is that account name.

      • Value — (String)

        The value of a dimension with a specific attribute.

      • Attributes — (map<String>)

        The attribute that applies to a specific Dimension.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TimePeriod: { /* required */
    End: 'STRING_VALUE', /* required */
    Start: 'STRING_VALUE' /* required */
  },
  CostCategoryName: 'STRING_VALUE',
  Filter: { /* Expression */
    And: [
      /* recursive Expression */,
      /* more items */
    ],
    CostCategories: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Dimensions: {
      Key: AZ | INSTANCE_TYPE | LINKED_ACCOUNT | LINKED_ACCOUNT_NAME | OPERATION | PURCHASE_TYPE | REGION | SERVICE | SERVICE_CODE | USAGE_TYPE | USAGE_TYPE_GROUP | RECORD_TYPE | OPERATING_SYSTEM | TENANCY | SCOPE | PLATFORM | SUBSCRIPTION_ID | LEGAL_ENTITY_NAME | DEPLOYMENT_OPTION | DATABASE_ENGINE | CACHE_ENGINE | INSTANCE_TYPE_FAMILY | BILLING_ENTITY | RESERVATION_ID | RESOURCE_ID | RIGHTSIZING_TYPE | SAVINGS_PLANS_TYPE | SAVINGS_PLAN_ARN | PAYMENT_OPTION | AGREEMENT_END_DATE_TIME_AFTER | AGREEMENT_END_DATE_TIME_BEFORE | INVOICING_ENTITY | ANOMALY_TOTAL_IMPACT_ABSOLUTE | ANOMALY_TOTAL_IMPACT_PERCENTAGE,
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Not: /* recursive Expression */,
    Or: [
      /* recursive Expression */,
      /* more items */
    ],
    Tags: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  MaxResults: 'NUMBER_VALUE',
  NextPageToken: 'STRING_VALUE',
  SearchString: 'STRING_VALUE',
  SortBy: [
    {
      Key: 'STRING_VALUE', /* required */
      SortOrder: ASCENDING | DESCENDING
    },
    /* more items */
  ]
};
costexplorer.getCostCategories(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SearchString — (String)

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

    If you don't specify a CostCategoryName, SearchString is used to filter Cost Category names that match the SearchString pattern. If you specify a CostCategoryName, SearchString is used to filter Cost Category values that match the SearchString pattern.

  • TimePeriod — (map)

    The time period of the request.

    • Start — required — (String)

      The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

    • End — required — (String)

      The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

  • CostCategoryName — (String)

    The unique name of the Cost Category.

  • Filter — (map)

    Use Expression to filter in various Cost Explorer APIs.

    Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

    There are two patterns:

    • Simple dimension values.

      • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

        • Specify the CostCategories field to define a filter that acts on Cost Categories.

        • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

        • Specify the Dimensions field to define a filter that acts on the DimensionValues .

      • For each filter type, you can set the dimension name and values for the filters that you plan to use.

        • For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).

        • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }

        • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

      • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

        • For example, you can filter for linked account names that start with "a".

        • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }

    • Compound Expression types with logical operations.

      • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

      • For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).

      • The corresponding Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

      Note: Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
    Note: For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.
    • Or — (Array<map>)

      Return results that match either Dimension object.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • And — (Array<map>)

      Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Not — (map)

      Return results that don't match a Dimension object.

      • Or — (Array<map>)

        Return results that match either Dimension object.

      • And — (Array<map>)

        Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Dimensions — (map)

      The specific Dimension to use for Expression.

      • Key — (String)

        The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

        Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

        LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

        ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

        Possible values include:
        • "AZ"
        • "INSTANCE_TYPE"
        • "LINKED_ACCOUNT"
        • "LINKED_ACCOUNT_NAME"
        • "OPERATION"
        • "PURCHASE_TYPE"
        • "REGION"
        • "SERVICE"
        • "SERVICE_CODE"
        • "USAGE_TYPE"
        • "USAGE_TYPE_GROUP"
        • "RECORD_TYPE"
        • "OPERATING_SYSTEM"
        • "TENANCY"
        • "SCOPE"
        • "PLATFORM"
        • "SUBSCRIPTION_ID"
        • "LEGAL_ENTITY_NAME"
        • "DEPLOYMENT_OPTION"
        • "DATABASE_ENGINE"
        • "CACHE_ENGINE"
        • "INSTANCE_TYPE_FAMILY"
        • "BILLING_ENTITY"
        • "RESERVATION_ID"
        • "RESOURCE_ID"
        • "RIGHTSIZING_TYPE"
        • "SAVINGS_PLANS_TYPE"
        • "SAVINGS_PLAN_ARN"
        • "PAYMENT_OPTION"
        • "AGREEMENT_END_DATE_TIME_AFTER"
        • "AGREEMENT_END_DATE_TIME_BEFORE"
        • "INVOICING_ENTITY"
        • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
        • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
      • Values — (Array<String>)

        The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results.

        MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

        The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • Tags — (map)

      The specific Tag to use for Expression.

      • Key — (String)

        The key for the tag.

      • Values — (Array<String>)

        The specific value of the tag.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • CostCategories — (map)

      The filter that's based on CostCategory values.

      • Key — (String)

        The unique name of the Cost Category.

      • Values — (Array<String>)

        The specific value of the Cost Category.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

  • SortBy — (Array<map>)

    The value that you sort the data by.

    The key represents the cost and usage metrics. The following values are supported:

    • BlendedCost

    • UnblendedCost

    • AmortizedCost

    • NetAmortizedCost

    • NetUnblendedCost

    • UsageQuantity

    • NormalizedUsageAmount

    The supported key values for the SortOrder value are ASCENDING and DESCENDING.

    When you use the SortBy value, the NextPageToken and SearchString key values aren't supported.

    • Key — required — (String)

      The key that's used to sort the data.

    • SortOrder — (String)

      The order that's used to sort the data.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
  • MaxResults — (Integer)

    This field is only used when the SortBy value is provided in the request.

    The maximum number of objects that are returned for this request. If MaxResults isn't specified with the SortBy value, the request returns 1000 results as the default value for this parameter.

    For GetCostCategories, MaxResults has an upper quota of 1000.

  • NextPageToken — (String)

    If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextPageToken — (String)

      If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • CostCategoryNames — (Array<String>)

      The names of the Cost Categories.

    • CostCategoryValues — (Array<String>)

      The Cost Category values.

      If the CostCategoryName key isn't specified in the request, the CostCategoryValues fields aren't returned.

    • ReturnSize — (Integer)

      The number of objects that are returned.

    • TotalSize — (Integer)

      The total number of objects.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Granularity: DAILY | MONTHLY | HOURLY, /* required */
  Metric: BLENDED_COST | UNBLENDED_COST | AMORTIZED_COST | NET_UNBLENDED_COST | NET_AMORTIZED_COST | USAGE_QUANTITY | NORMALIZED_USAGE_AMOUNT, /* required */
  TimePeriod: { /* required */
    End: 'STRING_VALUE', /* required */
    Start: 'STRING_VALUE' /* required */
  },
  Filter: { /* Expression */
    And: [
      /* recursive Expression */,
      /* more items */
    ],
    CostCategories: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Dimensions: {
      Key: AZ | INSTANCE_TYPE | LINKED_ACCOUNT | LINKED_ACCOUNT_NAME | OPERATION | PURCHASE_TYPE | REGION | SERVICE | SERVICE_CODE | USAGE_TYPE | USAGE_TYPE_GROUP | RECORD_TYPE | OPERATING_SYSTEM | TENANCY | SCOPE | PLATFORM | SUBSCRIPTION_ID | LEGAL_ENTITY_NAME | DEPLOYMENT_OPTION | DATABASE_ENGINE | CACHE_ENGINE | INSTANCE_TYPE_FAMILY | BILLING_ENTITY | RESERVATION_ID | RESOURCE_ID | RIGHTSIZING_TYPE | SAVINGS_PLANS_TYPE | SAVINGS_PLAN_ARN | PAYMENT_OPTION | AGREEMENT_END_DATE_TIME_AFTER | AGREEMENT_END_DATE_TIME_BEFORE | INVOICING_ENTITY | ANOMALY_TOTAL_IMPACT_ABSOLUTE | ANOMALY_TOTAL_IMPACT_PERCENTAGE,
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Not: /* recursive Expression */,
    Or: [
      /* recursive Expression */,
      /* more items */
    ],
    Tags: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  PredictionIntervalLevel: 'NUMBER_VALUE'
};
costexplorer.getCostForecast(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TimePeriod — (map)

    The period of time that you want the forecast to cover. The start date must be equal to or no later than the current date to avoid a validation error.

    • Start — required — (String)

      The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

    • End — required — (String)

      The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

  • Metric — (String)

    Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the "blended" annotation appear on some line items in my bill?.

    Valid values for a GetCostForecast call are the following:

    • AMORTIZED_COST

    • BLENDED_COST

    • NET_AMORTIZED_COST

    • NET_UNBLENDED_COST

    • UNBLENDED_COST

    Possible values include:
    • "BLENDED_COST"
    • "UNBLENDED_COST"
    • "AMORTIZED_COST"
    • "NET_UNBLENDED_COST"
    • "NET_AMORTIZED_COST"
    • "USAGE_QUANTITY"
    • "NORMALIZED_USAGE_AMOUNT"
  • Granularity — (String)

    How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

    The GetCostForecast operation supports only DAILY and MONTHLY granularities.

    Possible values include:
    • "DAILY"
    • "MONTHLY"
    • "HOURLY"
  • Filter — (map)

    The filters that you want to use to filter your forecast. The GetCostForecast API supports filtering by the following dimensions:

    • AZ

    • INSTANCE_TYPE

    • LINKED_ACCOUNT

    • LINKED_ACCOUNT_NAME

    • OPERATION

    • PURCHASE_TYPE

    • REGION

    • SERVICE

    • USAGE_TYPE

    • USAGE_TYPE_GROUP

    • RECORD_TYPE

    • OPERATING_SYSTEM

    • TENANCY

    • SCOPE

    • PLATFORM

    • SUBSCRIPTION_ID

    • LEGAL_ENTITY_NAME

    • DEPLOYMENT_OPTION

    • DATABASE_ENGINE

    • INSTANCE_TYPE_FAMILY

    • BILLING_ENTITY

    • RESERVATION_ID

    • SAVINGS_PLAN_ARN

    • Or — (Array<map>)

      Return results that match either Dimension object.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • And — (Array<map>)

      Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Not — (map)

      Return results that don't match a Dimension object.

      • Or — (Array<map>)

        Return results that match either Dimension object.

      • And — (Array<map>)

        Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Dimensions — (map)

      The specific Dimension to use for Expression.

      • Key — (String)

        The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

        Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

        LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

        ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

        Possible values include:
        • "AZ"
        • "INSTANCE_TYPE"
        • "LINKED_ACCOUNT"
        • "LINKED_ACCOUNT_NAME"
        • "OPERATION"
        • "PURCHASE_TYPE"
        • "REGION"
        • "SERVICE"
        • "SERVICE_CODE"
        • "USAGE_TYPE"
        • "USAGE_TYPE_GROUP"
        • "RECORD_TYPE"
        • "OPERATING_SYSTEM"
        • "TENANCY"
        • "SCOPE"
        • "PLATFORM"
        • "SUBSCRIPTION_ID"
        • "LEGAL_ENTITY_NAME"
        • "DEPLOYMENT_OPTION"
        • "DATABASE_ENGINE"
        • "CACHE_ENGINE"
        • "INSTANCE_TYPE_FAMILY"
        • "BILLING_ENTITY"
        • "RESERVATION_ID"
        • "RESOURCE_ID"
        • "RIGHTSIZING_TYPE"
        • "SAVINGS_PLANS_TYPE"
        • "SAVINGS_PLAN_ARN"
        • "PAYMENT_OPTION"
        • "AGREEMENT_END_DATE_TIME_AFTER"
        • "AGREEMENT_END_DATE_TIME_BEFORE"
        • "INVOICING_ENTITY"
        • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
        • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
      • Values — (Array<String>)

        The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results.

        MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

        The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • Tags — (map)

      The specific Tag to use for Expression.

      • Key — (String)

        The key for the tag.

      • Values — (Array<String>)

        The specific value of the tag.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • CostCategories — (map)

      The filter that's based on CostCategory values.

      • Key — (String)

        The unique name of the Cost Category.

      • Values — (Array<String>)

        The specific value of the Cost Category.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

  • PredictionIntervalLevel — (Integer)

    Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Total — (map)

      How much you are forecasted to spend over the forecast period, in USD.

      • Amount — (String)

        The actual number that represents the metric.

      • Unit — (String)

        The unit that the metric is given in.

    • ForecastResultsByTime — (Array<map>)

      The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.

      • TimePeriod — (map)

        The period of time that the forecast covers.

        • Start — required — (String)

          The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

        • End — required — (String)

          The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

      • MeanValue — (String)

        The mean value of the forecast.

      • PredictionIntervalLowerBound — (String)

        The lower limit for the prediction interval.

      • PredictionIntervalUpperBound — (String)

        The upper limit for the prediction interval.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Dimension: AZ | INSTANCE_TYPE | LINKED_ACCOUNT | LINKED_ACCOUNT_NAME | OPERATION | PURCHASE_TYPE | REGION | SERVICE | SERVICE_CODE | USAGE_TYPE | USAGE_TYPE_GROUP | RECORD_TYPE | OPERATING_SYSTEM | TENANCY | SCOPE | PLATFORM | SUBSCRIPTION_ID | LEGAL_ENTITY_NAME | DEPLOYMENT_OPTION | DATABASE_ENGINE | CACHE_ENGINE | INSTANCE_TYPE_FAMILY | BILLING_ENTITY | RESERVATION_ID | RESOURCE_ID | RIGHTSIZING_TYPE | SAVINGS_PLANS_TYPE | SAVINGS_PLAN_ARN | PAYMENT_OPTION | AGREEMENT_END_DATE_TIME_AFTER | AGREEMENT_END_DATE_TIME_BEFORE | INVOICING_ENTITY | ANOMALY_TOTAL_IMPACT_ABSOLUTE | ANOMALY_TOTAL_IMPACT_PERCENTAGE, /* required */
  TimePeriod: { /* required */
    End: 'STRING_VALUE', /* required */
    Start: 'STRING_VALUE' /* required */
  },
  Context: COST_AND_USAGE | RESERVATIONS | SAVINGS_PLANS,
  Filter: { /* Expression */
    And: [
      /* recursive Expression */,
      /* more items */
    ],
    CostCategories: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Dimensions: {
      Key: AZ | INSTANCE_TYPE | LINKED_ACCOUNT | LINKED_ACCOUNT_NAME | OPERATION | PURCHASE_TYPE | REGION | SERVICE | SERVICE_CODE | USAGE_TYPE | USAGE_TYPE_GROUP | RECORD_TYPE | OPERATING_SYSTEM | TENANCY | SCOPE | PLATFORM | SUBSCRIPTION_ID | LEGAL_ENTITY_NAME | DEPLOYMENT_OPTION | DATABASE_ENGINE | CACHE_ENGINE | INSTANCE_TYPE_FAMILY | BILLING_ENTITY | RESERVATION_ID | RESOURCE_ID | RIGHTSIZING_TYPE | SAVINGS_PLANS_TYPE | SAVINGS_PLAN_ARN | PAYMENT_OPTION | AGREEMENT_END_DATE_TIME_AFTER | AGREEMENT_END_DATE_TIME_BEFORE | INVOICING_ENTITY | ANOMALY_TOTAL_IMPACT_ABSOLUTE | ANOMALY_TOTAL_IMPACT_PERCENTAGE,
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    Not: /* recursive Expression */,
    Or: [
      /* recursive Expression */,
      /* more items */
    ],
    Tags: {
      Key: 'STRING_VALUE',
      MatchOptions: [
        EQUALS | ABSENT | STARTS_WITH | ENDS_WITH | CONTAINS | CASE_SENSITIVE | CASE_INSENSITIVE | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  MaxResults: 'NUMBER_VALUE',
  NextPageToken: 'STRING_VALUE',
  SearchString: 'STRING_VALUE',
  SortBy: [
    {
      Key: 'STRING_VALUE', /* required */
      SortOrder: ASCENDING | DESCENDING
    },
    /* more items */
  ]
};
costexplorer.getDimensionValues(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • SearchString — (String)

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

  • TimePeriod — (map)

    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.

    • Start — required — (String)

      The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01, Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

    • End — required — (String)

      The end of the time period. The end date is exclusive. For example, if end is 2017-05-01, Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

  • Dimension — (String)

    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.

    Possible values include:
    • "AZ"
    • "INSTANCE_TYPE"
    • "LINKED_ACCOUNT"
    • "LINKED_ACCOUNT_NAME"
    • "OPERATION"
    • "PURCHASE_TYPE"
    • "REGION"
    • "SERVICE"
    • "SERVICE_CODE"
    • "USAGE_TYPE"
    • "USAGE_TYPE_GROUP"
    • "RECORD_TYPE"
    • "OPERATING_SYSTEM"
    • "TENANCY"
    • "SCOPE"
    • "PLATFORM"
    • "SUBSCRIPTION_ID"
    • "LEGAL_ENTITY_NAME"
    • "DEPLOYMENT_OPTION"
    • "DATABASE_ENGINE"
    • "CACHE_ENGINE"
    • "INSTANCE_TYPE_FAMILY"
    • "BILLING_ENTITY"
    • "RESERVATION_ID"
    • "RESOURCE_ID"
    • "RIGHTSIZING_TYPE"
    • "SAVINGS_PLANS_TYPE"
    • "SAVINGS_PLAN_ARN"
    • "PAYMENT_OPTION"
    • "AGREEMENT_END_DATE_TIME_AFTER"
    • "AGREEMENT_END_DATE_TIME_BEFORE"
    • "INVOICING_ENTITY"
    • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
    • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
  • Context — (String)

    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.

    Possible values include:
    • "COST_AND_USAGE"
    • "RESERVATIONS"
    • "SAVINGS_PLANS"
  • Filter — (map)

    Use Expression to filter in various Cost Explorer APIs.

    Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

    There are two patterns:

    • Simple dimension values.

      • There are three types of simple dimension values: CostCategories, Tags, and Dimensions.

        • Specify the CostCategories field to define a filter that acts on Cost Categories.

        • Specify the Tags field to define a filter that acts on Cost Allocation Tags.

        • Specify the Dimensions field to define a filter that acts on the DimensionValues .

      • For each filter type, you can set the dimension name and values for the filters that you plan to use.

        • For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).

        • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }

        • As shown in the previous example, lists of dimension values are combined with OR when applying the filter.

      • You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.

        • For example, you can filter for linked account names that start with "a".

        • The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }

    • Compound Expression types with logical operations.

      • You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter by more advanced options.

      • For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).

      • The corresponding Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

      Note: Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error: { "And": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } } The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
    Note: For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE. For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.
    • Or — (Array<map>)

      Return results that match either Dimension object.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • And — (Array<map>)

      Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Not — (map)

      Return results that don't match a Dimension object.

      • Or — (Array<map>)

        Return results that match either Dimension object.

      • And — (Array<map>)

        Return results that match both Dimension objects.

      • Dimensions — (map)

        The specific Dimension to use for Expression.

        • Key — (String)

          The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

          Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

          LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

          ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

          Possible values include:
          • "AZ"
          • "INSTANCE_TYPE"
          • "LINKED_ACCOUNT"
          • "LINKED_ACCOUNT_NAME"
          • "OPERATION"
          • "PURCHASE_TYPE"
          • "REGION"
          • "SERVICE"
          • "SERVICE_CODE"
          • "USAGE_TYPE"
          • "USAGE_TYPE_GROUP"
          • "RECORD_TYPE"
          • "OPERATING_SYSTEM"
          • "TENANCY"
          • "SCOPE"
          • "PLATFORM"
          • "SUBSCRIPTION_ID"
          • "LEGAL_ENTITY_NAME"
          • "DEPLOYMENT_OPTION"
          • "DATABASE_ENGINE"
          • "CACHE_ENGINE"
          • "INSTANCE_TYPE_FAMILY"
          • "BILLING_ENTITY"
          • "RESERVATION_ID"
          • "RESOURCE_ID"
          • "RIGHTSIZING_TYPE"
          • "SAVINGS_PLANS_TYPE"
          • "SAVINGS_PLAN_ARN"
          • "PAYMENT_OPTION"
          • "AGREEMENT_END_DATE_TIME_AFTER"
          • "AGREEMENT_END_DATE_TIME_BEFORE"
          • "INVOICING_ENTITY"
          • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
          • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
        • Values — (Array<String>)

          The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results.

          MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

          The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • Tags — (map)

        The specific Tag to use for Expression.

        • Key — (String)

          The key for the tag.

        • Values — (Array<String>)

          The specific value of the tag.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

      • CostCategories — (map)

        The filter that's based on CostCategory values.

        • Key — (String)

          The unique name of the Cost Category.

        • Values — (Array<String>)

          The specific value of the Cost Category.

        • MatchOptions — (Array<String>)

          The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

    • Dimensions — (map)

      The specific Dimension to use for Expression.

      • Key — (String)

        The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

        Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported.

        LINK_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule.

        ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions.

        Possible values include:
        • "AZ"
        • "INSTANCE_TYPE"
        • "LINKED_ACCOUNT"
        • "LINKED_ACCOUNT_NAME"
        • "OPERATION"
        • "PURCHASE_TYPE"
        • "REGION"
        • "SERVICE"
        • "SERVICE_CODE"
        • "USAGE_TYPE"
        • "USAGE_TYPE_GROUP"
        • "RECORD_TYPE"
        • "OPERATING_SYSTEM"
        • "TENANCY"
        • "SCOPE"
        • "PLATFORM"
        • "SUBSCRIPTION_ID"
        • "LEGAL_ENTITY_NAME"
        • "DEPLOYMENT_OPTION"
        • "DATABASE_ENGINE"
        • "CACHE_ENGINE"
        • "INSTANCE_TYPE_FAMILY"
        • "BILLING_ENTITY"
        • "RESERVATION_ID"
        • "RESOURCE_ID"
        • "RIGHTSIZING_TYPE"
        • "SAVINGS_PLANS_TYPE"
        • "SAVINGS_PLAN_ARN"
        • "PAYMENT_OPTION"
        • "AGREEMENT_END_DATE_TIME_AFTER"
        • "AGREEMENT_END_DATE_TIME_BEFORE"
        • "INVOICING_ENTITY"
        • "ANOMALY_TOTAL_IMPACT_ABSOLUTE"
        • "ANOMALY_TOTAL_IMPACT_PERCENTAGE"
      • Values — (Array<String>)

        The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results.

        MatchOptions is only applicable for actions related to Cost Category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported.

        The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • Tags — (map)

      The specific Tag to use for Expression.

      • Key — (String)

        The key for the tag.

      • Values — (Array<String>)

        The specific value of the tag.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.

    • CostCategories — (map)

      The filter that's based on CostCategory values.

      • Key — (String)

        The unique name of the Cost Category.

      • Values — (Array<String>)

        The specific value of the Cost Category.

      • MatchOptions — (Array<String>)

        The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.

  • SortBy — (Array<map>)

    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.

    • Key — required — (String)

      The key that's used to sort the data.

    • SortOrder — (String)

      The order that's used to sort the data.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
  • MaxResults — (Integer)

    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 — (String)

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