Exemples d’utilisation de l’AWS CLI avec CloudWatch - AWS Command Line Interface

Exemples d’utilisation de l’AWS CLI avec CloudWatch

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec CloudWatch.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser delete-alarms.

AWS CLI

Pour supprimer une alarme

L’exemple suivant fait appel à la commande delete-alarms pour supprimer l’alarme Amazon CloudWatch nommée « myalarm » :

aws cloudwatch delete-alarms --alarm-names myalarm

Sortie :

This command returns to the prompt if successful.
  • Pour plus de détails sur l’API, consultez DeleteAlarms dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-anomaly-detector.

AWS CLI

Pour supprimer un modèle de détection d’anomalie spécifié

L’exemple delete-anomaly-detector suivant supprime un modèle de détection d’anomalies dans le compte spécifié.

aws cloudwatch delete-anomaly-detector \ --namespace AWS/Logs \ --metric-name IncomingBytes \ --stat SampleCount

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppression d’un modèle de détection d’anomalies dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez DeleteAnomalyDetector dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-dashboards.

AWS CLI

Pour supprimer des tableaux de bord spécifiés

L’exemple delete-dashboards suivant supprime deux tableaux de bord nommés Dashboard-A et Dashboard-B dans le compte spécifié.

aws cloudwatch delete-dashboards \ --dashboard-names Dashboard-A Dashboard-B

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Tableaux de bord Amazon CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez DeleteDashboards dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-insight-rules.

AWS CLI

Pour supprimer des règles Contributor Insights spécifiées

L’exemple delete-insight-rules suivant supprime deux règles Contributor Insights nommées Rule-A et Rule-B dans le compte spécifié.

aws cloudwatch delete-insight-rules \ --rule-names Rule-A Rule-B

Sortie :

{ "Failures": [] }

Pour plus d’informations, consultez Utiliser Contributor Insights pour analyser des données à cardinalité élevée dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez DeleteInsightRules dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-metric-stream.

AWS CLI

Pour supprimer un flux de métriques spécifié

L’exemple delete-metric-stream suivant supprime le flux de métriques nommé QuickPartial-gSCKvO dans le compte spécifié.

aws cloudwatch delete-metric-stream \ --name QuickPartial-gSCKvO

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utiliser les flux de métriques dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez DeleteMetricStream dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-alarm-history.

AWS CLI

Pour récupérer l’historique d’une alarme

L’exemple suivant fait appel à la commande describe-alarm-history pour récupérer l’historique de l’alarme Amazon CloudWatch nommée « myalarm » :

aws cloudwatch describe-alarm-history --alarm-name "myalarm" --history-item-type StateUpdate

Sortie :

{ "AlarmHistoryItems": [ { "Timestamp": "2014-04-09T18:59:06.442Z", "HistoryItemType": "StateUpdate", "AlarmName": "myalarm", "HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"},\"newState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}}}", "HistorySummary": "Alarm updated from ALARM to OK" }, { "Timestamp": "2014-04-09T18:59:05.805Z", "HistoryItemType": "StateUpdate", "AlarmName": "myalarm", "HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.839999999999996, 39.714].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-03-11T22:45:41.569+0000\",\"startDate\":\"2014-03-11T22:30:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.839999999999996,39.714],\"threshold\":70.0}},\"newState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"}}", "HistorySummary": "Alarm updated from OK to ALARM" } ] }
  • Pour plus de détails sur l’API, consultez DescribeAlarmHistory dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-alarms-for-metric.

AWS CLI

Pour afficher des informations relatives aux alarmes associées à une métrique

L’exemple suivant fait appel à la commande describe-alarms-for-metric pour afficher des informations sur les alarmes associées à la métrique Amazon EC2 CPUUtilization et à l’instance portant l’ID i-0c986c72. :

aws cloudwatch describe-alarms-for-metric --metric-name CPUUtilization --namespace AWS/EC2 --dimensions Name=InstanceId,Value=i-0c986c72

Sortie :

