Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudWatch

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of CloudWatchClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

deleteAlarms

  • Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

    In the event of an error, no alarms are deleted.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    Parameters

    Returns Promise<DeleteAlarmsCommandOutput>

  • Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

    In the event of an error, no alarms are deleted.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    Parameters

    Returns void

  • Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

    In the event of an error, no alarms are deleted.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    Parameters

    Returns void

  • Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

    In the event of an error, no alarms are deleted.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    Parameters

    • args: DeleteAlarmsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteAlarmsCommandOutput>

  • Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

    In the event of an error, no alarms are deleted.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    Parameters

    Returns void

  • Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

    In the event of an error, no alarms are deleted.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    Parameters

    Returns void

  • Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

    In the event of an error, no alarms are deleted.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    Parameters

    • args: DeleteAlarmsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteAlarmsCommandOutput>

  • Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

    In the event of an error, no alarms are deleted.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    Parameters

    Returns void

  • Deletes the specified alarms. You can delete up to 100 alarms in one operation. However, this total can include no more than one composite alarm. For example, you could delete 99 metric alarms and one composite alarms with one operation, but you can't delete two composite alarms with one operation.

    In the event of an error, no alarms are deleted.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    Parameters

    Returns void

deleteAnomalyDetector

deleteDashboards

  • Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

    Parameters

    Returns Promise<DeleteDashboardsCommandOutput>

  • Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

    Parameters

    Returns void

  • Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

    Parameters

    Returns void

  • Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

    Parameters

    • args: DeleteDashboardsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteDashboardsCommandOutput>

  • Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

    Parameters

    Returns void

  • Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

    Parameters

    Returns void

  • Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

    Parameters

    • args: DeleteDashboardsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteDashboardsCommandOutput>

  • Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

    Parameters

    Returns void

  • Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

    Parameters

    Returns void

deleteInsightRules

  • Permanently deletes the specified Contributor Insights rules.

    If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

    Parameters

    Returns Promise<DeleteInsightRulesCommandOutput>

  • Permanently deletes the specified Contributor Insights rules.

    If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

    Parameters

    Returns void

  • Permanently deletes the specified Contributor Insights rules.

    If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

    Parameters

    Returns void

  • Permanently deletes the specified Contributor Insights rules.

    If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

    Parameters

    • args: DeleteInsightRulesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteInsightRulesCommandOutput>

  • Permanently deletes the specified Contributor Insights rules.

    If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

    Parameters

    Returns void

  • Permanently deletes the specified Contributor Insights rules.

    If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

    Parameters

    Returns void

  • Permanently deletes the specified Contributor Insights rules.

    If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

    Parameters

    • args: DeleteInsightRulesCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteInsightRulesCommandOutput>

  • Permanently deletes the specified Contributor Insights rules.

    If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

    Parameters

    Returns void

  • Permanently deletes the specified Contributor Insights rules.

    If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

    Parameters

    Returns void

deleteMetricStream

describeAlarmHistory

  • Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

    CloudWatch retains the history of an alarm even if you delete the alarm.

    To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

    Parameters

    Returns Promise<DescribeAlarmHistoryCommandOutput>

  • Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

    CloudWatch retains the history of an alarm even if you delete the alarm.

    To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

    CloudWatch retains the history of an alarm even if you delete the alarm.

    To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

    CloudWatch retains the history of an alarm even if you delete the alarm.

    To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

    Parameters

    • args: DescribeAlarmHistoryCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeAlarmHistoryCommandOutput>

  • Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

    CloudWatch retains the history of an alarm even if you delete the alarm.

    To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

    CloudWatch retains the history of an alarm even if you delete the alarm.

    To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

    CloudWatch retains the history of an alarm even if you delete the alarm.

    To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

    Parameters

    • args: DescribeAlarmHistoryCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeAlarmHistoryCommandOutput>

  • Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

    CloudWatch retains the history of an alarm even if you delete the alarm.

    To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

    CloudWatch retains the history of an alarm even if you delete the alarm.

    To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

    Parameters

    Returns void

