AWS CLI を使用した CloudWatch の例

次のコード例は、CloudWatch で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

アクション

次の例は、delete-alarms を使用する方法を説明しています。

AWS CLI

アラームを削除するには

次の例は、delete-alarms コマンドを使用して、「myalarm」という名前の Amazon CloudWatch アラームを削除します。


aws cloudwatch delete-alarms --alarm-names myalarm

出力:


This command returns to the prompt if successful.

API の詳細については、AWS CLI コマンドリファレンスの「DeleteAlarms」を参照してください。

次の例は、delete-anomaly-detector を使用する方法を説明しています。

AWS CLI

指定された異常検出モデルを削除する方法

次のdelete-anomaly-detector の例では、指定されたアカウントで異常検出モデルを削除します。


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

このコマンドでは何も出力されません。

詳細については、「Amazon CloudWatch ユーザーガイド」の「異常検出モデルの削除」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteAnomalyDetector」を参照してください。

次の例は、delete-dashboards を使用する方法を説明しています。

AWS CLI

指定されたダッシュボードを削除する方法

次の delete-dashboards の例では、指定されたアカウントの Dashboard-A および Dashboard-B という名前の 2 つのダッシュボードを削除します。


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

このコマンドでは何も出力されません。

詳細については、「Amazon CloudWatch ユーザーガイド」の「Amazon CloudWatch のダッシュボード」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteDashboards」を参照してください。

次の例は、delete-insight-rules を使用する方法を説明しています。

AWS CLI

指定した Contributor Insights のルールを削除するには

次の delete-insight-rules の例では、指定したアカウントから Rule-A および Rule-B という名前の 2 つの Contributor Insights ルールを削除します。


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

出力:


{
    "Failures": []
}

詳細については、Amazon CloudWatch ユーザーガイドの「Contributor Insights を使用して高カーディナリティデータを分析する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「DeleteInsightRules」を参照してください。

次の例は、delete-metric-stream を使用する方法を説明しています。

AWS CLI

指定したメトリクスストリームを削除するには

次の delete-metric-stream の例では、指定したアカウントから QuickPartial-gSCKvO という名前のメトリクスストリームを削除します。


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

このコマンドでは何も出力されません。

詳細については、Amazon CloudWatch ユーザーガイドの「メトリクスストリームを使用する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「DeleteMetricStream」を参照してください。

次の例は、describe-alarm-history を使用する方法を説明しています。

AWS CLI

アラームの履歴を取得するには

次の例は、describe-alarm-history コマンドを使用して、「myalarm」という名前の Amazon CloudWatch アラームの履歴を取得します。


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

出力:


{
    "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"
        }
    ]
}

API の詳細については、AWS CLI コマンドリファレンスの「DescribeAlarmHistory」を参照してください。

次の例は、describe-alarms-for-metric を使用する方法を説明しています。

AWS CLI

メトリクスに関連するアラームについての情報を表示するには

次の例は、describe-alarms-for-metric コマンドを使用して、Amazon EC2 CPUUtilization メトリクスと、ID i-0c986c72 のインスタンスに関連するすべてのアラームに関する情報を表示します。


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

出力:


{
    "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"
        }
    ]
}

API の詳細については、AWS CLI コマンドリファレンスの「DescribeAlarmsForMetric」を参照してください。

次の例は、describe-alarms を使用する方法を説明しています。

AWS CLI

アラームに関する情報を一覧表示するには

次の例は、describe-alarms コマンドを使用して、「myalarm」という名前のアラームに関する情報を表示します。


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

出力:


{
    "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"
        }
    ]
}

API の詳細については、AWS CLI コマンドリファレンスの「DescribeAlarms」を参照してください。

次の例は、describe-anomaly-detectors を使用する方法を説明しています。

AWS CLI

異常検出モデルのリストを取得する方法

次の describe-anomaly-detectors の例では、指定されたアカウントの AWS/Logs 名前空間に関連付けられた異常検出モデルに関する情報が表示されます。


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

出力:


{
    "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"
            }
        }
    ]
}

詳細については、「Amazon CloudWatch ユーザーガイド」の「CloudWatch 異常検出の使用」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeAnomalyDetectors」を参照してください。

次の例は、describe-insight-rules を使用する方法を説明しています。

AWS CLI

Contributor Insights ルールのリストを取得するには

次の describe-insight-rules の例では、指定したアカウントのすべての Contributor Insights ルールを表示します。


aws cloudwatch describe-insight-rules