{ "MetricAlarms": [ { "EvaluationPeriods": 10, "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm2", "StateUpdatedTimestamp": "2013-10-30T03:03:51.479Z", "AlarmConfigurationUpdatedTimestamp": "2013-10-30T03:03:50.865Z", "ComparisonOperator": "GreaterThanOrEqualToThreshold", "AlarmActions": [ "arn:aws:sns:us-east-1:111122223333:NotifyMe" ], "Namespace": "AWS/EC2", "AlarmDescription": "CPU usage exceeds 70 percent", "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2013-10-30T03:03:51.479+0000\",\"startDate\":\"2013-10-30T02:08:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[40.698,39.612,42.432,39.796,38.816,42.28,42.854,40.088,40.760000000000005,41.316],\"threshold\":70.0}", "Period": 300, "StateValue": "OK", "Threshold": 70.0, "AlarmName": "myHighCpuAlarm2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0c986c72" } ], "Statistic": "Average", "StateReason": "Threshold Crossed: 10 datapoints were not greater than or equal to the threshold (70.0). The most recent datapoints: [40.760000000000005, 41.316].", "InsufficientDataActions": [], "OKActions": [], "ActionsEnabled": true, "MetricName": "CPUUtilization" }, { "EvaluationPeriods": 2, "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm", "StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z", "AlarmConfigurationUpdatedTimestamp": "2014-04-09T22:26:05.958Z", "ComparisonOperator": "GreaterThanThreshold", "AlarmActions": [ "arn:aws:sns:us-east-1:111122223333:HighCPUAlarm" ], "Namespace": "AWS/EC2", "AlarmDescription": "CPU usage exceeds 70 percent", "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}", "Period": 300, "StateValue": "OK", "Threshold": 70.0, "AlarmName": "myHighCpuAlarm", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0c986c72" } ], "Statistic": "Average", "StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].", "InsufficientDataActions": [], "OKActions": [], "ActionsEnabled": false, "MetricName": "CPUUtilization" } ] }
  • Pour plus de détails sur l’API, consultez DescribeAlarmsForMetric dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-alarms.

AWS CLI

Pour répertorier les informations relatives à une alarme

L’exemple suivant fait appel à la commande describe-alarms pour fournir des informations sur l’alarme nommée « myalarm » :

aws cloudwatch describe-alarms --alarm-names "myalarm"

Sortie :

{ "MetricAlarms": [ { "EvaluationPeriods": 2, "AlarmArn": "arn:aws:cloudwatch:us-east-1:123456789012:alarm:myalarm", "StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z", "AlarmConfigurationUpdatedTimestamp": "2012-12-27T00:49:54.032Z", "ComparisonOperator": "GreaterThanThreshold", "AlarmActions": [ "arn:aws:sns:us-east-1:123456789012:myHighCpuAlarm" ], "Namespace": "AWS/EC2", "AlarmDescription": "CPU usage exceeds 70 percent", "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}", "Period": 300, "StateValue": "OK", "Threshold": 70.0, "AlarmName": "myalarm", "Dimensions": [ { "Name": "InstanceId", "Value": "i-0c986c72" } ], "Statistic": "Average", "StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].", "InsufficientDataActions": [], "OKActions": [], "ActionsEnabled": true, "MetricName": "CPUUtilization" } ] }
  • Pour plus de détails sur l’API, consultez DescribeAlarms dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-anomaly-detectors.

AWS CLI

Pour récupérer une liste de modèles de détection d’anomalies

L’exemple describe-anomaly-detectors suivant affiche les informations sur les modèles de détection d’anomalies associés à l’espace de noms AWS/Logs dans le compte spécifié.

aws cloudwatch describe-anomaly-detectors \ --namespace AWS/Logs

Sortie :

{ "AnomalyDetectors": [ { "Namespace": "AWS/Logs", "MetricName": "IncomingBytes", "Dimensions": [], "Stat": "SampleCount", "Configuration": { "ExcludedTimeRanges": [] }, "StateValue": "TRAINED", "SingleMetricAnomalyDetector": { "AccountId": "123456789012", "Namespace": "AWS/Logs", "MetricName": "IncomingBytes", "Dimensions": [], "Stat": "SampleCount" } }, { "Namespace": "AWS/Logs", "MetricName": "IncomingBytes", "Dimensions": [ { "Name": "LogGroupName", "Value": "demo" } ], "Stat": "Average", "Configuration": { "ExcludedTimeRanges": [] }, "StateValue": "PENDING_TRAINING", "SingleMetricAnomalyDetector": { "AccountId": "123456789012", "Namespace": "AWS/Logs", "MetricName": "IncomingBytes", "Dimensions": [ { "Name": "LogGroupName", "Value": "demo" } ], "Stat": "Average" } } ] }