describeAlarms

  • Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

    To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

    Parameters

    Returns Promise<DescribeAlarmsCommandOutput>

  • Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

    To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

    To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

    To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

    Parameters

    • args: DescribeAlarmsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeAlarmsCommandOutput>

  • Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

    To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

    To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

    To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

    Parameters

    • args: DescribeAlarmsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeAlarmsCommandOutput>

  • Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

    To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

    Parameters

    Returns void

  • Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

    To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

    Parameters

    Returns void

describeAlarmsForMetric

  • Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

    This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

    Parameters

    Returns Promise<DescribeAlarmsForMetricCommandOutput>

  • Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

    This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

    Parameters

    Returns void

  • Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

    This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

    Parameters

    Returns void

  • Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

    This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

    Parameters

    • args: DescribeAlarmsForMetricCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeAlarmsForMetricCommandOutput>

  • Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

    This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

    Parameters

    Returns void

  • Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

    This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

    Parameters

    Returns void

  • Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

    This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

    Parameters

    • args: DescribeAlarmsForMetricCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeAlarmsForMetricCommandOutput>

  • Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

    This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

    Parameters

    Returns void

  • Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

    This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

    Parameters

    Returns void

describeAnomalyDetectors

  • Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

    Parameters

    Returns Promise<DescribeAnomalyDetectorsCommandOutput>

  • Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

    Parameters

    Returns void

  • Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

    Parameters

    Returns void

  • Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

    Parameters

    • args: DescribeAnomalyDetectorsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeAnomalyDetectorsCommandOutput>

  • Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

    Parameters

    Returns void

  • Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

    Parameters

    Returns void

  • Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

    Parameters

    • args: DescribeAnomalyDetectorsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeAnomalyDetectorsCommandOutput>

  • Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

    Parameters

    Returns void

  • Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

    Parameters

    Returns void

describeInsightRules

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

disableAlarmActions

disableInsightRules

enableAlarmActions

enableInsightRules

getDashboard

  • Displays the details of the dashboard that you specify.

    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

    Parameters

    Returns Promise<GetDashboardCommandOutput>

  • Displays the details of the dashboard that you specify.

    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

    Parameters

    Returns void

  • Displays the details of the dashboard that you specify.

    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

    Parameters

    Returns void

  • Displays the details of the dashboard that you specify.

    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

    Parameters

    • args: GetDashboardCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetDashboardCommandOutput>

  • Displays the details of the dashboard that you specify.

    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

    Parameters

    Returns void

  • Displays the details of the dashboard that you specify.

    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

    Parameters

    Returns void

  • Displays the details of the dashboard that you specify.

    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

    Parameters

    • args: GetDashboardCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetDashboardCommandOutput>

  • Displays the details of the dashboard that you specify.

    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

    Parameters

    Returns void

  • Displays the details of the dashboard that you specify.

    To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

    Parameters

    Returns void

