Amazon CloudWatch - API Reference

1 Amazon CloudWatchAPI ReferenceAPI Version 2010-08-01 Amazon CloudWatch API ReferenceAmazon CloudWatch : API ReferenceCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon 's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon . All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored CloudWatch API ReferenceTable of ContentsWelcome .. 1 Actions .. 3 Request Parameters .. 3 Errors .. 3 See 3 DeleteDashboards .. 4 Request Parameters .. 4 Errors .. 4 See 4 DescribeAlarmHistory .. 5 Request Parameters.

2 5 Response Elements .. 6 Errors .. 6 See 7 Request Parameters .. 7 Response Elements .. 8 Errors .. 8 See 8 DescribeAlarmsForMetric .. 9 Request Parameters .. 9 Response Elements .. 10 Errors .. 10 See 10 DisableAlarmActions .. 11 Request Parameters .. 11 Errors .. 11 See 11 EnableAlarmActions .. 12 Request Parameters .. 12 Errors .. 12 See 12 GetDashboard .. 13 Request Parameters .. 13 Response Elements .. 13 Errors .. 13 See 15 Request Parameters .. 15 Response Elements .. 16 Errors .. 17 See 25 Request Parameters .. 25 Response Elements .. 28 Errors .. 28 See 30 Request Parameters .. 30 Response Elements .. 31 Errors .. 31 API Version 2010-08-01iiiAmazon CloudWatch API ReferenceSee 32 ListDashboards.

3 33 Request Parameters .. 33 Response Elements .. 33 Errors .. 33 See 35 Request Parameters .. 35 Response Elements .. 35 Errors .. 36 See 36 PutDashboard .. 37 Request Parameters .. 37 Response Elements .. 37 Errors .. 38 See 43 Request Parameters .. 43 Errors .. 48 See 51 Request Parameters .. 51 Errors .. 52 See 55 Request Parameters .. 55 Errors .. 55 See 56 Data Types .. 58 See 58 DashboardEntry .. 60 See 60 DashboardValidationMessage .. 61 See 62 See 64 See 65 See 66 See 67 See 68 API Version 2010-08-01ivAmazon CloudWatch API 68 See 72 MetricDataQuery .. 73 See 74 MetricDataResult .. 75 See 77 See 80 See 81 See 81 Dashboard Body Structure and Syntax.

4 82 Overall Structure .. 82 Properties of a Text Widget Object .. 84 Properties of a Metric Widget Object .. 84 Metric Widget: Format for Each Metric in the Array .. 87 Dashboard Widget Object: Rendering Properties Object Format .. 88 Dashboard Widget Object: Annotation Properties .. 89 Dashboard Widget Object: yAxis Properties Format .. 94 GetMetricWidgetImage: Metric Widget Structure and Syntax .. 95 Overall Structure .. 95 Format for Each Metric in the Array of Metrics .. 97 Options Object Format .. 98 Annotation Properties Format .. 101yAxis Properties Format .. 104 Making API Requests .. 106 Amazon CloudWatch Endpoints .. 106 Query Parameters .. 106 Request Identifiers .. 106 Query API Authentication .. 106 Available Libraries .. 106 Making API Requests Using the POST Method.

5 107 Common Parameters .. 109 Common Errors .. 111 API Version 2010-08-01vAmazon CloudWatch API ReferenceWelcomeAmazon CloudWatch enables you to publish, monitor, and manage various metrics, as well as configurealarm actions based on data from metrics. This guide provides detailed information about CloudWatchactions, data types, parameters, and errors. For more information about CloudWatch features, seeAmazon CloudWatch and the Amazon CloudWatch User information about the metrics that other AWS products send to CloudWatch , see the AmazonCloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User the following links to get started using the CloudWatch Query API: Actions (p. 2): An alphabetical list of all CloudWatch actions. Data Types (p. 57): An alphabetical list of all CloudWatch data types.

6 Common Parameters (p. 109): Parameters that all Query actions can use. Common Errors (p. 111): Client and server errors that all actions can return. Regions and Endpoints: Supported regions and endpoints for all AWS , you can use one of the AWS SDKs to access CloudWatch using an API tailored to yourprogramming language or in the AWS developer community also provide their own libraries, which you can find at thefollowing AWS developer centers: Java Developer Center JavaScript Developer Center AWS Mobile Services PHP Developer Center Python Developer Center Ruby Developer Center Windows and .NET Developer CenterAPI Version 2010-08-011 Amazon CloudWatch API ReferenceActionsThe following actions are supported: DeleteAlarms (p. 3) DeleteDashboards (p. 4) DescribeAlarmHistory (p.)

7 5) DescribeAlarms (p. 7) DescribeAlarmsForMetric (p. 9) DisableAlarmActions (p. 11) EnableAlarmActions (p. 12) GetDashboard (p. 13) GetMetricData (p. 15) GetMetricStatistics (p. 25) GetMetricWidgetImage (p. 30) ListDashboards (p. 33) ListMetrics (p. 35) PutDashboard (p. 37) PutMetricAlarm (p. 43) PutMetricData (p. 51) SetAlarmState (p. 55)API Version 2010-08-012 Amazon CloudWatch API ReferenceDeleteAlarmsDeleteAlarmsDeletes the specified alarms. In the event of an error, no alarms are ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 109). alarms to be : Array of stringsArray Members: Maximum number of 100 Constraints: Minimum length of 1. Maximum length of : YesErrorsFor information about the errors that are common to all actions, see Common Errors (p.

8 111).ResourceNotFoundThe named resource does not Status Code: 404 See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following: AWS Command Line Interface AWS SDK for .NET AWS SDK for C++ AWS SDK for Go AWS SDK for Java AWS SDK for JavaScript AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V2 API Version 2010-08-013 Amazon CloudWatch API ReferenceDeleteDashboardsDeleteDashboard sDeletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is anerror during this call, no dashboards are ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 109). dashboards to be deleted. This parameter is : Array of stringsRequired: YesErrorsFor information about the errors that are common to all actions, see Common Errors (p.

9 111).InternalServiceErrorRequest processing has failed due to some unknown error, exception, or Status Code: 500 InvalidParameterValueThe value of an input parameter is bad or Status Code: 400 ResourceNotFoundThe specified dashboard does not Status Code: 404 See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following: AWS Command Line Interface AWS SDK for .NET AWS SDK for C++ AWS SDK for Go AWS SDK for Java AWS SDK for JavaScript AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V2 API Version 2010-08-014 Amazon CloudWatch API ReferenceDescribeAlarmHistoryDescribeAla rmHistoryRetrieves the history for the specified alarm. You can filter the results by date range or item type. If analarm name is not specified, the histories for all alarms are retains the history of an alarm even if you delete the ParametersFor information about the parameters that are common to all actions, see CommonParameters (p.

10 109).AlarmNameThe name of the : StringLength Constraints: Minimum length of 1. Maximum length of : NoEndDateThe ending date to retrieve alarm : TimestampRequired: NoHistoryItemTypeThe type of alarm histories to : StringValid Values: ConfigurationUpdate | StateUpdate | ActionRequired: NoMaxRecordsThe maximum number of alarm history records to : IntegerValid Range: Minimum value of 1. Maximum value of : NoNextTokenThe token returned by a previous call to indicate that there is more data : StringLength Constraints: Minimum length of 0. Maximum length of : NoStartDateThe starting date to retrieve alarm Version 2010-08-015 Amazon CloudWatch API ReferenceResponse ElementsType: TimestampRequired: NoResponse ElementsThe following elements are returned by the alarm histories, in JSON : Array of AlarmHistoryItem (p.