Pour plus d’informations, consultez Utilisation de la détection des anomalies CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez DescribeAnomalyDetectors dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-insight-rules.

AWS CLI

Pour récupérer une liste des règles Contributor Insights

L’exemple describe-insight-rules suivant montre toutes les règles Contributor Insight dans le compte spécifié.

aws cloudwatch describe-insight-rules

Sortie :

{ "InsightRules": [ { "Name": "Rule-A", "State": "ENABLED", "Schema": "CloudWatchLogRule/1", "Definition": "{\n\t\"AggregateOn\": \"Count\",\n\t\"Contribution\": {\n\t\t\"Filters\": [],\n\t\t\"Keys\": [\n\t\t\t\"$.requestId\"\n\t\t]\n\t},\n\t\"LogFormat\": \"JSON\",\n\t\"Schema\": {\n\t\t\"Name\": \"CloudWatchLogRule\",\n\t\t\"Version\": 1\n\t},\n\t\"LogGroupARNs\": [\n\t\t\"arn:aws:logs:us-east-1:123456789012:log-group:demo\"\n\t]\n}", "ManagedRule": false }, { "Name": "Rule-B", "State": "ENABLED", "Schema": "CloudWatchLogRule/1", "Definition": "{\n\t\"AggregateOn\": \"Count\",\n\t\"Contribution\": {\n\t\t\"Filters\": [],\n\t\t\"Keys\": [\n\t\t\t\"$.requestId\"\n\t\t]\n\t},\n\t\"LogFormat\": \"JSON\",\n\t\"Schema\": {\n\t\t\"Name\": \"CloudWatchLogRule\",\n\t\t\"Version\": 1\n\t},\n\t\"LogGroupARNs\": [\n\t\t\"arn:aws:logs:us-east-1:123456789012:log-group:demo-1\"\n\t]\n}", "ManagedRule": false } ] }

Pour plus d’informations, consultez Utiliser Contributor Insights pour analyser des données à cardinalité élevée dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez DescribeInsightRules dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser disable-alarm-actions.

AWS CLI

Pour désactiver les actions d’une alarme

L’exemple suivant fait appel à la commande disable-alarm-actions pour désactiver toutes les actions de l’alarme nommée myalarm :

aws cloudwatch disable-alarm-actions --alarm-names myalarm

Cette commande revient à l’invite en cas de succès.

  • Pour plus de détails sur l’API, consultez DisableAlarmActions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser disable-insight-rules.

AWS CLI

Pour désactiver les règles Contributor Insights spécifiées

L’exemple disable-insight-rules suivant désactive deux règles Contributor Insights nommées Rule-A et Rule-B dans le compte spécifié.

aws cloudwatch disable-insight-rules \ --rule-names Rule-A Rule-B

Sortie :

{ "Failures": [] }

Pour plus d’informations, consultez Utiliser Contributor Insights pour analyser des données à cardinalité élevée dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez DisableInsightRules dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser enable-alarm-actions.

AWS CLI

Pour activer toutes les actions d’une alarme

L’exemple suivant fait appel à la commande enable-alarm-actions pour activer toutes les actions de l’alarme nommée myalarm :

aws cloudwatch enable-alarm-actions --alarm-names myalarm

Cette commande revient à l’invite en cas de succès.

  • Pour obtenir plus de détails sur l’API, consultez EnableAlarmActions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser enable-insight-rules.

AWS CLI

Pour activer des règles Contributor Insights spécifiées

L’exemple enable-insight-rules suivant active deux règles Contributor Insights nommées Rule-A et Rule-B dans le compte spécifié.

aws cloudwatch enable-insight-rules \ --rule-names Rule-A Rule-B

Sortie :

{ "Failures": [] }

Pour plus d’informations, consultez Utiliser Contributor Insights pour analyser des données à cardinalité élevée dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez EnableInsightRules dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-dashboard.