getInsightRuleReport

  • This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

    You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

    • UniqueContributors -- the number of unique contributors for each data point.

    • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

    • SampleCount -- the number of data points matched by the rule.

    • Sum -- the sum of the values from all contributors during the time period represented by that data point.

    • Minimum -- the minimum value from a single observation during the time period represented by that data point.

    • Maximum -- the maximum value from a single observation during the time period represented by that data point.

    • Average -- the average value from all contributors during the time period represented by that data point.

    Parameters

    Returns Promise<GetInsightRuleReportCommandOutput>

  • This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

    You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

    • UniqueContributors -- the number of unique contributors for each data point.

    • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

    • SampleCount -- the number of data points matched by the rule.

    • Sum -- the sum of the values from all contributors during the time period represented by that data point.

    • Minimum -- the minimum value from a single observation during the time period represented by that data point.

    • Maximum -- the maximum value from a single observation during the time period represented by that data point.

    • Average -- the average value from all contributors during the time period represented by that data point.

    Parameters

    Returns void

  • This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

    You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

    • UniqueContributors -- the number of unique contributors for each data point.

    • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

    • SampleCount -- the number of data points matched by the rule.

    • Sum -- the sum of the values from all contributors during the time period represented by that data point.

    • Minimum -- the minimum value from a single observation during the time period represented by that data point.

    • Maximum -- the maximum value from a single observation during the time period represented by that data point.

    • Average -- the average value from all contributors during the time period represented by that data point.

    Parameters

    Returns void

  • This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

    You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

    • UniqueContributors -- the number of unique contributors for each data point.

    • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

    • SampleCount -- the number of data points matched by the rule.

    • Sum -- the sum of the values from all contributors during the time period represented by that data point.

    • Minimum -- the minimum value from a single observation during the time period represented by that data point.

    • Maximum -- the maximum value from a single observation during the time period represented by that data point.

    • Average -- the average value from all contributors during the time period represented by that data point.

    Parameters

    • args: GetInsightRuleReportCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetInsightRuleReportCommandOutput>

  • This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

    You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

    • UniqueContributors -- the number of unique contributors for each data point.

    • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

    • SampleCount -- the number of data points matched by the rule.

    • Sum -- the sum of the values from all contributors during the time period represented by that data point.

    • Minimum -- the minimum value from a single observation during the time period represented by that data point.

    • Maximum -- the maximum value from a single observation during the time period represented by that data point.

    • Average -- the average value from all contributors during the time period represented by that data point.

    Parameters

    Returns void

  • This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

    You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

    • UniqueContributors -- the number of unique contributors for each data point.

    • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

    • SampleCount -- the number of data points matched by the rule.

    • Sum -- the sum of the values from all contributors during the time period represented by that data point.

    • Minimum -- the minimum value from a single observation during the time period represented by that data point.

    • Maximum -- the maximum value from a single observation during the time period represented by that data point.

    • Average -- the average value from all contributors during the time period represented by that data point.

    Parameters

    Returns void

  • This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

    You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

    • UniqueContributors -- the number of unique contributors for each data point.

    • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

    • SampleCount -- the number of data points matched by the rule.

    • Sum -- the sum of the values from all contributors during the time period represented by that data point.

    • Minimum -- the minimum value from a single observation during the time period represented by that data point.

    • Maximum -- the maximum value from a single observation during the time period represented by that data point.

    • Average -- the average value from all contributors during the time period represented by that data point.

    Parameters

    • args: GetInsightRuleReportCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetInsightRuleReportCommandOutput>

  • This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

    You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

    • UniqueContributors -- the number of unique contributors for each data point.

    • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

    • SampleCount -- the number of data points matched by the rule.

    • Sum -- the sum of the values from all contributors during the time period represented by that data point.

    • Minimum -- the minimum value from a single observation during the time period represented by that data point.

    • Maximum -- the maximum value from a single observation during the time period represented by that data point.

    • Average -- the average value from all contributors during the time period represented by that data point.

    Parameters

    Returns void

  • This operation returns the time series data collected by a Contributor Insights rule. The data includes the identity and number of contributors to the log group.

    You can also optionally return one or more statistics about each data point in the time series. These statistics can include the following:

    • UniqueContributors -- the number of unique contributors for each data point.

    • MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph.

      If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule's Value, during that period.

    • SampleCount -- the number of data points matched by the rule.

    • Sum -- the sum of the values from all contributors during the time period represented by that data point.

    • Minimum -- the minimum value from a single observation during the time period represented by that data point.

    • Maximum -- the maximum value from a single observation during the time period represented by that data point.

    • Average -- the average value from all contributors during the time period represented by that data point.

    Parameters

    Returns void

getMetricData

  • You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

               <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
            calls to <code>GetMetricStatistics</code>. For more information about pricing, see
            <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
    
               <p>Amazon CloudWatch retains metric data as follows:</p>
               <ul>
            <li>
               <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
                metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
            </li>
            <li>
               <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p>
            </li>
            <li>
               <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p>
            </li>
            <li>
               <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
            </li>
         </ul>
               <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
            data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available,
            but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
            a resolution of 1 hour.</p>
    
               <p>If you omit <code>Unit</code> in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified
            when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
            If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
    

    Parameters

    Returns Promise<GetMetricDataCommandOutput>

  • You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

    Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

    Parameters

    Returns void

  • You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

    Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

    Parameters

    Returns void

  • You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

    Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

    Parameters

    • args: GetMetricDataCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetMetricDataCommandOutput>

  • You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

    Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

    Parameters

    Returns void

  • You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

    Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

    Parameters

    Returns void

  • You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

               <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
            calls to <code>GetMetricStatistics</code>. For more information about pricing, see
            <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
    
               <p>Amazon CloudWatch retains metric data as follows:</p>
               <ul>
            <li>
               <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
                metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
            </li>
            <li>
               <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p>
            </li>
            <li>
               <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p>
            </li>
            <li>
               <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
            </li>
         </ul>
               <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
            data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available,
            but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
            a resolution of 1 hour.</p>
    
               <p>If you omit <code>Unit</code> in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified
            when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
            If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
    

    Parameters

    • args: GetMetricDataCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetMetricDataCommandOutput>

  • You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

    Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

    Parameters

    Returns void

  • You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

    Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

    Parameters

    Returns void