出力:


{
    "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
        }
    ]
}

詳細については、Amazon CloudWatch ユーザーガイドの「Contributor Insights を使用して高カーディナリティデータを分析する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「DescribeInsightRules」を参照してください。

次の例は、disable-alarm-actions を使用する方法を説明しています。

AWS CLI

アラームのアクションを無効化するには

次の例は、disable-alarm-actions コマンドを使用して、「myalarm」という名前のアラームのアクションをすべて無効化します。


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

正常に完了すると、このコマンドはプロンプトに戻ります。

API の詳細については、AWS CLI コマンドリファレンスの「DisableAlarmActions」を参照してください。

次の例は、disable-insight-rules を使用する方法を説明しています。

AWS CLI

指定した Contributor Insights ルールを無効にするには

次の disable-insight-rules の例では、指定したアカウントの Rule-A および Rule-B という名前の 2 つの Contributor Insights ルールを無効にします。


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

出力:


{
    "Failures": []
}

詳細については、Amazon CloudWatch ユーザーガイドの「Contributor Insights を使用して高カーディナリティデータを分析する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「DisableInsightRules」を参照してください。

次の例は、enable-alarm-actions を使用する方法を説明しています。

AWS CLI

アラームのすべてのアクションを有効化するには

次の例は、enable-alarm-actions コマンドを使用して、「myalarm」という名前のアラームのアクションをすべて有効化します。


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

正常に完了すると、このコマンドはプロンプトに戻ります。

API の詳細については、AWS CLI コマンドリファレンスの「EnableAlarmActions」を参照してください。

次の例は、enable-insight-rules を使用する方法を説明しています。

AWS CLI

指定した Contributor Insights ルールを有効にするには

次の enable-insight-rules の例では、指定したアカウントの Rule-A および Rule-B という名前の 2 つの Contributor Insights ルールを有効にします。


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

出力:


{
    "Failures": []
}

詳細については、Amazon CloudWatch ユーザーガイドの「Contributor Insights を使用して高カーディナリティデータを分析する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「EnableInsightRules」を参照してください。

次の例は、get-dashboard を使用する方法を説明しています。

AWS CLI

ダッシュボードに関する情報を取得する方法

次の get-dashboard の例では、指定されたアカウントで Dashboard-A という名前のダッシュボードに関する情報が表示されます。


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

出力:


{
    "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"
}

詳細については、「Amazon CloudWatch ユーザーガイド」の「Amazon CloudWatch のダッシュボード」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetDashboard」を参照してください。

次の例は、get-insight-rule-report を使用する方法を説明しています。

AWS CLI

Contributor Insights ルールによって収集された時系列データを取得するには

次の get-insight-rule-report の例では、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

出力:


{
    "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": []
}

詳細については、Amazon CloudWatch ユーザーガイドの「Contributor Insights を使用して高カーディナリティデータを分析する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「GetInsightRuleReport」を参照してください。

次の例は、get-metric-data を使用する方法を説明しています。

AWS CLI

例 1: 数式を使用して指定された EC2 の平均合計 IOPS を取得する方法

次の get-metric-data の例では、EBSReadOps と EBSWriteOps メトリクスを組み合わせた Metric Math 式を使用して、InstanceID i-abcdef を持つ EC2 インスタンスの CloudWatch メトリクス値を取得します。


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

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
    }
]

出力:


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

例 2: CloudWatch 請求メトリクスを使用して推定 AWS 請求額をモニタリングする方法

次の get-metric-data の例では、AWS/Billing 名前空間から EstimatedCharges CloudWatch メトリクスを取得します。


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

出力:


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「CloudWatch メトリクスで数式の使用」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetMetricData」を参照してください。

次の例は、get-metric-statistics を使用する方法を説明しています。

AWS CLI

EC2 インスタンスあたりの CPU 使用率を取得するには

次の例は、get-metric-statistics コマンドを使用して、ID i-abcdef の EC2 インスタンスの CPU 使用率を取得します。


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

出力:


{
    "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"
}

複数のディメンションを指定する

次の例は、複数のディメンションを指定する方法を示しています。各ディメンションは名前/値のペアとして指定され、名前と値の間にはカンマが入ります。複数のディメンションはスペースで区切ります。また、1 つのメトリクスに複数のディメンションを含む場合は、定義されているディメンションごとに値を指定する必要があります。

get-metric-statistics コマンドのその他の使用例については、「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