AWS CLI

Pour récupérer les informations sur un tableau de bord

L’exemple get-dashboard suivant affiche les informations sur le tableau de bord nommé Dashboard-A dans le compte spécifié.

aws cloudwatch get-dashboard \ --dashboard-name Dashboard-A

Sortie :

{ "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A", "DashboardBody": "{\"widgets\":[{\"type\":\"metric\",\"x\":0,\"y\":0,\"width\":6,\"height\":6,\"properties\":{\"view\":\"timeSeries\",\"stacked\":false,\"metrics\":[[\"AWS/EC2\",\"NetworkIn\",\"InstanceId\",\"i-0131f062232ade043\"],[\".\",\"NetworkOut\",\".\",\".\"]],\"region\":\"us-east-1\"}}]}", "DashboardName": "Dashboard-A" }

Pour plus d’informations, consultez Tableaux de bord Amazon CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez GetDashboard dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-insight-rule-report.

AWS CLI

Pour récupérer les données de séries temporelles collectées par une règle Contributor Insights

L’exemple get-insight-rule-report suivant renvoie les données de séries temporelles collectées par une règle Contributor Insights.

aws cloudwatch get-insight-rule-report \ --rule-name Rule-A \ --start-time 2024-10-13T20:15:00Z \ --end-time 2024-10-13T20:30:00Z \ --period 300

Sortie :

{ "KeyLabels": [ "PartitionKey" ], "AggregationStatistic": "Sum", "AggregateValue": 0.5, "ApproximateUniqueCount": 1, "Contributors": [ { "Keys": [ "RequestID" ], "ApproximateAggregateValue": 0.5, "Datapoints": [ { "Timestamp": "2024-10-13T21:00:00+00:00", "ApproximateValue": 0.5 } ] } ], "RuleAttributes": [] }

Pour plus d’informations, consultez Utiliser Contributor Insights pour analyser des données à cardinalité élevée dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez GetInsightRuleReport dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-metric-data.

AWS CLI

Exemple 1 : pour obtenir le nombre moyen total d’IOPS pour l’instance EC2 spécifiée à l’aide d’une expression mathématique

L’exemple get-metric-data suivant récupère les valeurs des métriques CloudWatch pour l’instance EC2 avec l’ID d’instance i-abcdef à l’aide d’une expression mathématique qui combine les métriques EBSReadOps et EBSWriteOps.

aws cloudwatch get-metric-data \ --metric-data-queries file://file.json \ --start-time 2024-09-29T22:10:00Z \ --end-time 2024-09-29T22:15:00Z

Contenu de file.json :

[ { "Id": "m3", "Expression": "(m1+m2)/300", "Label": "Avg Total IOPS" }, { "Id": "m1", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "EBSReadOps", "Dimensions": [ { "Name": "InstanceId", "Value": "i-abcdef" } ] }, "Period": 300, "Stat": "Sum", "Unit": "Count" }, "ReturnData": false }, { "Id": "m2", "MetricStat": { "Metric": { "Namespace": "AWS/EC2", "MetricName": "EBSWriteOps", "Dimensions": [ { "Name": "InstanceId", "Value": "i-abcdef" } ] }, "Period": 300, "Stat": "Sum", "Unit": "Count" }, "ReturnData": false } ]

Sortie :

{ "MetricDataResults": [ { "Id": "m3", "Label": "Avg Total IOPS", "Timestamps": [ "2024-09-29T22:10:00+00:00" ], "Values": [ 96.85 ], "StatusCode": "Complete" } ], "Messages": [] }

Exemple 2 : pour surveiller les frais AWS estimés à l’aide des métriques de facturation de CloudWatch

L’exemple get-metric-data suivant récupère la métrique CloudWatch EstimatedCharges à partir de l’espace de noms AWS/Billing.

aws cloudwatch get-metric-data \ --metric-data-queries '[{"Id":"m1","MetricStat":{"Metric":{"Namespace":"AWS/Billing","MetricName":"EstimatedCharges","Dimensions":[{"Name":"Currency","Value":"USD"}]},"Period":21600,"Stat":"Maximum"}}]' \ --start-time 2024-09-26T12:00:00Z \ --end-time 2024-09-26T18:00:00Z \ --region us-east-1