getMetricStatistics

  • Gets statistics for the specified metric.

               <p>The maximum number of data points returned from a single call is 1,440. If
            you request more than 1,440 data points, CloudWatch returns an error.
            To reduce the number of data points, you can narrow the specified time range and make
            multiple requests across adjacent time ranges, or you can increase the specified period.
            Data points are not returned in chronological order.</p>
    
               <p>CloudWatch aggregates data points based on the length of the period
            that you specify. For example, if you request statistics with a one-hour period,
            CloudWatch aggregates all data points with time stamps that fall within each
            one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than
            the number of data points returned.</p>
               <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
            data using a statistic set instead, you can only retrieve
            percentile statistics for this data if one of the following conditions is true:</p>
               <ul>
            <li>
               <p>The SampleCount value of the statistic set is 1.</p>
            </li>
            <li>
               <p>The Min and the Max values of the statistic set are equal.</p>
            </li>
         </ul>
               <p>Percentile statistics are not available for metrics when any of the metric values are negative numbers.</p>
               <p>Amazon CloudWatch retains metric data as follows:</p>
               <ul>
            <li>
               <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
                metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
            </li>
            <li>
               <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p>
            </li>
            <li>
               <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p>
            </li>
            <li>
               <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
            </li>
         </ul>
               <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
            data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available,
            but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
        a resolution of 1 hour.</p>
               <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p>
    
               <p>For information about metrics and dimensions supported by Amazon Web Services services, see the
            <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html">Amazon CloudWatch Metrics and Dimensions Reference</a> in the
            <i>Amazon CloudWatch User Guide</i>.</p>
    

    Parameters

    Returns Promise<GetMetricStatisticsCommandOutput>

  • Gets statistics for the specified metric.

    The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

    CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

    CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

    • The SampleCount value of the statistic set is 1.

    • The Min and the Max values of the statistic set are equal.

    Percentile statistics are not available for metrics when any of the metric values are negative numbers.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

    For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

    Parameters

    Returns void

  • Gets statistics for the specified metric.

    The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

    CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

    CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

    • The SampleCount value of the statistic set is 1.

    • The Min and the Max values of the statistic set are equal.

    Percentile statistics are not available for metrics when any of the metric values are negative numbers.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

    For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

    Parameters

    Returns void

  • Gets statistics for the specified metric.

    The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

    CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

    CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

    • The SampleCount value of the statistic set is 1.

    • The Min and the Max values of the statistic set are equal.

    Percentile statistics are not available for metrics when any of the metric values are negative numbers.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

    For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

    Parameters

    • args: GetMetricStatisticsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetMetricStatisticsCommandOutput>

  • Gets statistics for the specified metric.

    The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

    CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

    CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

    • The SampleCount value of the statistic set is 1.

    • The Min and the Max values of the statistic set are equal.

    Percentile statistics are not available for metrics when any of the metric values are negative numbers.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

    For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

    Parameters

    Returns void

  • Gets statistics for the specified metric.

    The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

    CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

    CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

    • The SampleCount value of the statistic set is 1.

    • The Min and the Max values of the statistic set are equal.

    Percentile statistics are not available for metrics when any of the metric values are negative numbers.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

    For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

    Parameters

    Returns void

  • Gets statistics for the specified metric.

               <p>The maximum number of data points returned from a single call is 1,440. If
            you request more than 1,440 data points, CloudWatch returns an error.
            To reduce the number of data points, you can narrow the specified time range and make
            multiple requests across adjacent time ranges, or you can increase the specified period.
            Data points are not returned in chronological order.</p>
    
               <p>CloudWatch aggregates data points based on the length of the period
            that you specify. For example, if you request statistics with a one-hour period,
            CloudWatch aggregates all data points with time stamps that fall within each
            one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than
            the number of data points returned.</p>
               <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish
            data using a statistic set instead, you can only retrieve
            percentile statistics for this data if one of the following conditions is true:</p>
               <ul>
            <li>
               <p>The SampleCount value of the statistic set is 1.</p>
            </li>
            <li>
               <p>The Min and the Max values of the statistic set are equal.</p>
            </li>
         </ul>
               <p>Percentile statistics are not available for metrics when any of the metric values are negative numbers.</p>
               <p>Amazon CloudWatch retains metric data as follows:</p>
               <ul>
            <li>
               <p>Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution
                metrics and are available only for custom metrics that have been defined with a <code>StorageResolution</code> of 1.</p>
            </li>
            <li>
               <p>Data points with a period of 60 seconds (1-minute) are available for 15 days.</p>
            </li>
            <li>
               <p>Data points with a period of 300 seconds (5-minute) are available for 63 days.</p>
            </li>
            <li>
               <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).</p>
            </li>
         </ul>
               <p>Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect
            data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available,
            but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with
        a resolution of 1 hour.</p>
               <p>CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.</p>
    
               <p>For information about metrics and dimensions supported by Amazon Web Services services, see the
            <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html">Amazon CloudWatch Metrics and Dimensions Reference</a> in the
            <i>Amazon CloudWatch User Guide</i>.</p>
    

    Parameters

    • args: GetMetricStatisticsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetMetricStatisticsCommandOutput>

  • Gets statistics for the specified metric.

    The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

    CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

    CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

    • The SampleCount value of the statistic set is 1.

    • The Min and the Max values of the statistic set are equal.

    Percentile statistics are not available for metrics when any of the metric values are negative numbers.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

    For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

    Parameters

    Returns void

  • Gets statistics for the specified metric.

    The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

    CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

    CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

    • The SampleCount value of the statistic set is 1.

    • The Min and the Max values of the statistic set are equal.

    Percentile statistics are not available for metrics when any of the metric values are negative numbers.

    Amazon CloudWatch retains metric data as follows:

    • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

    • Data points with a period of 60 seconds (1-minute) are available for 15 days.

    • Data points with a period of 300 seconds (5-minute) are available for 63 days.

    • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

    Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

    CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

    For information about metrics and dimensions supported by Amazon Web Services services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

    Parameters

    Returns void

