Skip to content

Latest commit

 

History

History

amazonaws_monitoring

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/amazonaws_monitoring

Client library for Amazon CloudWatch

Installation and Usage

npm install --save @datafire/amazonaws_monitoring
let amazonaws_monitoring = require('@datafire/amazonaws_monitoring').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

Actions

DeleteAlarms

amazonaws_monitoring.DeleteAlarms({
  "AlarmNames": []
}, context)

Input

  • input object
    • AlarmNames required array

Output

Output schema unknown

DeleteAlarms

amazonaws_monitoring.DeleteAlarms({
  "AlarmNames": null
}, context)

Input

  • input object

Output

Output schema unknown

DeleteAnomalyDetector

amazonaws_monitoring.DeleteAnomalyDetector({
  "Namespace": "",
  "MetricName": "",
  "Stat": ""
}, context)

Input

  • input object
    • Namespace required string
    • MetricName required string
    • Dimensions array
    • Stat required string

Output

DeleteAnomalyDetector

amazonaws_monitoring.DeleteAnomalyDetector({
  "Namespace": null,
  "MetricName": null,
  "Stat": null
}, context)

Input

  • input object
    • Dimensions
    • MetricName required
    • Namespace required
    • Stat required

Output

DeleteDashboards

amazonaws_monitoring.DeleteDashboards({
  "DashboardNames": []
}, context)

Input

  • input object
    • DashboardNames required array

Output

DeleteDashboards

amazonaws_monitoring.DeleteDashboards({
  "DashboardNames": null
}, context)

Input

Output

DeleteInsightRules

amazonaws_monitoring.DeleteInsightRules({
  "RuleNames": []
}, context)

Input

  • input object
    • RuleNames required array

Output

DeleteInsightRules

amazonaws_monitoring.DeleteInsightRules({
  "RuleNames": null
}, context)

Input

Output

DescribeAlarmHistory

amazonaws_monitoring.DescribeAlarmHistory({}, context)

Input

  • input object
    • AlarmName string
    • AlarmTypes array
    • HistoryItemType string
    • StartDate string
    • EndDate string
    • MaxRecords integer
    • NextToken string
    • ScanBy string

Output

DescribeAlarmHistory

amazonaws_monitoring.DescribeAlarmHistory({}, context)

Input

  • input object
    • MaxRecords string
    • NextToken string
    • AlarmName
    • AlarmTypes
    • EndDate
    • HistoryItemType
    • MaxRecords
    • NextToken
    • ScanBy
    • StartDate

Output

DescribeAlarms

amazonaws_monitoring.DescribeAlarms({}, context)

Input

  • input object
    • AlarmNames array
    • AlarmNamePrefix string
    • AlarmTypes array
    • ChildrenOfAlarmName string
    • ParentsOfAlarmName string
    • StateValue string
    • ActionPrefix string
    • MaxRecords integer
    • NextToken string

Output

DescribeAlarms

amazonaws_monitoring.DescribeAlarms({}, context)

Input

  • input object
    • MaxRecords string
    • NextToken string
    • ActionPrefix
    • AlarmNamePrefix
    • AlarmNames
    • AlarmTypes
    • ChildrenOfAlarmName
    • MaxRecords
    • NextToken
    • ParentsOfAlarmName
    • StateValue

Output

DescribeAlarmsForMetric

amazonaws_monitoring.DescribeAlarmsForMetric({
  "MetricName": "",
  "Namespace": ""
}, context)

Input

  • input object
    • MetricName required string
    • Namespace required string
    • Statistic string
    • ExtendedStatistic string
    • Dimensions array
    • Period integer
    • Unit string

Output

DescribeAlarmsForMetric

amazonaws_monitoring.DescribeAlarmsForMetric({
  "MetricName": null,
  "Namespace": null
}, context)

Input

  • input object
    • Dimensions
    • ExtendedStatistic
    • MetricName required
    • Namespace required
    • Period
    • Statistic
    • Unit

Output

DescribeAnomalyDetectors

amazonaws_monitoring.DescribeAnomalyDetectors({}, context)

