@datafire/amazonaws_monitoring v5.0.0

@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: ""
});

amazonaws_monitoring.DeleteAlarms({
  "AlarmNames": []
}).then(data => {
  console.log(data);
});

Description

Actions

DeleteAlarms

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

Input

• input object
  • AlarmNames required AlarmNames

Output

Output schema unknown

DeleteDashboards

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

Input

• input object
  • DashboardNames required DashboardNames

Output

• output DeleteDashboardsOutput

DescribeAlarmHistory

amazonaws_monitoring.DescribeAlarmHistory({}, context)

Input

• input object
  • MaxRecords string
  • NextToken string
  • AlarmName AlarmName
  • EndDate Timestamp
  • HistoryItemType HistoryItemType
  • MaxRecords MaxRecords
  • NextToken NextToken
  • StartDate Timestamp

Output

• output DescribeAlarmHistoryOutput

DescribeAlarms

amazonaws_monitoring.DescribeAlarms({}, context)

Input

• input object
  • MaxRecords string
  • NextToken string
  • ActionPrefix ActionPrefix
  • AlarmNamePrefix AlarmNamePrefix
  • AlarmNames AlarmNames
  • MaxRecords MaxRecords
  • NextToken NextToken
  • StateValue StateValue

Output

• output DescribeAlarmsOutput

DescribeAlarmsForMetric

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

Input

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

Output

• output DescribeAlarmsForMetricOutput

DisableAlarmActions

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

Input

• input object
  • AlarmNames required AlarmNames

Output

Output schema unknown

EnableAlarmActions

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

Input

• input object
  • AlarmNames required AlarmNames

Output

Output schema unknown

GetDashboard

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

Input

• input object
  • DashboardName required DashboardName

Output

• output GetDashboardOutput

GetMetricStatistics

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

Input

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

Output

• output GetMetricStatisticsOutput

ListDashboards

amazonaws_monitoring.ListDashboards({}, context)

Input

• input object
  • DashboardNamePrefix DashboardNamePrefix
  • NextToken NextToken

Output

• output ListDashboardsOutput

ListMetrics

amazonaws_monitoring.ListMetrics({}, context)

Input

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

Output

• output ListMetricsOutput

PutDashboard

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

Input

• input object
  • DashboardBody required DashboardBody
  • DashboardName required DashboardName

Output

• output PutDashboardOutput

PutMetricAlarm

amazonaws_monitoring.PutMetricAlarm({
  "AlarmName": "",
  "MetricName": "",
  "Namespace": "",
  "Period": 0,
  "EvaluationPeriods": 0,
  "Threshold": 0,
  "ComparisonOperator": ""
}, context)

Input

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

Output

Output schema unknown

PutMetricData

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

Input

• input object
  • MetricData required MetricData
  • Namespace required Namespace

Output

Output schema unknown

SetAlarmState

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

Input

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

Output

Output schema unknown

Definitions

ActionPrefix

• ActionPrefix string

ActionsEnabled

• ActionsEnabled boolean

AlarmArn

• AlarmArn string

AlarmDescription

• AlarmDescription string

AlarmHistoryItem

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

AlarmHistoryItems

• AlarmHistoryItems array
  • items AlarmHistoryItem

AlarmName

• AlarmName string

AlarmNamePrefix

• AlarmNamePrefix string

AlarmNames

• AlarmNames array
  • items AlarmName

AwsQueryErrorMessage

• AwsQueryErrorMessage string

ComparisonOperator

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

DashboardArn

• DashboardArn string

DashboardBody

• DashboardBody string

DashboardEntries

• DashboardEntries array
  • items DashboardEntry

DashboardEntry

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

DashboardErrorMessage

• DashboardErrorMessage string

DashboardInvalidInputError

• DashboardInvalidInputError object: Some part of the dashboard data is invalid.
  • dashboardValidationMessages DashboardValidationMessages
  • message DashboardErrorMessage