Sortie :

{ "MetricDataResults": [ { "Id": "m1", "Label": "EstimatedCharges", "Timestamps": [ "2024-09-26T12:00:00+00:00" ], "Values": [ 542.38 ], "StatusCode": "Complete" } ], "Messages": [] }

Pour plus d’informations, consultez Utilisation d’expressions mathématiques avec les métriques CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez GetMetricData dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-metric-statistics.

AWS CLI

Pour obtenir l’utilisation du processeur par instance EC2

L’exemple suivant fait appel à la commande get-metric-statistics pour obtenir l’utilisation du processeur pour une instance EC2 portant l’ID i-abcdef.

aws cloudwatch get-metric-statistics --metric-name CPUUtilization --start-time 2014-04-08T23:18:00Z --end-time 2014-04-09T23:18:00Z --period 3600 --namespace AWS/EC2 --statistics Maximum --dimensions Name=InstanceId,Value=i-abcdef

Sortie :

{ "Datapoints": [ { "Timestamp": "2014-04-09T11:18:00Z", "Maximum": 44.79, "Unit": "Percent" }, { "Timestamp": "2014-04-09T20:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T19:18:00Z", "Maximum": 50.85, "Unit": "Percent" }, { "Timestamp": "2014-04-09T09:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T03:18:00Z", "Maximum": 76.84, "Unit": "Percent" }, { "Timestamp": "2014-04-09T21:18:00Z", "Maximum": 48.96, "Unit": "Percent" }, { "Timestamp": "2014-04-09T14:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T08:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T16:18:00Z", "Maximum": 45.55, "Unit": "Percent" }, { "Timestamp": "2014-04-09T06:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T13:18:00Z", "Maximum": 45.08, "Unit": "Percent" }, { "Timestamp": "2014-04-09T05:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T18:18:00Z", "Maximum": 46.88, "Unit": "Percent" }, { "Timestamp": "2014-04-09T17:18:00Z", "Maximum": 52.08, "Unit": "Percent" }, { "Timestamp": "2014-04-09T07:18:00Z", "Maximum": 47.92, "Unit": "Percent" }, { "Timestamp": "2014-04-09T02:18:00Z", "Maximum": 51.23, "Unit": "Percent" }, { "Timestamp": "2014-04-09T12:18:00Z", "Maximum": 47.67, "Unit": "Percent" }, { "Timestamp": "2014-04-08T23:18:00Z", "Maximum": 46.88, "Unit": "Percent" }, { "Timestamp": "2014-04-09T10:18:00Z", "Maximum": 51.91, "Unit": "Percent" }, { "Timestamp": "2014-04-09T04:18:00Z", "Maximum": 47.13, "Unit": "Percent" }, { "Timestamp": "2014-04-09T15:18:00Z", "Maximum": 48.96, "Unit": "Percent" }, { "Timestamp": "2014-04-09T00:18:00Z", "Maximum": 48.16, "Unit": "Percent" }, { "Timestamp": "2014-04-09T01:18:00Z", "Maximum": 49.18, "Unit": "Percent" } ], "Label": "CPUUtilization" }

Spécification de plusieurs dimensions

L’exemple suivant illustre comment spécifier plusieurs dimensions. Chaque dimension est spécifiée sous la forme d’une paire nom/valeur, avec une virgule entre le nom et la valeur. Les différentes dimensions sont séparées par un espace. Si une métrique comprend plusieurs dimensions, vous devez préciser une valeur pour chaque dimension définie.

Pour d’autres exemples d’utilisation de la commande get-metric-statistics, consultez Obtention des statistiques d’une métrique dans le Manuel du développeur Amazon CloudWatch.

aws cloudwatch get-metric-statistics --metric-name Buffers --namespace MyNameSpace --dimensions Name=InstanceID,Value=i-abcdef Name=InstanceType,Value=m1.small --start-time 2016-10-15T04:00:00Z --end-time 2016-10-19T07:00:00Z --statistics Average --period 60
  • Pour plus de détails sur l’API, consultez GetMetricStatistics dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-metric-stream.

AWS CLI