Input

  • input object
    • NextToken string
    • MaxResults integer
    • Namespace string
    • MetricName string
    • Dimensions array

Output

DescribeAnomalyDetectors

amazonaws_monitoring.DescribeAnomalyDetectors({}, context)

Input

  • input object
    • Dimensions
    • MaxResults
    • MetricName
    • Namespace
    • NextToken

Output

DescribeInsightRules

amazonaws_monitoring.DescribeInsightRules({}, context)

Input

  • input object
    • NextToken string
    • MaxResults integer

Output

DescribeInsightRules

amazonaws_monitoring.DescribeInsightRules({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

DisableAlarmActions

amazonaws_monitoring.DisableAlarmActions({
  "AlarmNames": []
}, context)

Input

  • input object
    • AlarmNames required array

Output

Output schema unknown

DisableAlarmActions

amazonaws_monitoring.DisableAlarmActions({
  "AlarmNames": null
}, context)

Input

  • input object

Output

Output schema unknown

DisableInsightRules

amazonaws_monitoring.DisableInsightRules({
  "RuleNames": []
}, context)

Input

  • input object
    • RuleNames required array

Output

DisableInsightRules

amazonaws_monitoring.DisableInsightRules({
  "RuleNames": null
}, context)

Input

Output

EnableAlarmActions

amazonaws_monitoring.EnableAlarmActions({
  "AlarmNames": []
}, context)

Input

  • input object
    • AlarmNames required array

Output

Output schema unknown

EnableAlarmActions

amazonaws_monitoring.EnableAlarmActions({
  "AlarmNames": null
}, context)

Input

  • input object

Output

Output schema unknown

EnableInsightRules

amazonaws_monitoring.EnableInsightRules({
  "RuleNames": []
}, context)

Input

  • input object
    • RuleNames required array

Output

EnableInsightRules

amazonaws_monitoring.EnableInsightRules({
  "RuleNames": null
}, context)

Input

Output

GetDashboard

amazonaws_monitoring.GetDashboard({
  "DashboardName": ""
}, context)

Input

  • input object
    • DashboardName required string

Output

GetDashboard

amazonaws_monitoring.GetDashboard({
  "DashboardName": null
}, context)

Input

  • input object
    • DashboardName required

Output

GetInsightRuleReport

amazonaws_monitoring.GetInsightRuleReport({
  "RuleName": "",
  "StartTime": "",
  "EndTime": "",
  "Period": 0
}, context)

Input

  • input object
    • RuleName required string
    • StartTime required string
    • EndTime required string
    • Period required integer
    • MaxContributorCount integer
    • Metrics array
    • OrderBy string

Output

GetInsightRuleReport

amazonaws_monitoring.GetInsightRuleReport({
  "RuleName": null,
  "StartTime": null,
  "EndTime": null,
  "Period": null
}, context)

Input

  • input object
    • EndTime required
    • MaxContributorCount
    • Metrics
    • OrderBy
    • Period required
    • RuleName required
    • StartTime required

Output

GetMetricData

amazonaws_monitoring.GetMetricData({
  "MetricDataQueries": [],
  "StartTime": "",
  "EndTime": ""
}, context)

Input

  • input object
    • MetricDataQueries required array
    • StartTime required string
    • EndTime required string
    • NextToken string
    • ScanBy string
    • MaxDatapoints integer

Output

GetMetricData

amazonaws_monitoring.GetMetricData({
  "MetricDataQueries": null,
  "StartTime": null,
  "EndTime": null
}, context)

Input

  • input object
    • MaxDatapoints string
    • NextToken string
    • EndTime required
    • MaxDatapoints
    • MetricDataQueries required
    • NextToken
    • ScanBy
    • StartTime required

Output

GetMetricStatistics

amazonaws_monitoring.GetMetricStatistics({
  "Namespace": "",
  "MetricName": "",
  "StartTime": "",
  "EndTime": "",
  "Period": 0
}, context)

Input

  • input object
    • Namespace required string
    • MetricName required string
    • Dimensions array
    • StartTime required string
    • EndTime required string
    • Period required integer
    • Statistics array
    • ExtendedStatistics array
    • Unit string

Output

GetMetricStatistics

amazonaws_monitoring.GetMetricStatistics({
  "Namespace": null,
  "MetricName": null,
  "StartTime": null,
  "EndTime": null,
  "Period": null
}, context)

Input

  • input object
    • Dimensions
    • EndTime required
    • ExtendedStatistics
    • MetricName required
    • Namespace required
    • Period required
    • StartTime required
    • Statistics
    • Unit

Output

GetMetricWidgetImage

amazonaws_monitoring.GetMetricWidgetImage({
  "MetricWidget": ""
}, context)

Input

  • input object
    • MetricWidget required string
    • OutputFormat string

Output

GetMetricWidgetImage

amazonaws_monitoring.GetMetricWidgetImage({
  "MetricWidget": null
}, context)

Input

  • input object
    • MetricWidget required
    • OutputFormat

Output

ListDashboards

amazonaws_monitoring.ListDashboards({}, context)

Input

  • input object
    • DashboardNamePrefix string
    • NextToken string

Output

ListDashboards

amazonaws_monitoring.ListDashboards({}, context)

Input

  • input object
    • NextToken string
    • DashboardNamePrefix
    • NextToken

Output

ListMetrics

amazonaws_monitoring.ListMetrics({}, context)

Input

  • input object
    • Namespace string
    • MetricName string
    • Dimensions array
    • NextToken string
    • RecentlyActive string

Output

ListMetrics

amazonaws_monitoring.ListMetrics({}, context)

Input

  • input object
    • NextToken string
    • Dimensions
    • MetricName
    • Namespace
    • NextToken
    • RecentlyActive

Output

ListTagsForResource

amazonaws_monitoring.ListTagsForResource({
  "ResourceARN": ""
}, context)

Input

  • input object
    • ResourceARN required string

Output

ListTagsForResource

amazonaws_monitoring.ListTagsForResource({
  "ResourceARN": null
}, context)

Input

  • input object
    • ResourceARN required

Output

PutAnomalyDetector

amazonaws_monitoring.PutAnomalyDetector({
  "Namespace": "",
  "MetricName": "",
  "Stat": ""
}, context)

Input

  • input object
    • Namespace required string
    • MetricName required string
    • Dimensions array
    • Stat required string
    • Configuration object

Output

PutAnomalyDetector

amazonaws_monitoring.PutAnomalyDetector({
  "Namespace": null,
  "MetricName": null,
  "Stat": null
}, context)

Input

  • input object
    • Configuration
      • ExcludedTimeRanges
      • MetricTimezone
    • Dimensions
    • MetricName required
    • Namespace required
    • Stat required

Output

PutCompositeAlarm

amazonaws_monitoring.PutCompositeAlarm({
  "AlarmName": "",
  "AlarmRule": ""
}, context)

Input

  • input object
    • ActionsEnabled boolean
    • AlarmActions array
    • AlarmDescription string
    • AlarmName required string
    • AlarmRule required string
    • InsufficientDataActions array
    • OKActions array
    • Tags array

Output

Output schema unknown

PutCompositeAlarm

amazonaws_monitoring.PutCompositeAlarm({
  "AlarmName": null,
  "AlarmRule": null
}, context)

Input

  • input object

Output

Output schema unknown

PutDashboard

amazonaws_monitoring.PutDashboard({
  "DashboardName": "",
  "DashboardBody": ""
}, context)

Input

  • input object
    • DashboardName required string
    • DashboardBody required string

Output

PutDashboard

amazonaws_monitoring.PutDashboard({
  "DashboardName": null,
  "DashboardBody": null
}, context)

Input

  • input object
    • DashboardBody required
    • DashboardName required

Output

PutInsightRule

amazonaws_monitoring.PutInsightRule({
  "RuleName": "",
  "RuleDefinition": ""
}, context)

Input

  • input object
    • RuleName required string
    • RuleState string
    • RuleDefinition required string
    • Tags array

Output

PutInsightRule

amazonaws_monitoring.PutInsightRule({
  "RuleName": null,
  "RuleDefinition": null
}, context)

Input

  • input object
    • RuleDefinition required
    • RuleName required
    • RuleState
    • Tags

Output

PutMetricAlarm

amazonaws_monitoring.PutMetricAlarm({
  "AlarmName": "",
  "EvaluationPeriods": 0,
  "ComparisonOperator": ""
}, context)

Input

  • input object
    • AlarmName required string
    • AlarmDescription string
    • ActionsEnabled boolean
    • OKActions array
    • AlarmActions array
    • InsufficientDataActions array
    • MetricName string
    • Namespace string
    • Statistic string
    • ExtendedStatistic string
    • Dimensions array
    • Period integer
    • Unit string
    • EvaluationPeriods required integer
    • DatapointsToAlarm integer
    • Threshold number
    • ComparisonOperator required string
    • TreatMissingData string
    • EvaluateLowSampleCountPercentile string
    • Metrics array
    • Tags array
    • ThresholdMetricId string

Output

Output schema unknown

PutMetricAlarm

amazonaws_monitoring.PutMetricAlarm({
  "AlarmName": null,
  "EvaluationPeriods": null,
  "ComparisonOperator": null
}, context)

Input

  • input object
    • ActionsEnabled
    • AlarmActions
    • AlarmDescription
    • AlarmName required
    • ComparisonOperator required
    • DatapointsToAlarm
    • Dimensions
    • EvaluateLowSampleCountPercentile
    • EvaluationPeriods required
    • ExtendedStatistic
    • InsufficientDataActions
    • MetricName
    • Metrics
    • Namespace
    • OKActions
    • Period
    • Statistic
    • Tags
    • Threshold
    • ThresholdMetricId
    • TreatMissingData
    • Unit

Output

Output schema unknown

PutMetricData

amazonaws_monitoring.PutMetricData({
  "Namespace": "",
  "MetricData": []
}, context)

Input

  • input object
    • Namespace required string
    • MetricData required array

Output

Output schema unknown

PutMetricData

amazonaws_monitoring.PutMetricData({
  "Namespace": null,
  "MetricData": null
}, context)

Input

  • input object
    • MetricData required
    • Namespace required

Output

Output schema unknown

SetAlarmState

amazonaws_monitoring.SetAlarmState({
  "AlarmName": "",
  "StateValue": "",
  "StateReason": ""
}, context)

Input

  • input object
    • AlarmName required string
    • StateValue required string
    • StateReason required string
    • StateReasonData string

Output

Output schema unknown

SetAlarmState

amazonaws_monitoring.SetAlarmState({
  "AlarmName": null,
  "StateValue": null,
  "StateReason": null
}, context)

Input

  • input object
    • AlarmName required
    • StateReason required
    • StateReasonData
    • StateValue required

Output

Output schema unknown

TagResource

amazonaws_monitoring.TagResource({
  "ResourceARN": "",
  "Tags": []
}, context)

Input

  • input object
    • ResourceARN required string
    • Tags required array

Output

TagResource

amazonaws_monitoring.TagResource({
  "ResourceARN": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceARN required
    • Tags required

Output

UntagResource

amazonaws_monitoring.UntagResource({
  "ResourceARN": "",
  "TagKeys": []
}, context)

Input

  • input object
    • ResourceARN required string
    • TagKeys required array

Output

UntagResource

amazonaws_monitoring.UntagResource({
  "ResourceARN": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceARN required
    • TagKeys required

Output

Definitions

ActionPrefix

  • ActionPrefix string

ActionsEnabled

  • ActionsEnabled boolean

AlarmArn

  • AlarmArn string

AlarmDescription

  • AlarmDescription string

AlarmHistoryItem

  • AlarmHistoryItem object: Represents the history of a specific alarm.
    • AlarmName
    • AlarmType
    • HistoryData
    • HistoryItemType
    • HistorySummary
    • Timestamp

AlarmHistoryItems

AlarmName

  • AlarmName string

AlarmNamePrefix

  • AlarmNamePrefix string

AlarmNames

AlarmRule

  • AlarmRule string

AlarmType

  • AlarmType string (values: CompositeAlarm, MetricAlarm)

AlarmTypes

AmazonResourceName

  • AmazonResourceName string

AnomalyDetector

  • AnomalyDetector object: An anomaly detection model associated with a particular CloudWatch metric and statistic. You can use the model to display a band of expected normal values when the metric is graphed.
    • Configuration
      • ExcludedTimeRanges
      • MetricTimezone
    • Dimensions
    • MetricName
    • Namespace
    • Stat
    • StateValue

AnomalyDetectorConfiguration

  • AnomalyDetectorConfiguration object: The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model and the time zone to use for the metric.
    • ExcludedTimeRanges
    • MetricTimezone

AnomalyDetectorExcludedTimeRanges

  • AnomalyDetectorExcludedTimeRanges array

AnomalyDetectorMetricStat

  • AnomalyDetectorMetricStat string

AnomalyDetectorMetricTimezone

  • AnomalyDetectorMetricTimezone string

AnomalyDetectorStateValue

  • AnomalyDetectorStateValue string (values: PENDING_TRAINING, TRAINED_INSUFFICIENT_DATA, TRAINED)

AnomalyDetectors

BatchFailures

ComparisonOperator

  • ComparisonOperator string (values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold, LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, GreaterThanUpperThreshold)

CompositeAlarm

  • CompositeAlarm object: The details about a composite alarm.
    • ActionsEnabled
    • AlarmActions
    • AlarmArn
    • AlarmConfigurationUpdatedTimestamp
    • AlarmDescription
    • AlarmName
    • AlarmRule
    • InsufficientDataActions
    • OKActions
    • StateReason
    • StateReasonData
    • StateUpdatedTimestamp
    • StateValue

CompositeAlarms

ConcurrentModificationException

Counts

DashboardArn

  • DashboardArn string

DashboardBody

  • DashboardBody string

DashboardEntries

DashboardEntry

  • DashboardEntry object: Represents a specific dashboard.
    • DashboardArn
    • DashboardName
    • LastModified
    • Size

DashboardInvalidInputError

DashboardName

  • DashboardName string

DashboardNamePrefix

  • DashboardNamePrefix string

DashboardNames

DashboardNotFoundError

DashboardValidationMessage

  • DashboardValidationMessage object: An error or warning for the operation.
    • DataPath
    • Message

DashboardValidationMessages

DataPath

  • DataPath string

Datapoint

  • Datapoint object: Encapsulates the statistical data that CloudWatch computes from metric data.
    • Average
    • ExtendedStatistics
    • Maximum
    • Minimum
    • SampleCount
    • Sum
    • Timestamp
    • Unit

DatapointValue

  • DatapointValue number

DatapointValueMap

  • DatapointValueMap object

DatapointValues

Datapoints

DatapointsToAlarm

  • DatapointsToAlarm integer

DeleteAlarmsInput

  • DeleteAlarmsInput object

DeleteAnomalyDetectorInput

  • DeleteAnomalyDetectorInput object
    • Dimensions
    • MetricName required
    • Namespace required
    • Stat required

DeleteAnomalyDetectorOutput

  • DeleteAnomalyDetectorOutput object

DeleteDashboardsInput

  • DeleteDashboardsInput object

DeleteDashboardsOutput

  • DeleteDashboardsOutput object

DeleteInsightRulesInput

DeleteInsightRulesOutput

DescribeAlarmHistoryInput

  • DescribeAlarmHistoryInput object
    • AlarmName
    • AlarmTypes
    • EndDate
    • HistoryItemType
    • MaxRecords
    • NextToken
    • ScanBy
    • StartDate

DescribeAlarmHistoryOutput

  • DescribeAlarmHistoryOutput object

DescribeAlarmsForMetricInput

  • DescribeAlarmsForMetricInput object
    • Dimensions
    • ExtendedStatistic
    • MetricName required
    • Namespace required
    • Period
    • Statistic
    • Unit

DescribeAlarmsForMetricOutput

  • DescribeAlarmsForMetricOutput object

DescribeAlarmsInput

  • DescribeAlarmsInput object
    • ActionPrefix
    • AlarmNamePrefix
    • AlarmNames
    • AlarmTypes
    • ChildrenOfAlarmName
    • MaxRecords
    • NextToken
    • ParentsOfAlarmName
    • StateValue

DescribeAlarmsOutput

DescribeAnomalyDetectorsInput

  • DescribeAnomalyDetectorsInput object
    • Dimensions
    • MaxResults
    • MetricName
    • Namespace
    • NextToken

DescribeAnomalyDetectorsOutput

  • DescribeAnomalyDetectorsOutput object

DescribeInsightRulesInput

  • DescribeInsightRulesInput object
    • MaxResults
    • NextToken

DescribeInsightRulesOutput

  • DescribeInsightRulesOutput object

Dimension

  • Dimension object: A dimension is a name/value pair that is part of the identity of a metric. You can assign up to 10 dimensions to a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric.
    • Name required
    • Value required

DimensionFilter

  • DimensionFilter object: Represents filters for a dimension.
    • Name required
    • Value

DimensionFilters

DimensionName

  • DimensionName string

DimensionValue

  • DimensionValue string

Dimensions

DisableAlarmActionsInput

  • DisableAlarmActionsInput object

DisableInsightRulesInput

DisableInsightRulesOutput

EnableAlarmActionsInput

  • EnableAlarmActionsInput object

EnableInsightRulesInput

EnableInsightRulesOutput

EvaluateLowSampleCountPercentile

  • EvaluateLowSampleCountPercentile string

EvaluationPeriods

  • EvaluationPeriods integer

ExceptionType

  • ExceptionType string

ExtendedStatistic

  • ExtendedStatistic string

ExtendedStatistics

FailureCode

  • FailureCode string

FailureDescription

  • FailureDescription string

FailureResource

  • FailureResource string

GetDashboardInput

  • GetDashboardInput object
    • DashboardName required

GetDashboardOutput

  • GetDashboardOutput object
    • DashboardArn
    • DashboardBody
    • DashboardName

GetInsightRuleReportInput

  • GetInsightRuleReportInput object
    • EndTime required
    • MaxContributorCount
    • Metrics
    • OrderBy
    • Period required
    • RuleName required
    • StartTime required

GetInsightRuleReportOutput

GetMetricDataInput

  • GetMetricDataInput object
    • EndTime required
    • MaxDatapoints
    • MetricDataQueries required
    • NextToken
    • ScanBy
    • StartTime required

GetMetricDataMaxDatapoints

  • GetMetricDataMaxDatapoints integer

GetMetricDataOutput

GetMetricStatisticsInput

  • GetMetricStatisticsInput object
    • Dimensions
    • EndTime required
    • ExtendedStatistics
    • MetricName required
    • Namespace required
    • Period required
    • StartTime required
    • Statistics
    • Unit

GetMetricStatisticsOutput

  • GetMetricStatisticsOutput object

GetMetricWidgetImageInput

  • GetMetricWidgetImageInput object
    • MetricWidget required
    • OutputFormat

GetMetricWidgetImageOutput

  • GetMetricWidgetImageOutput object
    • MetricWidgetImage

HistoryData

  • HistoryData string

HistoryItemType

  • HistoryItemType string (values: ConfigurationUpdate, StateUpdate, Action)

HistorySummary

  • HistorySummary string

InsightRule

  • InsightRule object: This structure contains the definition for a Contributor Insights rule.
    • Definition required
    • Name required
    • Schema required
    • State required

InsightRuleAggregationStatistic

  • InsightRuleAggregationStatistic string

InsightRuleContributor

  • InsightRuleContributor object:

    One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then a unique contributor is a unique combination of values from all the keys in the rule.

    If the rule contains a single key, then each unique contributor is each unique value for this key.

    For more information, see GetInsightRuleReport.

InsightRuleContributorDatapoint

InsightRuleContributorDatapoints

InsightRuleContributorKey

  • InsightRuleContributorKey string

InsightRuleContributorKeyLabel

  • InsightRuleContributorKeyLabel string

InsightRuleContributorKeyLabels

InsightRuleContributorKeys

InsightRuleContributors

InsightRuleDefinition

  • InsightRuleDefinition string

InsightRuleMaxResults

  • InsightRuleMaxResults integer

InsightRuleMetricDatapoint

  • InsightRuleMetricDatapoint object:

    One data point from the metric time series returned in a Contributor Insights rule report.

    For more information, see GetInsightRuleReport.

    • Average
    • MaxContributorValue
    • Maximum
    • Minimum
    • SampleCount
    • Sum
    • Timestamp required
    • UniqueContributors

InsightRuleMetricDatapoints

InsightRuleMetricList

InsightRuleMetricName

  • InsightRuleMetricName string

InsightRuleName

  • InsightRuleName string

InsightRuleNames

InsightRuleOrderBy

  • InsightRuleOrderBy string

InsightRuleSchema

  • InsightRuleSchema string

InsightRuleState

  • InsightRuleState string

InsightRuleUnboundDouble

  • InsightRuleUnboundDouble number

InsightRuleUnboundInteger

  • InsightRuleUnboundInteger integer

InsightRuleUnboundLong

  • InsightRuleUnboundLong integer

InsightRules

InternalServiceFault

InvalidFormatFault

InvalidNextToken

InvalidParameterCombinationException

InvalidParameterValueException

LastModified

  • LastModified string

LimitExceededException

LimitExceededFault

ListDashboardsInput

  • ListDashboardsInput object
    • DashboardNamePrefix
    • NextToken

ListDashboardsOutput

  • ListDashboardsOutput object

ListMetricsInput

  • ListMetricsInput object
    • Dimensions
    • MetricName
    • Namespace
    • NextToken
    • RecentlyActive

ListMetricsOutput

  • ListMetricsOutput object
    • Metrics
    • NextToken

ListTagsForResourceInput

  • ListTagsForResourceInput object
    • ResourceARN required

ListTagsForResourceOutput

  • ListTagsForResourceOutput object
    • Tags

MaxRecords

  • MaxRecords integer

MaxReturnedResultsCount

  • MaxReturnedResultsCount integer

Message

  • Message string

MessageData

  • MessageData object: A message returned by the GetMetricDataAPI, including a code and a description.
    • Code
    • Value

MessageDataCode

  • MessageDataCode string

MessageDataValue

  • MessageDataValue string

Metric

  • Metric object: Represents a specific metric.
    • Dimensions
    • MetricName
    • Namespace

MetricAlarm

  • MetricAlarm object: The details about a metric alarm.
    • ActionsEnabled
    • AlarmActions
    • AlarmArn
    • AlarmConfigurationUpdatedTimestamp
    • AlarmDescription
    • AlarmName
    • ComparisonOperator
    • DatapointsToAlarm
    • Dimensions
    • EvaluateLowSampleCountPercentile
    • EvaluationPeriods
    • ExtendedStatistic
    • InsufficientDataActions
    • MetricName
    • Metrics
    • Namespace
    • OKActions
    • Period
    • StateReason
    • StateReasonData
    • StateUpdatedTimestamp
    • StateValue
    • Statistic
    • Threshold
    • ThresholdMetricId
    • TreatMissingData
    • Unit

MetricAlarms

MetricData

MetricDataQueries

MetricDataQuery

  • MetricDataQuery object:

    This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.

    When used in GetMetricData, it 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 500 MetricDataQuery structures.

    When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have True as the value for ReturnData. The result of this expression is the value the alarm watches.

    Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

    Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

    • Expression
    • Id required
    • Label
    • MetricStat
      • Metric required
        • Dimensions
        • MetricName
        • Namespace
      • Period required
      • Stat required
      • Unit
    • Period
    • ReturnData

MetricDataResult

  • MetricDataResult object: A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

MetricDataResultMessages

MetricDataResults

MetricDatum

  • MetricDatum object: Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
    • Counts
    • Dimensions
    • MetricName required
    • StatisticValues
      • Maximum required
      • Minimum required
      • SampleCount required
      • Sum required
    • StorageResolution
    • Timestamp
    • Unit
    • Value
    • Values

MetricExpression

  • MetricExpression string

MetricId

  • MetricId string

MetricLabel

  • MetricLabel string

MetricName

  • MetricName string

MetricStat

  • MetricStat object: This structure defines the metric to be returned, along with the statistics, period, and units.
    • Metric required
      • Dimensions
      • MetricName
      • Namespace
    • Period required
    • Stat required
    • Unit

MetricWidget

  • MetricWidget string

MetricWidgetImage

  • MetricWidgetImage string

Metrics

MissingRequiredParameterException

Namespace

  • Namespace string

NextToken

  • NextToken string

OutputFormat

  • OutputFormat string

PartialFailure

  • PartialFailure object: This array is empty if the API operation was successful for all the rules specified in the request. If the operation could not process one of the rules, the following data is returned for each of those rules.
    • ExceptionType
    • FailureCode
    • FailureDescription
    • FailureResource

Period

  • Period integer

PutAnomalyDetectorInput

  • PutAnomalyDetectorInput object
    • Configuration
      • ExcludedTimeRanges
      • MetricTimezone
    • Dimensions
    • MetricName required
    • Namespace required
    • Stat required

PutAnomalyDetectorOutput

  • PutAnomalyDetectorOutput object

PutCompositeAlarmInput

  • PutCompositeAlarmInput object

PutDashboardInput

  • PutDashboardInput object
    • DashboardBody required
    • DashboardName required

PutDashboardOutput

PutInsightRuleInput

  • PutInsightRuleInput object
    • RuleDefinition required
    • RuleName required
    • RuleState
    • Tags

PutInsightRuleOutput

  • PutInsightRuleOutput object

PutMetricAlarmInput

  • PutMetricAlarmInput object
    • ActionsEnabled
    • AlarmActions
    • AlarmDescription
    • AlarmName required
    • ComparisonOperator required
    • DatapointsToAlarm
    • Dimensions
    • EvaluateLowSampleCountPercentile
    • EvaluationPeriods required
    • ExtendedStatistic
    • InsufficientDataActions
    • MetricName
    • Metrics
    • Namespace
    • OKActions
    • Period
    • Statistic
    • Tags
    • Threshold
    • ThresholdMetricId
    • TreatMissingData
    • Unit

PutMetricDataInput

  • PutMetricDataInput object
    • MetricData required
    • Namespace required

Range

  • Range object: Specifies one range of days or times to exclude from use for training an anomaly detection model.
    • EndTime required
    • StartTime required

RecentlyActive

  • RecentlyActive string (values: PT3H)

ResourceList

ResourceName

  • ResourceName string

ResourceNotFound

ResourceNotFoundException

ReturnData

  • ReturnData boolean

ScanBy

  • ScanBy string (values: TimestampDescending, TimestampAscending)

SetAlarmStateInput

  • SetAlarmStateInput object
    • AlarmName required
    • StateReason required
    • StateReasonData
    • StateValue required

Size

  • Size integer

StandardUnit

  • StandardUnit string (values: 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)

Stat

  • Stat string

StateReason

  • StateReason string

StateReasonData

  • StateReasonData string

StateValue

  • StateValue string (values: OK, ALARM, INSUFFICIENT_DATA)

Statistic

  • Statistic string (values: SampleCount, Average, Sum, Minimum, Maximum)

StatisticSet

  • StatisticSet object: Represents a set of statistics that describes a specific metric.
    • Maximum required
    • Minimum required
    • SampleCount required
    • Sum required

Statistics

StatusCode

  • StatusCode string (values: Complete, InternalError, PartialData)

StorageResolution

  • StorageResolution integer

Tag

  • Tag object: A key-value pair associated with a CloudWatch resource.
    • Key required
    • Value required

TagKey

  • TagKey string

TagKeyList

  • TagKeyList array

TagList

  • TagList array

TagResourceInput

  • TagResourceInput object
    • ResourceARN required
    • Tags required

TagResourceOutput

  • TagResourceOutput object

TagValue

  • TagValue string

Threshold

  • Threshold number

Timestamp

  • Timestamp string

Timestamps

TreatMissingData

  • TreatMissingData string

UntagResourceInput

  • UntagResourceInput object
    • ResourceARN required
    • TagKeys required

UntagResourceOutput

  • UntagResourceOutput object

Values