Skip to content

AnomalyMonitor

Source code in docs_src/capo_cost_explorer/types/anomaly_monitor.py
class AnomalyMonitor(TypedDict, closed=True):
    monitor_arn: NotRequired["capo_cost_explorer.types.generic_string.GenericString"]
    """<p>The Amazon Resource Name (ARN) value. </p>"""
    monitor_name: "capo_cost_explorer.types.generic_string.GenericString"
    """<p>The name of the monitor. </p>"""
    creation_date: NotRequired["capo_cost_explorer.types.year_month_day.YearMonthDay"]
    """<p>The date when the monitor was created. </p>"""
    last_updated_date: NotRequired[
        "capo_cost_explorer.types.year_month_day.YearMonthDay"
    ]
    """<p>The date when the monitor was last updated. </p>"""
    last_evaluated_date: NotRequired[
        "capo_cost_explorer.types.year_month_day.YearMonthDay"
    ]
    """<p>The date when the monitor last evaluated for anomalies. </p>"""
    monitor_type: "capo_cost_explorer.types.monitor_type.MonitorType"
    """<p>The type of the monitor. </p> <p>Set this to <code>DIMENSIONAL</code> for an Amazon Web Services managed monitor. Amazon Web Services managed monitors automatically track up to the top 5,000 values by cost within a dimension of your choosing. Each dimension value is evaluated independently. If you start incurring cost in a new value of your chosen dimension, it will automatically be analyzed by an Amazon Web Services managed monitor.</p> <p>Set this to <code>CUSTOM</code> for a customer managed monitor. Customer managed monitors let you select specific dimension values that get monitored in aggregate. </p> <p>For more information about monitor types, see <a href="https://docs.aws.amazon.com/cost-management/latest/userguide/getting-started-ad.html#monitor-type-def">Monitor types</a> in the <i>Billing and Cost Management User Guide</i>.</p>"""
    monitor_dimension: NotRequired[
        "capo_cost_explorer.types.monitor_dimension.MonitorDimension"
    ]
    """<p>For customer managed monitors, do not specify this field.</p> <p>For Amazon Web Services managed monitors, this field controls which cost dimension is automatically analyzed by the monitor. For <code>TAG</code> and <code>COST_CATEGORY </code> dimensions, you must also specify MonitorSpecification to configure the specific tag or cost category key to analyze.</p>"""
    monitor_specification: NotRequired["capo_cost_explorer.types.expression.Expression"]
    """<p>An <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html">Expression</a> object used to control what costs the monitor analyzes for anomalies.</p> <p>For Amazon Web Services managed monitors:</p> <ul> <li> <p>If MonitorDimension is <code>SERVICE</code> or <code>LINKED_ACCOUNT</code>, do not specify this field</p> </li> <li> <p>If MonitorDimension is <code>TAG</code>, set this field to <code>{ "Tags": { "Key": "your tag key" } }</code> </p> </li> <li> <p>If MonitorDimension is <code>COST_CATEGORY</code>, set this field to <code>{ "CostCategories": { "Key": "your cost category key" } }</code> </p> </li> </ul> <p>For customer managed monitors:</p> <ul> <li> <p>To track linked accounts, set this field to <code>{ "Dimensions": { "Key": "LINKED_ACCOUNT", "Values": [ "your list of up to 10 account IDs" ] } } </code> </p> </li> <li> <p>To track cost allocation tags, set this field to <code>{ "Tags": { "Key": "your tag key", "Values": [ "your list of up to 10 tag values" ] } } </code> </p> </li> <li> <p>To track cost categories, set this field to<code>{ "CostCategories": { "Key": "your cost category key", "Values": [ "your cost category value" ] } } </code> </p> </li> </ul>"""
    dimensional_value_count: (
        "capo_cost_explorer.types.non_negative_integer.NonNegativeInteger"
    )
    """<p>The value for evaluated dimensions. </p>"""

creation_date instance-attribute

creation_date: NotRequired[YearMonthDay]

The date when the monitor was created.

dimensional_value_count instance-attribute

dimensional_value_count: NonNegativeInteger

The value for evaluated dimensions.

last_evaluated_date instance-attribute

last_evaluated_date: NotRequired[YearMonthDay]

The date when the monitor last evaluated for anomalies.

last_updated_date instance-attribute

last_updated_date: NotRequired[YearMonthDay]

The date when the monitor was last updated.

monitor_arn instance-attribute

monitor_arn: NotRequired[GenericString]

The Amazon Resource Name (ARN) value.

monitor_dimension instance-attribute

monitor_dimension: NotRequired[MonitorDimension]

For customer managed monitors, do not specify this field.

For Amazon Web Services managed monitors, this field controls which cost dimension is automatically analyzed by the monitor. For TAG and COST_CATEGORY dimensions, you must also specify MonitorSpecification to configure the specific tag or cost category key to analyze.

monitor_name instance-attribute

monitor_name: GenericString

The name of the monitor.

monitor_specification instance-attribute

monitor_specification: NotRequired[Expression]

An Expression object used to control what costs the monitor analyzes for anomalies.

For Amazon Web Services managed monitors:

  • If MonitorDimension is SERVICE or LINKED_ACCOUNT, do not specify this field

  • If MonitorDimension is TAG, set this field to { "Tags": { "Key": "your tag key" } }

  • If MonitorDimension is COST_CATEGORY, set this field to { "CostCategories": { "Key": "your cost category key" } }

For customer managed monitors:

  • To track linked accounts, set this field to { "Dimensions": { "Key": "LINKED_ACCOUNT", "Values": [ "your list of up to 10 account IDs" ] } }

  • To track cost allocation tags, set this field to { "Tags": { "Key": "your tag key", "Values": [ "your list of up to 10 tag values" ] } }

  • To track cost categories, set this field to{ "CostCategories": { "Key": "your cost category key", "Values": [ "your cost category value" ] } }

monitor_type instance-attribute

monitor_type: MonitorType

The type of the monitor.

Set this to DIMENSIONAL for an Amazon Web Services managed monitor. Amazon Web Services managed monitors automatically track up to the top 5,000 values by cost within a dimension of your choosing. Each dimension value is evaluated independently. If you start incurring cost in a new value of your chosen dimension, it will automatically be analyzed by an Amazon Web Services managed monitor.

Set this to CUSTOM for a customer managed monitor. Customer managed monitors let you select specific dimension values that get monitored in aggregate.

For more information about monitor types, see Monitor types in the Billing and Cost Management User Guide.