getMetricStream

getMetricWidgetImage

  • You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

               <p>The graph you retrieve can include all CloudWatch metric graph features, including metric math
        and horizontal and vertical annotations.</p>
    
               <p>There is a limit of 20 transactions per second for this API. Each <code>GetMetricWidgetImage</code> action has the following limits:</p>
               <ul>
            <li>
                           <p>As many as 100 metrics in the graph.</p>
                     </li>
            <li>
                           <p>Up to 100 KB uncompressed payload.</p>
                     </li>
         </ul>
    

    Parameters

    Returns Promise<GetMetricWidgetImageCommandOutput>

  • You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

    The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

    There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

    • As many as 100 metrics in the graph.

    • Up to 100 KB uncompressed payload.

    Parameters

    Returns void

  • You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

    The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

    There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

    • As many as 100 metrics in the graph.

    • Up to 100 KB uncompressed payload.

    Parameters

    Returns void

  • You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

    The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

    There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

    • As many as 100 metrics in the graph.

    • Up to 100 KB uncompressed payload.

    Parameters

    • args: GetMetricWidgetImageCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetMetricWidgetImageCommandOutput>

  • You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

    The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

    There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

    • As many as 100 metrics in the graph.

    • Up to 100 KB uncompressed payload.

    Parameters

    Returns void

  • You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

    The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

    There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

    • As many as 100 metrics in the graph.

    • Up to 100 KB uncompressed payload.

    Parameters

    Returns void

  • You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

               <p>The graph you retrieve can include all CloudWatch metric graph features, including metric math
        and horizontal and vertical annotations.</p>
    
               <p>There is a limit of 20 transactions per second for this API. Each <code>GetMetricWidgetImage</code> action has the following limits:</p>
               <ul>
            <li>
                           <p>As many as 100 metrics in the graph.</p>
                     </li>
            <li>
                           <p>Up to 100 KB uncompressed payload.</p>
                     </li>
         </ul>
    

    Parameters

    • args: GetMetricWidgetImageCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetMetricWidgetImageCommandOutput>

  • You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

    The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

    There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

    • As many as 100 metrics in the graph.

    • Up to 100 KB uncompressed payload.

    Parameters

    Returns void

  • You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

    The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

    There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

    • As many as 100 metrics in the graph.

    • Up to 100 KB uncompressed payload.

    Parameters

    Returns void

