Class: Aws::CostExplorer::Types::AnomalyMonitor
- Inherits:
-
Struct
- Object
- Struct
- Aws::CostExplorer::Types::AnomalyMonitor
- Defined in:
- gems/aws-sdk-costexplorer/lib/aws-sdk-costexplorer/types.rb
Overview
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, INVOICING_ENTITY
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. It's 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
-
#creation_date ⇒ String
The date when the monitor was created.
-
#dimensional_value_count ⇒ Integer
The value for evaluated dimensions.
-
#last_evaluated_date ⇒ String
The date when the monitor last evaluated for anomalies.
-
#last_updated_date ⇒ String
The date when the monitor was last updated.
-
#monitor_arn ⇒ String
The Amazon Resource Name (ARN) value.
-
#monitor_dimension ⇒ String
The dimensions to evaluate.
-
#monitor_name ⇒ String
The name of the monitor.
-
#monitor_specification ⇒ Types::Expression
Use
Expression
to filter by cost or by usage. -
#monitor_type ⇒ String
The possible type values.
Instance Attribute Details
#creation_date ⇒ String
The date when the monitor was created.
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_count ⇒ Integer
The value for evaluated dimensions.
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_date ⇒ String
The date when the monitor last evaluated for anomalies.
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_date ⇒ String
The date when the monitor was last updated.
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_arn ⇒ String
The Amazon Resource Name (ARN) value.
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_dimension ⇒ String
The dimensions to evaluate.
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_name ⇒ String
The name of the monitor.
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_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
. ForGetRightsizingRecommendation
, the Region is a full name (for example,REGION==US East (N. Virginia)
. TheExpression
example is as follows:\{ "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
andDimensionValues
objects using eitherwith*
methods orset*
methods in multiple lines.Compound dimension values with logical operations - You can use multiple
Expression
types and the logical operatorsAND/OR/NOT
to create a list of one or moreExpression
objects. By doing this, you can 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)
. TheExpression
for that 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"] \}\}\} ] \}
Because each Expression
can have only one operator, the service returns an error if more than one is specified. The following example shows anExpression
object that creates an error.\{ "And": [ ... ], "DimensionValues": \{ "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] \} \}
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
.
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_type ⇒ String
The possible type values.
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 |