DashboardName

• DashboardName string

DashboardNamePrefix

• DashboardNamePrefix string

DashboardNames

• DashboardNames array
  • items DashboardName

DashboardNotFoundError

• DashboardNotFoundError object: The specified dashboard does not exist.
  • message DashboardErrorMessage

DashboardValidationMessage

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

DashboardValidationMessages

• DashboardValidationMessages array
  • items DashboardValidationMessage

DataPath

• DataPath string

Datapoint

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

DatapointValue

• DatapointValue number

DatapointValueMap

• DatapointValueMap array
  • items object
    • key ExtendedStatistic
    • value DatapointValue

Datapoints

• Datapoints array
  • items Datapoint

DatapointsToAlarm

• DatapointsToAlarm integer

DeleteAlarmsInput

• DeleteAlarmsInput object
  • AlarmNames required AlarmNames

DeleteDashboardsInput

• DeleteDashboardsInput object
  • DashboardNames required DashboardNames

DeleteDashboardsOutput

• DeleteDashboardsOutput object

DescribeAlarmHistoryInput

• DescribeAlarmHistoryInput object
  • AlarmName AlarmName
  • EndDate Timestamp
  • HistoryItemType HistoryItemType
  • MaxRecords MaxRecords
  • NextToken NextToken
  • StartDate Timestamp

DescribeAlarmHistoryOutput

• DescribeAlarmHistoryOutput object
  • AlarmHistoryItems AlarmHistoryItems
  • NextToken NextToken

DescribeAlarmsForMetricInput

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

DescribeAlarmsForMetricOutput

• DescribeAlarmsForMetricOutput object
  • MetricAlarms MetricAlarms

DescribeAlarmsInput

• DescribeAlarmsInput object
  • ActionPrefix ActionPrefix
  • AlarmNamePrefix AlarmNamePrefix
  • AlarmNames AlarmNames
  • MaxRecords MaxRecords
  • NextToken NextToken
  • StateValue StateValue

DescribeAlarmsOutput

• DescribeAlarmsOutput object
  • MetricAlarms MetricAlarms
  • NextToken NextToken

Dimension

• Dimension object: Expands the identity of a metric.
  • Name required DimensionName
  • Value required DimensionValue

DimensionFilter

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

DimensionFilters

• DimensionFilters array
  • items DimensionFilter

DimensionName

• DimensionName string

DimensionValue

• DimensionValue string

Dimensions

• Dimensions array
  • items Dimension

DisableAlarmActionsInput

• DisableAlarmActionsInput object
  • AlarmNames required AlarmNames

EnableAlarmActionsInput

• EnableAlarmActionsInput object
  • AlarmNames required AlarmNames

ErrorMessage

• ErrorMessage string

EvaluateLowSampleCountPercentile

• EvaluateLowSampleCountPercentile string

EvaluationPeriods

• EvaluationPeriods integer

ExtendedStatistic

• ExtendedStatistic string

ExtendedStatistics

• ExtendedStatistics array
  • items ExtendedStatistic

FaultDescription

• FaultDescription string

GetDashboardInput

• GetDashboardInput object
  • DashboardName required DashboardName

GetDashboardOutput

• GetDashboardOutput object
  • DashboardArn DashboardArn
  • DashboardBody DashboardBody
  • DashboardName DashboardName

GetMetricStatisticsInput

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

GetMetricStatisticsOutput

• GetMetricStatisticsOutput object
  • Datapoints Datapoints
  • Label MetricLabel

HistoryData

• HistoryData string

HistoryItemType

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

HistorySummary

• HistorySummary string

InternalServiceFault

• InternalServiceFault object: Request processing has failed due to some unknown error, exception, or failure.
  • Message FaultDescription

InvalidFormatFault

• InvalidFormatFault object: Data was not syntactically valid JSON.
  • message ErrorMessage

InvalidNextToken

• InvalidNextToken object: The next token specified is invalid.
  • message ErrorMessage