Pour récupérer les informations sur un flux de métriques

L’exemple get-metric-stream suivant affiche les informations sur le flux de métriques nommé QuickFull-GuaFbs dans le compte spécifié.

aws cloudwatch get-metric-stream \ --name QuickFull-GuaFbs

Sortie :

{ "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs", "Name": "QuickFull-GuaFbs", "FirehoseArn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG", "RoleArn": "arn:aws:iam::123456789012:role/service-role/MetricStreams-FirehosePutRecords-JN10W9B3", "State": "running", "CreationDate": "2024-10-11T18:48:59.187000+00:00", "LastUpdateDate": "2024-10-11T18:48:59.187000+00:00", "OutputFormat": "json", "IncludeLinkedAccountsMetrics": false }

Pour plus d’informations, consultez Utiliser les flux de métriques dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez GetMetricStream dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-metric-widget-image.

AWS CLI

Pour récupérer un graphique instantané sur l’utilisation du processeur

L’exemple get-metric-widget-image suivant récupère le graphique instantané de la métrique CPUUtilization de l’instance EC2 avec l’ID i-abcde et enregistre l’image extraite sous forme de fichier nommé « image.png » sur votre machine locale.

aws cloudwatch get-metric-widget-image \ --metric-widget '{"metrics":[["AWS/EC2","CPUUtilization","InstanceId","i-abcde"]]}' \ --output-format png \ --output text | base64 --decode > image.png

Cette commande ne produit aucune sortie.

  • Pour plus de détails sur l’API, consultez GetMetricWidgetImage dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-dashboards.

AWS CLI

Pour récupérer une liste de tableaux de bord

L’exemple list-dashboards suivant répertorie tous les tableaux de bord du compte spécifié.

aws cloudwatch list-dashboards

Sortie :

{ "DashboardEntries": [ { "DashboardName": "Dashboard-A", "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A", "LastModified": "2024-10-11T18:40:11+00:00", "Size": 271 }, { "DashboardName": "Dashboard-B", "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-B", "LastModified": "2024-10-11T18:44:41+00:00", "Size": 522 } ] }

Pour plus d’informations, consultez Tableaux de bord Amazon CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez ListDashboards dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-metric-streams.

AWS CLI

Pour récupérer une liste des flux de métriques

L’exemple list-metric-streams suivant répertorie tous les flux de métriques du compte spécifié.

aws cloudwatch list-metric-streams

Sortie :

{ "Entries": [ { "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs", "CreationDate": "2024-10-11T18:48:59.187000+00:00", "LastUpdateDate": "2024-10-11T18:48:59.187000+00:00", "Name": "QuickFull-GuaFbs", "FirehoseArn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG", "State": "running", "OutputFormat": "json" } ] }

Pour plus d’informations, consultez Utiliser les flux de métriques dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez ListMetricStreams dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-metrics.

AWS CLI

Pour répertorier les métriques pour Amazon SNS

L’exemple list-metrics suivant affiche les métriques pour Amazon SNS.

aws cloudwatch list-metrics \ --namespace "AWS/SNS"

Sortie :

{ "Metrics": [ { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "NotifyMe" } ], "MetricName": "PublishSize" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "CFO" } ], "MetricName": "PublishSize" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "NotifyMe" } ], "MetricName": "NumberOfNotificationsFailed" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "NotifyMe" } ], "MetricName": "NumberOfNotificationsDelivered" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "NotifyMe" } ], "MetricName": "NumberOfMessagesPublished" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "CFO" } ], "MetricName": "NumberOfMessagesPublished" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "CFO" } ], "MetricName": "NumberOfNotificationsDelivered" }, { "Namespace": "AWS/SNS", "Dimensions": [ { "Name": "TopicName", "Value": "CFO" } ], "MetricName": "NumberOfNotificationsFailed" } ] }
  • Pour plus de détails sur l’API, consultez ListMetrics dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-tags-for-resource.

AWS CLI

Pour répertorier les balises associées à une alarme existante*

L’exemple list-tags-for-resource suivant répertorie toutes les balises associées à une alarme nommée demo dans le compte spécifié.

aws cloudwatch list-tags-for-resource \ --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo

Sortie :