API の詳細については、AWS CLI コマンドリファレンスの「GetMetricStatistics」を参照してください。

次の例は、get-metric-stream を使用する方法を説明しています。

AWS CLI

メトリクスストリームに関する情報を取得するには

次の get-metric-stream の例では、指定したアカウントの QuickFull-GuaFbs という名前のメトリクスストリームに関する情報が表示されます。


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

出力:


{
    "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
}

詳細については、Amazon CloudWatch ユーザーガイドの「メトリクスストリームを使用する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「GetMetricStream」を参照してください。

次の例は、get-metric-widget-image を使用する方法を説明しています。

AWS CLI

CPUUtilization のスナップショットグラフを取得する方法

次の get-metric-widget-image の例では、ID i-abcde を持つ EC2 インスタンスの CPUUtilization メトリクスのスナップショットグラフを取得し、取得したイメージを「image.png」という名前のファイルとしてローカルマシンに保存します。


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

このコマンドでは何も出力されません。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetMetricWidgetImage」を参照してください。

次の例は、list-dashboards を使用する方法を説明しています。

AWS CLI

ダッシュボードのリストを取得する方法

次の list-dashboards の例では、指定されたアカウントですべてのダッシュボードを一覧表示します。


aws cloudwatch list-dashboards

出力:


{
    "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
        }
    ]
}

詳細については、「Amazon CloudWatch ユーザーガイド」の「Amazon CloudWatch のダッシュボード」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListDashboards」を参照してください。

次の例は、list-metric-streams を使用する方法を説明しています。

AWS CLI

メトリクスストリームのリストを取得するには

次の list-metric-streams の例では、指定したアカウントのすべてのメトリクスストリームを一覧表示します。


aws cloudwatch list-metric-streams

出力:


{
    "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"
        }
    ]
}

詳細については、Amazon CloudWatch ユーザーガイドの「メトリクスストリームを使用する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「ListMetricStreams」を参照してください。

次の例は、list-metrics を使用する方法を説明しています。

AWS CLI

Amazon SNS のメトリクスを一覧表示するには

次の list-metrics の例は、Amazon SNS のメトリクスを表示します。


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

出力:


{
    "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"
        }
    ]
}

API の詳細については、AWS CLI コマンドリファレンスの「ListMetrics」を参照してください。

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

既存のアラームに関連付けられているタグを一覧表示するには*

次の list-tags-for-resource の例では、指定したアカウントの demo という名前のアラームに関連付けられているすべてのタグを一覧表示します。


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

出力:


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

詳細については、Amazon CloudWatch ユーザーガイドの「アラームとタグ付け」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListTagsForResource」を参照してください。

次の例は、put-anomaly-detector を使用する方法を説明しています。

AWS CLI

異常検出モデルを作成する方法

次の put-anomaly-detector の例では、CloudWatch メトリクスの異常検出モデルを作成します。


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

このコマンドでは何も出力されません。

詳細については、「Amazon CloudWatch ユーザーガイド」の「CloudWatch 異常検出の使用」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「PutAnomalyDetector」を参照してください。

次の例は、put-composite-alarm を使用する方法を説明しています。

AWS CLI

複合 CloudWatch アラームを作成するには

次の put-composite-alarm の例では、指定したアカウントに ProdAlarm という名前の複合アラームを作成します。


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

このコマンドでは何も出力されません。

詳細については、Amazon CloudWatch ユーザーガイドの「複合アラームを作成する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「PutCompositeAlarm」を参照してください。

次の例は、put-dashboard を使用する方法を説明しています。

AWS CLI

ダッシュボードを作成するには

次の put-dashboard の例では、指定されたアカウントで Dashboard-A という名前のダッシュボードを作成します。


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"}}]}'

出力:


{
    "DashboardValidationMessages": []
}

詳細については、「Amazon CloudWatchユーザーガイド」の「CloudWatch ダッシュボードの作成」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「PutParameter」を参照してください。

次の例は、put-insight-rule を使用する方法を説明しています。

AWS CLI

Contributor Insights ルールを作成するには

次の put-insight-rule の例では、指定したアカウントに VPCFlowLogsContributorInsights という名前の Contributor Insights ルールを作成します。


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

insight-rule.json の内容:


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

このコマンドでは何も出力されません。

詳細については、Amazon CloudWatch ユーザーガイドの「CloudWatch で Contributor Insights ルールを作成する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「PutInsightRule」を参照してください。

次の例は、put-metric-alarm を使用する方法を説明しています。