InvalidParameterCombinationException

• InvalidParameterCombinationException object: Parameters were used together that cannot be used together.
  • message AwsQueryErrorMessage

InvalidParameterValueException

• InvalidParameterValueException object: The value of an input parameter is bad or out-of-range.
  • message AwsQueryErrorMessage

LastModified

• LastModified string

LimitExceededFault

• LimitExceededFault object: The quota for alarms for this customer has already been reached.
  • message ErrorMessage

ListDashboardsInput

• ListDashboardsInput object
  • DashboardNamePrefix DashboardNamePrefix
  • NextToken NextToken

ListDashboardsOutput

• ListDashboardsOutput object
  • DashboardEntries DashboardEntries
  • NextToken NextToken

ListMetricsInput

• ListMetricsInput object
  • Dimensions DimensionFilters
  • MetricName MetricName
  • Namespace Namespace
  • NextToken NextToken

ListMetricsOutput

• ListMetricsOutput object
  • Metrics Metrics
  • NextToken NextToken

MaxRecords

• MaxRecords integer

Message

• Message string

Metric

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

MetricAlarm

• MetricAlarm object: Represents an alarm.
  • ActionsEnabled ActionsEnabled
  • AlarmActions ResourceList
  • AlarmArn AlarmArn
  • AlarmConfigurationUpdatedTimestamp Timestamp
  • AlarmDescription AlarmDescription
  • AlarmName AlarmName
  • ComparisonOperator ComparisonOperator
  • DatapointsToAlarm DatapointsToAlarm
  • Dimensions Dimensions
  • EvaluateLowSampleCountPercentile EvaluateLowSampleCountPercentile
  • EvaluationPeriods EvaluationPeriods
  • ExtendedStatistic ExtendedStatistic
  • InsufficientDataActions ResourceList
  • MetricName MetricName
  • Namespace Namespace
  • OKActions ResourceList
  • Period Period
  • StateReason StateReason
  • StateReasonData StateReasonData
  • StateUpdatedTimestamp Timestamp
  • StateValue StateValue
  • Statistic Statistic
  • Threshold Threshold
  • TreatMissingData TreatMissingData
  • Unit StandardUnit

MetricAlarms

• MetricAlarms array
  • items MetricAlarm

MetricData

• MetricData array
  • items MetricDatum

MetricDatum

• MetricDatum object: Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.
  • Dimensions Dimensions
  • MetricName required MetricName
  • StatisticValues StatisticSet
  • StorageResolution StorageResolution
  • Timestamp Timestamp
  • Unit StandardUnit
  • Value DatapointValue

MetricLabel

• MetricLabel string

MetricName

• MetricName string

Metrics

• Metrics array
  • items Metric

MissingRequiredParameterException

• MissingRequiredParameterException object: An input parameter that is required is missing.
  • message AwsQueryErrorMessage

Namespace

• Namespace string

NextToken

• NextToken string

Period

• Period integer

PutDashboardInput

• PutDashboardInput object
  • DashboardBody required DashboardBody
  • DashboardName required DashboardName

PutDashboardOutput

• PutDashboardOutput object
  • DashboardValidationMessages DashboardValidationMessages

PutMetricAlarmInput

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

PutMetricDataInput

• PutMetricDataInput object
  • MetricData required MetricData
  • Namespace required Namespace

ResourceList

• ResourceList array
  • items ResourceName

ResourceName

• ResourceName string

ResourceNotFound

• ResourceNotFound object: The named resource does not exist.
  • message ErrorMessage

SetAlarmStateInput

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

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)

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 DatapointValue
  • Minimum required DatapointValue
  • SampleCount required DatapointValue
  • Sum required DatapointValue

Statistics

• Statistics array
  • items Statistic

StorageResolution

• StorageResolution integer

Threshold

• Threshold number

Timestamp

• Timestamp string

TreatMissingData

• TreatMissingData string