{ "Tags": [ { "Key": "stack", "Value": "Production" }, { "Key": "team", "Value": "Devops" } ] }

Pour plus d’informations, consultez Alarms and tagging dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez ListTagsForResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-anomaly-detector.

AWS CLI

Pour créer un modèle de détection d’anomalies

L’exemple put-anomaly-detector suivant crée un modèle de détection d’anomalies pour une métrique CloudWatch.

aws cloudwatch put-anomaly-detector \ --namespace AWS/Logs \ --metric-name IncomingBytes \ --stat SampleCount

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation de la détection des anomalies CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez PutAnomalyDetector dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-composite-alarm.

AWS CLI

Pour créer une alerte CloudWatch composite

L’exemple put-composite-alarm suivant crée une alerte composite nommée ProdAlarm dans le compte spécifié.

aws cloudwatch put-composite-alarm \ --alarm-name ProdAlarm \ --alarm-rule "ALARM(CPUUtilizationTooHigh) AND ALARM(MemUsageTooHigh)" \ --alarm-actions arn:aws:sns:us-east-1:123456789012:demo \ --actions-enabled

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Création d’une alerte composite dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez PutCompositeAlarm dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-dashboard.

AWS CLI

Pour créer un tableau de bord

L’exemple put-dashboard suivant crée un tableau de bord nommé Dashboard-A dans le compte spécifié.

aws cloudwatch put-dashboard \ --dashboard-name Dashboard-A \ --dashboard-body '{"widgets":[{"height":6,"width":6,"y":0,"x":0,"type":"metric","properties":{"view":"timeSeries","stacked":false,"metrics":[["Namespace","CPUUtilization","Environment","Prod","Type","App"]],"region":"us-east-1"}}]}'

Sortie :

{ "DashboardValidationMessages": [] }

Pour plus d’informations, consultez Création d’un tableau de bord CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez PutDashboard dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-insight-rule.

AWS CLI

Pour créer une règle Contributor Insights

L’exemple put-insight-rule suivant crée une règle Contributor Insights nommée VPCFlowLogsContributorInsights dans le compte spécifié.

aws cloudwatch put-insight-rule \ --rule-name VPCFlowLogsContributorInsights \ --rule-definition file://insight-rule.json \ --rule-state ENABLED

Contenu de insight-rule.json :

