You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CostExplorer::Types::AnomalyMonitor

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AnomalyMonitor as input to an Aws::Client method, you can use a vanilla Hash:

{
  monitor_arn: "GenericString",
  monitor_name: "GenericString", # required
  creation_date: "YearMonthDay",
  last_updated_date: "YearMonthDay",
  last_evaluated_date: "YearMonthDay",
  monitor_type: "DIMENSIONAL", # required, accepts DIMENSIONAL, CUSTOM
  monitor_dimension: "SERVICE", # accepts SERVICE
  monitor_specification: {
    or: [
      {
        # recursive Expression
      },
    ],
    and: [
      {
        # recursive Expression
      },
    ],
    not: {
      # recursive Expression
    },
    dimensions: {
      key: "AZ", # accepts 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
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    cost_categories: {
      key: "CostCategoryName",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
  },
  dimensional_value_count: 1,
}

This object continuously inspects your account's cost data for anomalies, based on MonitorType and MonitorSpecification. The content consists of detailed metadata and the current status of the monitor object.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date ⇒ String

The date when the monitor was created.

Returns:

  • (String) —

    The date when the monitor was created.

#dimensional_value_count ⇒ Integer

The value for evaluated dimensions.

Returns:

  • (Integer) —

    The value for evaluated dimensions.

#last_evaluated_date ⇒ String

The date when the monitor last evaluated for anomalies.

Returns:

  • (String) —

    The date when the monitor last evaluated for anomalies.

#last_updated_date ⇒ String

The date when the monitor was last updated.

Returns:

  • (String) —

    The date when the monitor was last updated.

#monitor_arn ⇒ String

The Amazon Resource Name (ARN) value.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) value.

#monitor_dimension ⇒ String

The dimensions to evaluate.

Possible values:

  • SERVICE

Returns:

  • (String) —

    The dimensions to evaluate.

#monitor_name ⇒ String

The name of the monitor.

Returns:

  • (String) —

    The name of the monitor.

#monitor_specification ⇒ Types::Expression

Use Expression to filter by cost or by usage. There are two patterns:

  • Simple dimension values - 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 Expression example looks like:

    { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } }

    The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with methods or set methods in multiple lines.

  • Compound dimension values 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. This allows you to filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that looks like this:

    { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

    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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

For GetRightsizingRecommendation action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

Returns:

#monitor_type ⇒ String

The possible type values.

Possible values:

  • DIMENSIONAL
  • CUSTOM

Returns:

  • (String) —

    The possible type values.