listDashboards

  • Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

    ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

    Parameters

    Returns Promise<ListDashboardsCommandOutput>

  • Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

    ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

    Parameters

    Returns void

  • Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

    ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

    Parameters

    Returns void

  • Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

    ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

    Parameters

    • args: ListDashboardsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListDashboardsCommandOutput>

  • Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

    ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

    Parameters

    Returns void

  • Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

    ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

    Parameters

    Returns void

  • Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

    ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

    Parameters

    • args: ListDashboardsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListDashboardsCommandOutput>

  • Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

    ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

    Parameters

    Returns void

  • Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

    ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

    Parameters

    Returns void

listMetricStreams

listMetrics

  • List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

    After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

            <p>
            <code>ListMetrics</code> doesn't return information about metrics if those metrics haven't
    reported data in the past two weeks. To retrieve those metrics, use
        <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
        <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a>.</p>
    

    Parameters

    Returns Promise<ListMetricsCommandOutput>

  • List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

    After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

    ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

    Parameters

    Returns void

  • List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

    After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

    ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

    Parameters

    Returns void

  • List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

    After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

    ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

    Parameters

    • args: ListMetricsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListMetricsCommandOutput>

  • List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

    After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

    ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

    Parameters

    Returns void

  • List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

    After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

    ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

    Parameters

    Returns void

  • List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

    After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

            <p>
            <code>ListMetrics</code> doesn't return information about metrics if those metrics haven't
    reported data in the past two weeks. To retrieve those metrics, use
        <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html">GetMetricData</a> or
        <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricStatistics.html">GetMetricStatistics</a>.</p>
    

    Parameters

    • args: ListMetricsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListMetricsCommandOutput>

  • List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

    After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

    ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

    Parameters

    Returns void

  • List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

    Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

    After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

    ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

    Parameters

    Returns void

listTagsForResource

putAnomalyDetector

putCompositeAlarm

  • Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

    The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

    Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

    Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

               <p>To use this operation, you must be signed on with
            the <code>cloudwatch:PutCompositeAlarm</code> permission that is scoped to <code>*</code>. You can't create a
            composite alarms if your <code>cloudwatch:PutCompositeAlarm</code> permission has a narrower scope.</p>
    
               <p>If you are an IAM user, you must have <code>iam:CreateServiceLinkedRole</code> to create
            a composite alarm that has Systems Manager OpsItem actions.</p>
    

    Parameters

    Returns Promise<PutCompositeAlarmCommandOutput>

  • Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

    The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

    Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

    Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

    If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

    Parameters

    Returns void

  • Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

    The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

    Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

    Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

    If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

    Parameters

    Returns void

  • Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

    The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

    Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

    Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

    If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

    Parameters

    • args: PutCompositeAlarmCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutCompositeAlarmCommandOutput>

  • Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

    The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

    Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

    Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

    If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

    Parameters

    Returns void

  • Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

    The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

    Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

    Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

    If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

    Parameters

    Returns void

  • Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

    The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

    Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

    Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

               <p>To use this operation, you must be signed on with
            the <code>cloudwatch:PutCompositeAlarm</code> permission that is scoped to <code>*</code>. You can't create a
            composite alarms if your <code>cloudwatch:PutCompositeAlarm</code> permission has a narrower scope.</p>
    
               <p>If you are an IAM user, you must have <code>iam:CreateServiceLinkedRole</code> to create
            a composite alarm that has Systems Manager OpsItem actions.</p>
    

    Parameters

    • args: PutCompositeAlarmCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutCompositeAlarmCommandOutput>

  • Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

    The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

    Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

    Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

    If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

    Parameters

    Returns void

  • Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

    The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

    Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

    Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

    It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

    To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

    Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

    If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

    Parameters

    Returns void

