"MetricName:": "CPUUtilization"
}
"Value": "value1"
For 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 V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeInsightRules
DescribeInsightRules
Returns a list of all the Contributor Insights rules in your account.
For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
MaxResults
The maximum number of results to return in one operation. If you omit this parameter, the default of 500 is used.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No NextToken
Include this value, if it was returned by the previous operation, to get the next set of rules.
Type: String Required: No
Response Elements
The following elements are returned by the service.
InsightRules.member.N
The rules returned by the operation.
Type: Array of InsightRule (p. 133) objects NextToken
If this parameter is present, it is a token that marks the start of the next batch of returned results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 209).
InvalidNextToken
The next token specified is invalid.
HTTP Status Code: 400
See Also
For 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 V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DisableAlarmActions
DisableAlarmActions
Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
AlarmNames.member.N The names of the alarms.
Type: Array of strings
Array Members: Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors (p. 209).
See Also
For 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 V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DisableInsightRules
Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
RuleNames.member.N
An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\x20-\x7E]+
Required: Yes
Response Elements
The following element is returned by the service.
Failures.member.N
An array listing the rules that could not be disabled. You cannot disable built-in rules.
Type: Array of PartialFailure (p. 161) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 209).
InvalidParameterValue
The value of an input parameter is bad or out-of-range.
HTTP Status Code: 400 MissingParameter
An input parameter that is required is missing.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
EnableAlarmActions
Enables the actions for the specified alarms.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
AlarmNames.member.N The names of the alarms.
Type: Array of strings
Array Members: Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors (p. 209).
See Also
For 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 V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
EnableInsightRules
EnableInsightRules
Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
RuleNames.member.N
An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\x20-\x7E]+
Required: Yes
Response Elements
The following element is returned by the service.
Failures.member.N
An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
Type: Array of PartialFailure (p. 161) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 209).
InvalidParameterValue
The value of an input parameter is bad or out-of-range.
HTTP Status Code: 400 LimitExceeded
The operation exceeded one or more limits.
HTTP Status Code: 400 MissingParameter
An input parameter that is required is missing.
HTTP Status Code: 400
See Also
For 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 V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetDashboard
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
DashboardName
The name of the dashboard to be described.
Type: String Required: Yes
Response Elements
The following elements are returned by the service.
DashboardArn
The Amazon Resource Name (ARN) of the dashboard.
Type: String DashboardBody
The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see Dashboard Body Structure and Syntax.
Type: String DashboardName
The name of the dashboard.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 209).
InternalServiceError
Request processing has failed due to some unknown error, exception, or failure.
HTTP Status Code: 500 InvalidParameterValue
The value of an input parameter is bad or out-of-range.
HTTP Status Code: 400 ResourceNotFound
The specified dashboard does not exist.
HTTP Status Code: 404
See Also
For 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 V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetInsightRuleReport
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
EndTime
The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
Type: Timestamp Required: Yes MaxContributorCount
The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.
Type: Integer Required: No Metrics.member.N
Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics:
• 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.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: [\x20-\x7E]+
Required: No OrderBy
Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: [\x20-\x7E]+
Required: No Period
The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes RuleName
The name of the rule that you want to see data from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\x20-\x7E]+
Required: Yes StartTime
The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
Type: Timestamp Required: Yes
Response Elements
Response Elements
The following elements are returned by the service.
AggregateValue
The sum of the values from all individual contributors that match the rule.
Type: Double AggregationStatistic
Specifies whether this rule aggregates contributor data by COUNT or SUM.
Type: String
ApproximateUniqueCount
An approximate count of the unique contributors found by this rule in this time period.
Type: Long
Contributors.member.N
An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values for the keys counts as a unique contributor.
Type: Array of InsightRuleContributor (p. 135) objects KeyLabels.member.N
An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors. If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.
Type: Array of strings MetricDatapoints.member.N
A time series of metric data points that matches the time period in the rule request.
Type: Array of InsightRuleMetricDatapoint (p. 137) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 209).
InvalidParameterValue
The value of an input parameter is bad or out-of-range.
HTTP Status Code: 400 MissingParameter
An input parameter that is required is missing.
HTTP Status Code: 400 ResourceNotFound
The named resource does not exist.
HTTP Status Code: 404
See Also
For 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 V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetMetricData
GetMetricData
You can use the GetMetricData API to retrieve CloudWatch metric values. The operation can also include a CloudWatch Metrics Insights query, and one or more metric math functions.
A GetMetricData operation that does not include a query can 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 metric 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.
If you include a Metrics Insights query, each GetMetricData operation can include only one query. But the same GetMetricData operation can also retrieve other metrics. Metrics Insights queries can query only the most recent three hours of metric data. For more information about Metrics Insights, see Query your metrics with CloudWatch Metrics Insights.
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.
Using Metrics Insights queries with metric math
You can't mix a Metric Insights query and metric math syntax in the same expression, but you can reference results from a Metrics Insights query within other Metric math expressions. A Metrics Insights query without a GROUP BY clause returns a single time-series (TS), and can be used as input for a metric math expression that expects a single time series. A Metrics Insights query with a GROUP BY clause returns an array of time-series (TS[]), and can be used as input for a metric math expression that expects an array of time series.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 207).
EndTime
The time stamp indicating the latest data to be returned.
The value specified is exclusive; results include data points up to the specified time stamp.
For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.
Type: Timestamp Required: Yes LabelOptions
This structure includes the Timezone parameter, which you can use to specify your time zone so that the labels of returned data display the correct time for your time zone.
Type: LabelOptions (p. 139) object Required: No
MaxDatapoints
The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.
Type: Integer Required: No
MetricDataQueries.member.N
The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, a Metrics Insights query, or a math expression to perform on retrieved data.
Type: Array of MetricDataQuery (p. 147) objects Required: Yes
NextToken
Include this value, if it was returned by the previous GetMetricData operation, to get the next set of data points.
Type: String Required: No ScanBy
The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.
Type: String
Valid Values: TimestampDescending | TimestampAscending Required: No
StartTime
The time stamp indicating the earliest data to be returned.
The value specified is inclusive; results include data points with the specified time stamp.
Response Elements
CloudWatch rounds the specified time stamp as follows:
• Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.
• Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.
• Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.
If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
For better performance, specify StartTime and EndTime values that align with the value of the
For better performance, specify StartTime and EndTime values that align with the value of the