AWS CLI

CPU 使用率が 70% を超えたときに Amazon Simple Notification Service の E メールメッセージを送信するには

次の例では、put-metric-alarm コマンドを使用して、CPU 使用率が 70% を超えたときに、Amazon Simple Notification Service に E メールメッセージを送信します。


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

正常に完了すると、このコマンドはプロンプトに戻ります。同じ名前のアラームが既に存在する場合は、新しいアラームで上書きされます。

複数のディメンションを指定するには

次の例は、複数のディメンションを指定する方法を示しています。各ディメンションは名前/値のペアとして指定され、名前と値の間にはカンマが入ります。複数のディメンションはスペースで区切ります。


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

API の詳細については、AWS CLI コマンドリファレンスの「PutMetricAlarm」を参照してください。

次の例は、put-metric-data を使用する方法を説明しています。

AWS CLI

Amazon CloudWatch にカスタムメトリクスをパブリッシュするには

次の例は、put-metric-data コマンドを使用して、Amazon CloudWatch にカスタムメトリクスをパブリッシュします。


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

メトリクス自体の値は、JSON ファイル metric.json に保存されます。

ファイルの内容は次のとおりです。


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

詳細については、「Amazon CloudWatch ユーザーガイド」の「カスタムメトリクスをパブリッシュする」を参照してください。

複数のディメンションを指定するには

次の例は、複数のディメンションを指定する方法を示しています。各ディメンションは Name=Value ペアとして指定されます。複数のディメンションはコンマで区切ります。


aws cloudwatch put-metric-data --metric-name Buffers --namespace MyNameSpace --unit Bytes --value 231434333 --dimensions InstanceID=1-23456789,InstanceType=m1.small

API の詳細については、AWS CLI コマンドリファレンスの「PutMetricData」を参照してください。

次の例は、put-metric-stream を使用する方法を説明しています。

AWS CLI

メトリクスストリームを作成するには

次の QuickFull-GuaFb の例では、指定したアカウントに put-metric-stream という名前のメトリクスストリームを作成します。


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

出力:


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

詳細については、Amazon CloudWatch ユーザーガイドの「メトリクスストリームを設定する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「PutMetricStream」を参照してください。

次の例は、set-alarm-state を使用する方法を説明しています。

AWS CLI

アラームの状態を一時的に変更するには

次の例では、set-alarm-state コマンドを使用して「myalarm」という名前の Amazon CloudWatch アラームの状態を一時的に変更し、テスト目的で ALARM 状態に設定します。


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

正常に完了すると、このコマンドはプロンプトに戻ります。

API の詳細については、「AWS CLI コマンドリファレンス」の「SetAlarmState」を参照してください。

次の例は、start-metric-streams を使用する方法を説明しています。

AWS CLI

指定したメトリクスストリームを開始するには

次の start-metric-streams の例では、指定したアカウントの QuickFull-GuaFbs という名前のメトリクスストリームを開始します。


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

このコマンドでは何も出力されません。

詳細については、Amazon CloudWatch ユーザーガイドの「メトリクスストリームを使用する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「StartMetricStreams」を参照してください。

次の例は、stop-metric-streams を使用する方法を説明しています。

AWS CLI

指定したメトリクスストリームを停止するには

次の stop-metric-streams の例では、指定したアカウントの QuickFull-GuaFbs という名前のメトリクスストリームを停止します。


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

このコマンドでは何も出力されません。

詳細については、Amazon CloudWatch ユーザーガイドの「メトリクスストリームを使用する」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「StopMetricStreams」を参照してください。

次の例は、tag-resource を使用する方法を説明しています。

AWS CLI

指定したリソースに 1 つ以上のタグを追加するには

次の tag-resource の例では、指定したアカウントの demo という名前の CloudWatch アラームに 2 つのタグを追加します。


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

このコマンドでは何も出力されません。

詳細については、Amazon CloudWatch ユーザーガイドの「Amazon CloudWatch リソースのタグ付け」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「TagResource」を参照してください。

次の例は、untag-resource を使用する方法を説明しています。

AWS CLI

指定したリソースから 1 つ以上のタグを削除するには

次の untag-resource の例では、指定したアカウントの demo という名前の CloudWatch アラームから 2 つのタグを削除します。


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

このコマンドでは何も出力されません。

詳細については、Amazon CloudWatch ユーザーガイドの「Amazon CloudWatch リソースのタグ付け」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UntagResource」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

CloudTrail

CloudWatch Logs