putDashboard

  • Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

    All dashboards in your account are global, not region-specific.

    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

    Parameters

    Returns Promise<PutDashboardCommandOutput>

  • Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

    All dashboards in your account are global, not region-specific.

    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

    Parameters

    Returns void

  • Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

    All dashboards in your account are global, not region-specific.

    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

    Parameters

    Returns void

  • Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

    All dashboards in your account are global, not region-specific.

    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

    Parameters

    • args: PutDashboardCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutDashboardCommandOutput>

  • Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

    All dashboards in your account are global, not region-specific.

    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

    Parameters

    Returns void

  • Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

    All dashboards in your account are global, not region-specific.

    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

    Parameters

    Returns void

  • Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

    All dashboards in your account are global, not region-specific.

    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

    Parameters

    • args: PutDashboardCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutDashboardCommandOutput>

  • Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

    All dashboards in your account are global, not region-specific.

    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

    Parameters

    Returns void

  • Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

    All dashboards in your account are global, not region-specific.

    A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

    When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

    Parameters

    Returns void

putInsightRule

putMetricAlarm

  • Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

               <p>Alarms based on anomaly detection models cannot have Auto Scaling actions.</p>
               <p>When this operation creates an alarm, the alarm state is immediately set to
            <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set
            appropriately. Any actions associated with the new state are then executed.</p>
               <p>When you update an existing alarm, its state is left unchanged, but the
            update completely overwrites the previous configuration of the alarm.</p>
    
               <p>If you are an IAM user, you must have
            Amazon EC2 permissions for some alarm operations:</p>
               <ul>
            <li>
                           <p>The <code>iam:CreateServiceLinkedRole</code> for all alarms with EC2 actions</p>
    
                     </li>
            <li>
    
                           <p>The <code>iam:CreateServiceLinkedRole</code> to create an alarm
                    with Systems Manager OpsItem actions.</p>
                     </li>
         </ul>
    
    
    
    
    
    
               <p>The first time you create an alarm in the
            Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch
            creates the necessary service-linked role for you. The service-linked roles
            are called <code>AWSServiceRoleForCloudWatchEvents</code> and
            <code>AWSServiceRoleForCloudWatchAlarms_ActionSSM</code>.
            For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role">Amazon Web Services service-linked role</a>.</p>
    
               <p>
            <b>Cross-account alarms</b>
         </p>
    
               <p>You can set an alarm on metrics in the current account, or in another
            account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following
            pre-requisites:</p>
               <ul>
            <li>
               <p>The account where the metrics are located (the <i>sharing account</i>) must
                already have a sharing role named <b>CloudWatch-CrossAccountSharingRole</b>. If it does not already
                have this role, you must create it using the instructions in <b>Set up a
                    sharing account</b> in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region">
                    Cross-account cross-Region CloudWatch console</a>. The policy for that
                role must grant access
                to the ID of the account where you are creating the alarm.
            </p>
            </li>
            <li>
               <p>The account where you are creating the alarm (the <i>monitoring account</i>) must
                already have a service-linked role named
                <b>AWSServiceRoleForCloudWatchCrossAccount</b> to allow
                CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in <b>Set up a
                    monitoring account</b> in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region">
                        Cross-account cross-Region CloudWatch console</a>.</p>
            </li>
         </ul>
    

    Parameters

    Returns Promise<PutMetricAlarmCommandOutput>

  • Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

    Alarms based on anomaly detection models cannot have Auto Scaling actions.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

    • The iam:CreateServiceLinkedRole for all alarms with EC2 actions

    • The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem actions.

    The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.

    Cross-account alarms

    You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:

    • The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.

    • The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.

    Parameters

    Returns void

  • Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

    Alarms based on anomaly detection models cannot have Auto Scaling actions.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

    • The iam:CreateServiceLinkedRole for all alarms with EC2 actions

    • The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem actions.

    The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.

    Cross-account alarms

    You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:

    • The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.

    • The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.

    Parameters

    Returns void

  • Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

    Alarms based on anomaly detection models cannot have Auto Scaling actions.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

    • The iam:CreateServiceLinkedRole for all alarms with EC2 actions

    • The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem actions.

    The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.

    Cross-account alarms

    You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:

    • The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.

    • The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.

    Parameters

    • args: PutMetricAlarmCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutMetricAlarmCommandOutput>

  • Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

    Alarms based on anomaly detection models cannot have Auto Scaling actions.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

    • The iam:CreateServiceLinkedRole for all alarms with EC2 actions

    • The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem actions.

    The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.

    Cross-account alarms

    You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:

    • The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.

    • The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.

    Parameters

    Returns void

  • Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

    Alarms based on anomaly detection models cannot have Auto Scaling actions.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

    • The iam:CreateServiceLinkedRole for all alarms with EC2 actions

    • The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem actions.

    The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.

    Cross-account alarms

    You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:

    • The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.

    • The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.

    Parameters

    Returns void

  • Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

               <p>Alarms based on anomaly detection models cannot have Auto Scaling actions.</p>
               <p>When this operation creates an alarm, the alarm state is immediately set to
            <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set
            appropriately. Any actions associated with the new state are then executed.</p>
               <p>When you update an existing alarm, its state is left unchanged, but the
            update completely overwrites the previous configuration of the alarm.</p>
    
               <p>If you are an IAM user, you must have
            Amazon EC2 permissions for some alarm operations:</p>
               <ul>
            <li>
                           <p>The <code>iam:CreateServiceLinkedRole</code> for all alarms with EC2 actions</p>
    
                     </li>
            <li>
    
                           <p>The <code>iam:CreateServiceLinkedRole</code> to create an alarm
                    with Systems Manager OpsItem actions.</p>
                     </li>
         </ul>
    
    
    
    
    
    
               <p>The first time you create an alarm in the
            Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch
            creates the necessary service-linked role for you. The service-linked roles
            are called <code>AWSServiceRoleForCloudWatchEvents</code> and
            <code>AWSServiceRoleForCloudWatchAlarms_ActionSSM</code>.
            For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role">Amazon Web Services service-linked role</a>.</p>
    
               <p>
            <b>Cross-account alarms</b>
         </p>
    
               <p>You can set an alarm on metrics in the current account, or in another
            account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following
            pre-requisites:</p>
               <ul>
            <li>
               <p>The account where the metrics are located (the <i>sharing account</i>) must
                already have a sharing role named <b>CloudWatch-CrossAccountSharingRole</b>. If it does not already
                have this role, you must create it using the instructions in <b>Set up a
                    sharing account</b> in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region">
                    Cross-account cross-Region CloudWatch console</a>. The policy for that
                role must grant access
                to the ID of the account where you are creating the alarm.
            </p>
            </li>
            <li>
               <p>The account where you are creating the alarm (the <i>monitoring account</i>) must
                already have a service-linked role named
                <b>AWSServiceRoleForCloudWatchCrossAccount</b> to allow
                CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in <b>Set up a
                    monitoring account</b> in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region">
                        Cross-account cross-Region CloudWatch console</a>.</p>
            </li>
         </ul>
    

    Parameters

    • args: PutMetricAlarmCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutMetricAlarmCommandOutput>

  • Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

    Alarms based on anomaly detection models cannot have Auto Scaling actions.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

    When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

    If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

    • The iam:CreateServiceLinkedRole for all alarms with EC2 actions

    • The iam:CreateServiceLinkedRole to create an alarm with Systems Manager OpsItem actions.

    The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.

    Cross-account alarms

    You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:

    • The account where the metrics are located (the sharing account) must already have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already have this role, you must create it using the instructions in Set up a sharing account in Cross-account cross-Region CloudWatch console. The policy for that role must grant access to the ID of the account where you are creating the alarm.

    • The account where you are creating the alarm (the monitoring account) must already have a service-linked role named AWSServiceRoleForCloudWatchCrossAccount to allow CloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a monitoring account in Cross-account cross-Region CloudWatch console.

    Parameters

    Returns void

  • Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

    Alarms based on anomaly detection models cannot have Auto Scaling actions.

    When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then e