Table of Contents
A low-level client representing Amazon CloudWatch:
client = session.create_client('cloudwatch')
These are the available methods:
Check if an operation can be paginated.
Deletes the specified alarms. In the event of an error, no alarms are deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_alarms(
AlarmNames=[
'string',
]
)
[REQUIRED]
The alarms to be deleted.
Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_dashboards(
DashboardNames=[
'string',
]
)
[REQUIRED]
The dashboards to be deleted. This parameter is required.
{}
Response Structure
Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned.
CloudWatch retains the history of an alarm even if you delete the alarm.
See also: AWS API Documentation
Request Syntax
response = client.describe_alarm_history(
AlarmName='string',
HistoryItemType='ConfigurationUpdate'|'StateUpdate'|'Action',
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1),
MaxRecords=123,
NextToken='string'
)
dict
Response Syntax
{
'AlarmHistoryItems': [
{
'AlarmName': 'string',
'Timestamp': datetime(2015, 1, 1),
'HistoryItemType': 'ConfigurationUpdate'|'StateUpdate'|'Action',
'HistorySummary': 'string',
'HistoryData': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AlarmHistoryItems (list) --
The alarm histories, in JSON format.
(dict) --
Represents the history of a specific alarm.
AlarmName (string) --
The descriptive name for the alarm.
Timestamp (datetime) --
The time stamp for the alarm history item.
HistoryItemType (string) --
The type of alarm history item.
HistorySummary (string) --
A summary of the alarm history, in text format.
HistoryData (string) --
Data about the alarm, in JSON format.
NextToken (string) --
The token that marks the start of the next batch of returned results.
Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.
See also: AWS API Documentation
Request Syntax
response = client.describe_alarms(
AlarmNames=[
'string',
],
AlarmNamePrefix='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
ActionPrefix='string',
MaxRecords=123,
NextToken='string'
)
The names of the alarms.
dict
Response Syntax
{
'MetricAlarms': [
{
'AlarmName': 'string',
'AlarmArn': 'string',
'AlarmDescription': 'string',
'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
'ActionsEnabled': True|False,
'OKActions': [
'string',
],
'AlarmActions': [
'string',
],
'InsufficientDataActions': [
'string',
],
'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
'StateReason': 'string',
'StateReasonData': 'string',
'StateUpdatedTimestamp': datetime(2015, 1, 1),
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
'ExtendedStatistic': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Period': 123,
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
'EvaluationPeriods': 123,
'DatapointsToAlarm': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'TreatMissingData': 'string',
'EvaluateLowSampleCountPercentile': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MetricAlarms (list) --
The information for the specified alarms.
(dict) --
Represents an alarm.
AlarmName (string) --
The name of the alarm.
AlarmArn (string) --
The Amazon Resource Name (ARN) of the alarm.
AlarmDescription (string) --
The description of the alarm.
AlarmConfigurationUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm configuration.
ActionsEnabled (boolean) --
Indicates whether actions should be executed during any changes to the alarm state.
OKActions (list) --
The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
AlarmActions (list) --
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
InsufficientDataActions (list) --
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
StateValue (string) --
The state value for the alarm.
StateReason (string) --
An explanation for the alarm state, in text format.
StateReasonData (string) --
An explanation for the alarm state, in JSON format.
StateUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm state.
MetricName (string) --
The name of the metric associated with the alarm.
Namespace (string) --
The namespace of the metric associated with the alarm.
Statistic (string) --
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic .
ExtendedStatistic (string) --
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
Dimensions (list) --
The dimensions for the metric associated with the alarm.
(dict) --
Expands the identity of a metric.
Name (string) --
The name of the dimension.
Value (string) --
The value representing the dimension measurement.
Period (integer) --
The period, in seconds, over which the statistic is applied.
Unit (string) --
The unit of the metric associated with the alarm.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
DatapointsToAlarm (integer) --
The number of datapoints that must be breaching to trigger the alarm.
Threshold (float) --
The value to compare with the specified statistic.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
TreatMissingData (string) --
Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
EvaluateLowSampleCountPercentile (string) --
Used only for alarms based on percentiles. If ignore , the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
NextToken (string) --
The token that marks the start of the next batch of returned results.
Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.
See also: AWS API Documentation
Request Syntax
response = client.describe_alarms_for_metric(
MetricName='string',
Namespace='string',
Statistic='SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
ExtendedStatistic='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
Period=123,
Unit='Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
)
[REQUIRED]
The name of the metric.
[REQUIRED]
The namespace of the metric.
The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.
Expands the identity of a metric.
The name of the dimension.
The value representing the dimension measurement.
dict
Response Syntax
{
'MetricAlarms': [
{
'AlarmName': 'string',
'AlarmArn': 'string',
'AlarmDescription': 'string',
'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
'ActionsEnabled': True|False,
'OKActions': [
'string',
],
'AlarmActions': [
'string',
],
'InsufficientDataActions': [
'string',
],
'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
'StateReason': 'string',
'StateReasonData': 'string',
'StateUpdatedTimestamp': datetime(2015, 1, 1),
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
'ExtendedStatistic': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Period': 123,
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
'EvaluationPeriods': 123,
'DatapointsToAlarm': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'TreatMissingData': 'string',
'EvaluateLowSampleCountPercentile': 'string'
},
]
}
Response Structure
(dict) --
MetricAlarms (list) --
The information for each alarm with the specified metric.
(dict) --
Represents an alarm.
AlarmName (string) --
The name of the alarm.
AlarmArn (string) --
The Amazon Resource Name (ARN) of the alarm.
AlarmDescription (string) --
The description of the alarm.
AlarmConfigurationUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm configuration.
ActionsEnabled (boolean) --
Indicates whether actions should be executed during any changes to the alarm state.
OKActions (list) --
The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
AlarmActions (list) --
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
InsufficientDataActions (list) --
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
StateValue (string) --
The state value for the alarm.
StateReason (string) --
An explanation for the alarm state, in text format.
StateReasonData (string) --
An explanation for the alarm state, in JSON format.
StateUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm state.
MetricName (string) --
The name of the metric associated with the alarm.
Namespace (string) --
The namespace of the metric associated with the alarm.
Statistic (string) --
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic .
ExtendedStatistic (string) --
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
Dimensions (list) --
The dimensions for the metric associated with the alarm.
(dict) --
Expands the identity of a metric.
Name (string) --
The name of the dimension.
Value (string) --
The value representing the dimension measurement.
Period (integer) --
The period, in seconds, over which the statistic is applied.
Unit (string) --
The unit of the metric associated with the alarm.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
DatapointsToAlarm (integer) --
The number of datapoints that must be breaching to trigger the alarm.
Threshold (float) --
The value to compare with the specified statistic.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
TreatMissingData (string) --
Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
EvaluateLowSampleCountPercentile (string) --
Used only for alarms based on percentiles. If ignore , the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
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.
See also: AWS API Documentation
Request Syntax
response = client.disable_alarm_actions(
AlarmNames=[
'string',
]
)
[REQUIRED]
The names of the alarms.
Enables the actions for the specified alarms.
See also: AWS API Documentation
Request Syntax
response = client.enable_alarm_actions(
AlarmNames=[
'string',
]
)
[REQUIRED]
The names of the alarms.
Generate a presigned url given a client, its method, and arguments
The presigned url
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.
See also: AWS API Documentation
Request Syntax
response = client.get_dashboard(
DashboardName='string'
)
[REQUIRED]
The name of the dashboard to be described.
{
'DashboardArn': 'string',
'DashboardBody': 'string',
'DashboardName': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the dashboard.
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 CloudWatch-Dashboard-Body-Structure .
The name of the dashboard.
You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics . For more information about pricing, see Amazon CloudWatch Pricing .
See also: AWS API Documentation
Request Syntax
response = client.get_metric_data(
MetricDataQueries=[
{
'Id': 'string',
'MetricStat': {
'Metric': {
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Period': 123,
'Stat': 'string',
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
},
'Expression': 'string',
'Label': 'string',
'ReturnData': True|False
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
NextToken='string',
ScanBy='TimestampDescending'|'TimestampAscending',
MaxDatapoints=123
)
[REQUIRED]
The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.
This structure indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single GetMetricData call can include up to 100 MetricDataQuery structures.
A short name used to tie this structure to the results in the response. This name must be unique within a single call to GetMetricData . If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
The metric to be returned, along with statistics, period, and units. Use this parameter only if this structure is performing a data retrieval and not performing a math expression on the returned data.
Within one MetricDataQuery structure, you must specify either Expression or MetricStat but not both.
The metric to return, including the metric name, namespace, and dimensions.
The namespace of the metric.
The name of the metric.
The dimensions for the metric.
Expands the identity of a metric.
The name of the dimension.
The value representing the dimension measurement.
The period to use when retrieving the metric.
The statistic to return. It can include any CloudWatch statistic or extended statistic.
The unit to use for the returned data points.
The math expression to be performed on the returned data, if this structure is performing a math expression. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .
Within one MetricDataQuery structure, you must specify either Expression or MetricStat but not both.
A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.
Indicates whether to return the time stamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False . If you omit this, the default of True is used.
[REQUIRED]
The time stamp indicating the earliest data to be returned.
[REQUIRED]
The time stamp indicating the latest data to be returned.
dict
Response Syntax
{
'MetricDataResults': [
{
'Id': 'string',
'Label': 'string',
'Timestamps': [
datetime(2015, 1, 1),
],
'Values': [
123.0,
],
'StatusCode': 'Complete'|'InternalError'|'PartialData',
'Messages': [
{
'Code': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
MetricDataResults (list) --
The metrics that are returned, including the metric name, namespace, and dimensions.
(dict) --
A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the time stamps of those data points and other identifying information.
Id (string) --
The short name you specified to represent this metric.
Label (string) --
The human-readable label associated with the data.
Timestamps (list) --
The time stamps for the data points, formatted in Unix timestamp format. The number of time stamps always matches the number of values and the value for Timestamps[x] is Values[x].
Values (list) --
The data points for the metric corresponding to Timestamps . The number of values always matches the number of time stamps and the time stamp for Values[x] is Timestamps[x].
StatusCode (string) --
The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken , if present.
Messages (list) --
A list of messages with additional information about the data returned.
(dict) --
A message returned by the GetMetricData API, including a code and a description.
Code (string) --
The error code or status code associated with the message.
Value (string) --
The message text.
NextToken (string) --
A token that marks the next batch of returned results.
Gets statistics for the specified metric.
The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.
CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
Amazon CloudWatch retains metric data as follows:
Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.
CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.
For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_metric_statistics(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Period=123,
Statistics=[
'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
],
ExtendedStatistics=[
'string',
],
Unit='Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None'
)
[REQUIRED]
The namespace of the metric, with or without spaces.
[REQUIRED]
The name of the metric, with or without spaces.
The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide . For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide .
Expands the identity of a metric.
The name of the dimension.
The value representing the dimension measurement.
[REQUIRED]
The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.
The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
CloudWatch rounds the specified time stamp as follows:
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.
[REQUIRED]
The time stamp that determines the last data point to return.
The value specified is exclusive; results include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
[REQUIRED]
The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.
If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics . When calling GetMetricStatistics , you must specify either Statistics or ExtendedStatistics , but not both.
The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics , you must specify either Statistics or ExtendedStatistics , but not both.
dict
Response Syntax
{
'Label': 'string',
'Datapoints': [
{
'Timestamp': datetime(2015, 1, 1),
'SampleCount': 123.0,
'Average': 123.0,
'Sum': 123.0,
'Minimum': 123.0,
'Maximum': 123.0,
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
'ExtendedStatistics': {
'string': 123.0
}
},
]
}
Response Structure
(dict) --
Label (string) --
A label for the specified metric.
Datapoints (list) --
The data points for the specified metric.
(dict) --
Encapsulates the statistical data that CloudWatch computes from metric data.
Timestamp (datetime) --
The time stamp used for the data point.
SampleCount (float) --
The number of metric values that contributed to the aggregate value of this data point.
Average (float) --
The average of the metric values that correspond to the data point.
Sum (float) --
The sum of the metric values for the data point.
Minimum (float) --
The minimum metric value for the data point.
Maximum (float) --
The maximum metric value for the data point.
Unit (string) --
The standard unit for the data point.
ExtendedStatistics (dict) --
The percentile statistic for the data point.
Create a paginator for an operation.
Returns an object that can wait for some condition.
Returns a list of the dashboards for your account. If you include DashboardNamePrefix , only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.
See also: AWS API Documentation
Request Syntax
response = client.list_dashboards(
DashboardNamePrefix='string',
NextToken='string'
)
dict
Response Syntax
{
'DashboardEntries': [
{
'DashboardName': 'string',
'DashboardArn': 'string',
'LastModified': datetime(2015, 1, 1),
'Size': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DashboardEntries (list) --
The list of matching dashboards.
(dict) --
Represents a specific dashboard.
DashboardName (string) --
The name of the dashboard.
DashboardArn (string) --
The Amazon Resource Name (ARN) of the dashboard.
LastModified (datetime) --
The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Size (integer) --
The size of the dashboard, in bytes.
NextToken (string) --
The token that marks the start of the next batch of returned results.
List the specified metrics. You can use the returned metrics with GetMetricStatistics to obtain statistical data.
Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.
After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricStatistics .
See also: AWS API Documentation
Request Syntax
response = client.list_metrics(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
NextToken='string'
)
The dimensions to filter against.
Represents filters for a dimension.
The dimension name to be matched.
The value of the dimension to be matched.
dict
Response Syntax
{
'Metrics': [
{
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Metrics (list) --
The metrics.
(dict) --
Represents a specific metric.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric.
Dimensions (list) --
The dimensions for the metric.
(dict) --
Expands the identity of a metric.
Name (string) --
The name of the dimension.
Value (string) --
The value representing the dimension measurement.
NextToken (string) --
The token that marks the start of the next batch of returned results.
Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.
You can have up to 500 dashboards per account. All dashboards in your account are global, not region-specific.
A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard , and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard .
When you create a dashboard with PutDashboard , a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.
See also: AWS API Documentation
Request Syntax
response = client.put_dashboard(
DashboardName='string',
DashboardBody='string'
)
[REQUIRED]
The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required.
[REQUIRED]
The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.
For more information about the syntax, see CloudWatch-Dashboard-Body-Structure .
dict
Response Syntax
{
'DashboardValidationMessages': [
{
'DataPath': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
DashboardValidationMessages (list) --
If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.
If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard may not render.
If this result includes error messages, the input was not valid and the operation failed.
(dict) --
An error or warning for the operation.
DataPath (string) --
The data path related to the message.
Message (string) --
A message describing the error or warning.
Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.
When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA . The alarm is evaluated and its state is set appropriately. Any actions associated with the state are then executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.
If you are an IAM user, you must have Amazon EC2 permissions for some operations:
If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.
If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.
If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.
You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or API.
See also: AWS API Documentation
Request Syntax
response = client.put_metric_alarm(
AlarmName='string',
AlarmDescription='string',
ActionsEnabled=True|False,
OKActions=[
'string',
],
AlarmActions=[
'string',
],
InsufficientDataActions=[
'string',
],
MetricName='string',
Namespace='string',
Statistic='SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
ExtendedStatistic='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
Period=123,
Unit='Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
EvaluationPeriods=123,
DatapointsToAlarm=123,
Threshold=123.0,
ComparisonOperator='GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
TreatMissingData='string',
EvaluateLowSampleCountPercentile='string'
)
[REQUIRED]
The name for the alarm. This name must be unique within the AWS account.
The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region :ec2:stop | arn:aws:automate:region :ec2:terminate | arn:aws:automate:region :ec2:recover | arn:aws:sns:region :account-id :sns-topic-name | arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name
Valid Values (for use with IAM roles): arn:aws:swf:region :{account-id }:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region :{account-id }:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region :{account-id }:action/actions/AWS_EC2.InstanceId.Reboot/1.0
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region :ec2:stop | arn:aws:automate:region :ec2:terminate | arn:aws:automate:region :ec2:recover | arn:aws:sns:region :account-id :sns-topic-name | arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name
Valid Values (for use with IAM roles): arn:aws:swf:region :{account-id }:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region :{account-id }:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region :{account-id }:action/actions/AWS_EC2.InstanceId.Reboot/1.0
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region :ec2:stop | arn:aws:automate:region :ec2:terminate | arn:aws:automate:region :ec2:recover | arn:aws:sns:region :account-id :sns-topic-name | arn:aws:autoscaling:region :account-id :scalingPolicy:policy-id autoScalingGroupName/group-friendly-name :policyName/policy-friendly-name
Valid Values (for use with IAM roles): arn:aws:swf:region :{account-id }:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region :{account-id }:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region :{account-id }:action/actions/AWS_EC2.InstanceId.Reboot/1.0
[REQUIRED]
The name for the metric associated with the alarm.
[REQUIRED]
The namespace for the metric associated with the alarm.
The dimensions for the metric associated with the alarm.
Expands the identity of a metric.
The name of the dimension.
The value representing the dimension measurement.
[REQUIRED]
The period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any multiple of 60.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing .
An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.
The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.
[REQUIRED]
The number of periods over which data is compared to the specified threshold. If you are setting an alarm which requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.
[REQUIRED]
The value against which the specified statistic is compared.
[REQUIRED]
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data .
Valid Values: breaching | notBreaching | ignore | missing
Used only for alarms based on percentiles. If you specify ignore , the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples .
Valid Values: evaluate | ignore
None
Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics .
Each PutMetricData request is limited to 40 KB in size for HTTP POST requests.
Although the Value parameter accepts numbers of type Double , CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide .
Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricStatistics from the time they are submitted.
CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:
See also: AWS API Documentation
Request Syntax
response = client.put_metric_data(
Namespace='string',
MetricData=[
{
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Timestamp': datetime(2015, 1, 1),
'Value': 123.0,
'StatisticValues': {
'SampleCount': 123.0,
'Sum': 123.0,
'Minimum': 123.0,
'Maximum': 123.0
},
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
'StorageResolution': 123
},
]
)
[REQUIRED]
The namespace for the metric data.
You cannot specify a namespace that begins with "AWS/". Namespaces that begin with "AWS/" are reserved for use by Amazon Web Services products.
[REQUIRED]
The data for the metric.
Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
The name of the metric.
The dimensions associated with the metric.
Expands the identity of a metric.
The name of the dimension.
The value representing the dimension measurement.
The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
The value for the metric.
Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.
The statistical values for the metric.
The number of samples used for the statistic set.
The sum of values for the sample set.
The minimum value of the sample set.
The maximum value of the sample set.
The unit of the metric.
Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide .
This field is optional, if you do not specify it the default of 60 is used.
None
Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory .
See also: AWS API Documentation
Request Syntax
response = client.set_alarm_state(
AlarmName='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
StateReason='string',
StateReasonData='string'
)
[REQUIRED]
The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.
[REQUIRED]
The value of the state.
[REQUIRED]
The reason that this alarm is set to this specific state, in text format.
None
The available paginators are:
paginator = client.get_paginator('describe_alarm_history')
Creates an iterator that will paginate through responses from CloudWatch.Client.describe_alarm_history().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AlarmName='string',
HistoryItemType='ConfigurationUpdate'|'StateUpdate'|'Action',
StartDate=datetime(2015, 1, 1),
EndDate=datetime(2015, 1, 1),
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AlarmHistoryItems': [
{
'AlarmName': 'string',
'Timestamp': datetime(2015, 1, 1),
'HistoryItemType': 'ConfigurationUpdate'|'StateUpdate'|'Action',
'HistorySummary': 'string',
'HistoryData': 'string'
},
],
}
Response Structure
(dict) --
AlarmHistoryItems (list) --
The alarm histories, in JSON format.
(dict) --
Represents the history of a specific alarm.
AlarmName (string) --
The descriptive name for the alarm.
Timestamp (datetime) --
The time stamp for the alarm history item.
HistoryItemType (string) --
The type of alarm history item.
HistorySummary (string) --
A summary of the alarm history, in text format.
HistoryData (string) --
Data about the alarm, in JSON format.
paginator = client.get_paginator('describe_alarms')
Creates an iterator that will paginate through responses from CloudWatch.Client.describe_alarms().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
AlarmNames=[
'string',
],
AlarmNamePrefix='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
ActionPrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of the alarms.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'MetricAlarms': [
{
'AlarmName': 'string',
'AlarmArn': 'string',
'AlarmDescription': 'string',
'AlarmConfigurationUpdatedTimestamp': datetime(2015, 1, 1),
'ActionsEnabled': True|False,
'OKActions': [
'string',
],
'AlarmActions': [
'string',
],
'InsufficientDataActions': [
'string',
],
'StateValue': 'OK'|'ALARM'|'INSUFFICIENT_DATA',
'StateReason': 'string',
'StateReasonData': 'string',
'StateUpdatedTimestamp': datetime(2015, 1, 1),
'MetricName': 'string',
'Namespace': 'string',
'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
'ExtendedStatistic': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
],
'Period': 123,
'Unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
'EvaluationPeriods': 123,
'DatapointsToAlarm': 123,
'Threshold': 123.0,
'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
'TreatMissingData': 'string',
'EvaluateLowSampleCountPercentile': 'string'
},
],
}
Response Structure
(dict) --
MetricAlarms (list) --
The information for the specified alarms.
(dict) --
Represents an alarm.
AlarmName (string) --
The name of the alarm.
AlarmArn (string) --
The Amazon Resource Name (ARN) of the alarm.
AlarmDescription (string) --
The description of the alarm.
AlarmConfigurationUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm configuration.
ActionsEnabled (boolean) --
Indicates whether actions should be executed during any changes to the alarm state.
OKActions (list) --
The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
AlarmActions (list) --
The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).
InsufficientDataActions (list) --
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
StateValue (string) --
The state value for the alarm.
StateReason (string) --
An explanation for the alarm state, in text format.
StateReasonData (string) --
An explanation for the alarm state, in JSON format.
StateUpdatedTimestamp (datetime) --
The time stamp of the last update to the alarm state.
MetricName (string) --
The name of the metric associated with the alarm.
Namespace (string) --
The namespace of the metric associated with the alarm.
Statistic (string) --
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic .
ExtendedStatistic (string) --
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
Dimensions (list) --
The dimensions for the metric associated with the alarm.
(dict) --
Expands the identity of a metric.
Name (string) --
The name of the dimension.
Value (string) --
The value representing the dimension measurement.
Period (integer) --
The period, in seconds, over which the statistic is applied.
Unit (string) --
The unit of the metric associated with the alarm.
EvaluationPeriods (integer) --
The number of periods over which data is compared to the specified threshold.
DatapointsToAlarm (integer) --
The number of datapoints that must be breaching to trigger the alarm.
Threshold (float) --
The value to compare with the specified statistic.
ComparisonOperator (string) --
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
TreatMissingData (string) --
Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.
EvaluateLowSampleCountPercentile (string) --
Used only for alarms based on percentiles. If ignore , the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
paginator = client.get_paginator('list_dashboards')
Creates an iterator that will paginate through responses from CloudWatch.Client.list_dashboards().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DashboardNamePrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DashboardEntries': [
{
'DashboardName': 'string',
'DashboardArn': 'string',
'LastModified': datetime(2015, 1, 1),
'Size': 123
},
],
}
Response Structure
(dict) --
DashboardEntries (list) --
The list of matching dashboards.
(dict) --
Represents a specific dashboard.
DashboardName (string) --
The name of the dashboard.
DashboardArn (string) --
The Amazon Resource Name (ARN) of the dashboard.
LastModified (datetime) --
The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Size (integer) --
The size of the dashboard, in bytes.
paginator = client.get_paginator('list_metrics')
Creates an iterator that will paginate through responses from CloudWatch.Client.list_metrics().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Namespace='string',
MetricName='string',
Dimensions=[
{
'Name': 'string',
'Value': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The dimensions to filter against.
Represents filters for a dimension.
The dimension name to be matched.
The value of the dimension to be matched.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Metrics': [
{
'Namespace': 'string',
'MetricName': 'string',
'Dimensions': [
{
'Name': 'string',
'Value': 'string'
},
]
},
],
}
Response Structure
(dict) --
Metrics (list) --
The metrics.
(dict) --
Represents a specific metric.
Namespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric.
Dimensions (list) --
The dimensions for the metric.
(dict) --
Expands the identity of a metric.
Name (string) --
The name of the dimension.
Value (string) --
The value representing the dimension measurement.
The available waiters are:
waiter = client.get_waiter('alarm_exists')
Polls CloudWatch.Client.describe_alarms() every 5 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
AlarmNames=[
'string',
],
AlarmNamePrefix='string',
StateValue='OK'|'ALARM'|'INSUFFICIENT_DATA',
ActionPrefix='string',
MaxRecords=123,
NextToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The names of the alarms.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 40
None