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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb

Overview

Note:

When making an API call, you may pass AnomalyMonitor data as a 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, AGREEMENT_END_DATE_TIME_AFTER, AGREEMENT_END_DATE_TIME_BEFORE
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    tags: {
      key: "TagKey",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, CASE_SENSITIVE, CASE_INSENSITIVE
    },
    cost_categories: {
      key: "CostCategoryName",
      values: ["Value"],
      match_options: ["EQUALS"], # accepts EQUALS, ABSENT, 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_dateString

The date when the monitor was created.

Returns:

  • (String)


235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 235

class AnomalyMonitor < Struct.new(
  :monitor_arn,
  :monitor_name,
  :creation_date,
  :last_updated_date,
  :last_evaluated_date,
  :monitor_type,
  :monitor_dimension,
  :monitor_specification,
  :dimensional_value_count)
  SENSITIVE = []
  include Aws::Structure
end

#dimensional_value_countInteger

The value for evaluated dimensions.

Returns:

  • (Integer)


235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 235

class AnomalyMonitor < Struct.new(
  :monitor_arn,
  :monitor_name,
  :creation_date,
  :last_updated_date,
  :last_evaluated_date,
  :monitor_type,
  :monitor_dimension,
  :monitor_specification,
  :dimensional_value_count)
  SENSITIVE = []
  include Aws::Structure
end

#last_evaluated_dateString

The date when the monitor last evaluated for anomalies.

Returns:

  • (String)


235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 235

class AnomalyMonitor < Struct.new(
  :monitor_arn,
  :monitor_name,
  :creation_date,
  :last_updated_date,
  :last_evaluated_date,
  :monitor_type,
  :monitor_dimension,
  :monitor_specification,
  :dimensional_value_count)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_dateString

The date when the monitor was last updated.

Returns:

  • (String)


235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 235

class AnomalyMonitor < Struct.new(
  :monitor_arn,
  :monitor_name,
  :creation_date,
  :last_updated_date,
  :last_evaluated_date,
  :monitor_type,
  :monitor_dimension,
  :monitor_specification,
  :dimensional_value_count)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_arnString

The Amazon Resource Name (ARN) value.

Returns:

  • (String)


235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 235

class AnomalyMonitor < Struct.new(
  :monitor_arn,
  :monitor_name,
  :creation_date,
  :last_updated_date,
  :last_evaluated_date,
  :monitor_type,
  :monitor_dimension,
  :monitor_specification,
  :dimensional_value_count)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_dimensionString

The dimensions to evaluate.

Returns:

  • (String)


235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 235

class AnomalyMonitor < Struct.new(
  :monitor_arn,
  :monitor_name,
  :creation_date,
  :last_updated_date,
  :last_evaluated_date,
  :monitor_type,
  :monitor_dimension,
  :monitor_specification,
  :dimensional_value_count)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_nameString

The name of the monitor.

Returns:

  • (String)


235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 235

class AnomalyMonitor < Struct.new(
  :monitor_arn,
  :monitor_name,
  :creation_date,
  :last_updated_date,
  :last_evaluated_date,
  :monitor_type,
  :monitor_dimension,
  :monitor_specification,
  :dimensional_value_count)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_specificationTypes::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 the 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.

For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR are not supported. Dimensions are limited to LINKED_ACCOUNT.

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 235

class AnomalyMonitor < Struct.new(
  :monitor_arn,
  :monitor_name,
  :creation_date,
  :last_updated_date,
  :last_evaluated_date,
  :monitor_type,
  :monitor_dimension,
  :monitor_specification,
  :dimensional_value_count)
  SENSITIVE = []
  include Aws::Structure
end

#monitor_typeString

The possible type values.

Returns:

  • (String)


235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb', line 235

class AnomalyMonitor < Struct.new(
  :monitor_arn,
  :monitor_name,
  :creation_date,
  :last_updated_date,
  :last_evaluated_date,
  :monitor_type,
  :monitor_dimension,
  :monitor_specification,
  :dimensional_value_count)
  SENSITIVE = []
  include Aws::Structure
end