{ "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "AggregateOn": "Count", "Contribution": { "Filters": [], "Keys": [ "tcp-flag" ] }, "LogFormat": "CLF", "LogGroupNames": [ "/vpc/flowlogs/*" ], "Fields": { "23": "tcp-flag" } }

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Création d’une règle Contributor Insights dans CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez PutInsightRule dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-metric-alarm.

AWS CLI

Pour envoyer un e-mail Amazon Simple Notification Service lorsque l’utilisation du processeur dépasse 70 %

L’exemple suivant fait appel à la commande put-metric-alarm pour envoyer un message e-mail Amazon Simple Notification Service lorsque l’utilisation du processeur dépasse 70 % :

aws cloudwatch put-metric-alarm --alarm-name cpu-mon --alarm-description "Alarm when CPU exceeds 70 percent" --metric-name CPUUtilization --namespace AWS/EC2 --statistic Average --period 300 --threshold 70 --comparison-operator GreaterThanThreshold --dimensions "Name=InstanceId,Value=i-12345678" --evaluation-periods 2 --alarm-actions arn:aws:sns:us-east-1:111122223333:MyTopic --unit Percent

Cette commande revient à l’invite en cas de succès. Si une alarme portant le même nom existe déjà, elle sera remplacée par la nouvelle alarme.

Pour spécifier plusieurs dimensions

L’exemple suivant illustre comment spécifier plusieurs dimensions. Chaque dimension est spécifiée sous la forme d’une paire nom/valeur, avec une virgule entre le nom et la valeur. Les différentes dimensions sont séparées par un espace :

aws cloudwatch put-metric-alarm --alarm-name "Default_Test_Alarm3" --alarm-description "The default example alarm" --namespace "CW EXAMPLE METRICS" --metric-name Default_Test --statistic Average --period 60 --evaluation-periods 3 --threshold 50 --comparison-operator GreaterThanOrEqualToThreshold --dimensions Name=key1,Value=value1 Name=key2,Value=value2
  • Pour plus de détails sur l’API, consultez PutMetricAlarm dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-metric-data.

AWS CLI

Pour publier une métrique personnalisée sur Amazon CloudWatch

L’exemple suivant fait appel à la commande put-metric-data pour publier une métrique personnalisée sur Amazon CloudWatch :

aws cloudwatch put-metric-data --namespace "Usage Metrics" --metric-data file://metric.json

Les valeurs de la métrique elle-même sont stockées dans le fichier JSON, metric.json.

Voici le contenu de ce fichier :

[ { "MetricName": "New Posts", "Timestamp": "Wednesday, June 12, 2013 8:28:20 PM", "Value": 0.50, "Unit": "Count" } ]

Pour plus d’informations, consultez Publication des métriques personnalisées dans le Manuel du développeur Amazon CloudWatch.

Pour spécifier plusieurs dimensions

L’exemple suivant illustre comment spécifier plusieurs dimensions. Chaque dimension est spécifiée sous la forme d’une paire nom=valeur. Les différentes dimensions sont séparées par une virgule :

aws cloudwatch put-metric-data --metric-name Buffers --namespace MyNameSpace --unit Bytes --value 231434333 --dimensions InstanceID=1-23456789,InstanceType=m1.small
  • Pour plus de détails sur l’API, consultez PutMetricData dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-metric-stream.

AWS CLI

Pour créer un flux de métriques

L’exemple put-metric-stream suivant crée un flux de métriques nommé QuickFull-GuaFb dans le compte spécifié.

aws cloudwatch put-metric-stream \ --name QuickFull-GuaFbs \ --firehose-arn arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG \ --role-arn arn:aws:iam::123456789012:role/service-role/MetricStreams-FirehosePutRecords-JN10W9B3 \ --output-format json \ --no-include-linked-accounts-metrics

Sortie :

{ "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs" }

Pour plus d’informations, consultez Configurer un flux de métriques dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez PutMetricStream dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser set-alarm-state.

AWS CLI

Pour modifier temporairement l’état d’une alarme

L’exemple suivant utilise la commande set-alarm-state pour modifier temporairement l’état d’une alarme Amazon CloudWatch nommée « myalarm » et la définir sur l’état ALARME à des fins de test :

aws cloudwatch set-alarm-state --alarm-name "myalarm" --state-value ALARM --state-reason "testing purposes"

Cette commande revient à l’invite en cas de succès.

  • Pour plus de détails sur l’API, consultez SetAlarmState dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser start-metric-streams.

AWS CLI

Pour démarrer un flux de métriques spécifié

L’exemple start-metric-streams suivant démarre le flux de métriques nommé QuickFull-GuaFbs dans le compte spécifié.

aws cloudwatch start-metric-streams \ --names QuickFull-GuaFbs

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utiliser les flux de métriques dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez StartMetricStreams dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser stop-metric-streams.

AWS CLI

Pour arrêter un flux de métriques spécifié

L’exemple stop-metric-streams suivant arrête le flux de métriques nommé QuickFull-GuaFbs dans le compte spécifié.

aws cloudwatch stop-metric-streams \ --names QuickFull-GuaFbs

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utiliser les flux de métriques dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez StopMetricStreams dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser tag-resource.

AWS CLI

Pour ajouter une ou plusieurs balises à la ressource spécifiée

L’exemple tag-resource suivant ajoute deux balises à l’alarme Cloudwatch nommée demo dans le compte spécifié.

aws cloudwatch tag-resource \ --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo \ --tags Key=stack,Value=Production Key=team,Value=Devops

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage de vos ressources Amazon CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez TagResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser untag-resource.

AWS CLI

Pour supprimer une ou plusieurs balises de la ressource spécifiée

L’exemple untag-resource suivant supprime deux balises de l’alarme Cloudwatch nommée demo dans le compte spécifié.

aws cloudwatch untag-resource \ --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo \ --tag-keys stack team

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage de vos ressources Amazon CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

  • Pour plus de détails sur l’API, consultez UntagResource dans la Référence des commandes de l’AWS CLI.