cloudwatch: Amazon CloudWatch

Description Usage Arguments Value Service syntax Operations Examples

View source: R/cloudwatch_service.R

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.

Usage

1
cloudwatch(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- cloudwatch(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

delete_alarms Deletes the specified alarms
delete_anomaly_detector Deletes the specified anomaly detection model from your account
delete_dashboards Deletes all dashboards that you specify
delete_insight_rules Permanently deletes the specified Contributor Insights rules
describe_alarm_history Retrieves the history for the specified alarm
describe_alarms Retrieves the specified alarms
describe_alarms_for_metric Retrieves the alarms for the specified metric
describe_anomaly_detectors Lists the anomaly detection models that you have created in your account
describe_insight_rules Returns a list of all the Contributor Insights rules in your account
disable_alarm_actions Disables the actions for the specified alarms
disable_insight_rules Disables the specified Contributor Insights rules
enable_alarm_actions Enables the actions for the specified alarms
enable_insight_rules Enables the specified Contributor Insights rules
get_dashboard Displays the details of the dashboard that you specify
get_insight_rule_report This operation returns the time series data collected by a Contributor Insights rule
get_metric_data You can use the GetMetricData API to retrieve as many as 500 different metrics in a single request, with a total of as many as 100,800 data points
get_metric_statistics Gets statistics for the specified metric
get_metric_widget_image You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image
list_dashboards Returns a list of the dashboards for your account
list_metrics List the specified metrics
list_tags_for_resource Displays the tags associated with a CloudWatch resource
put_anomaly_detector Creates an anomaly detection model for a CloudWatch metric
put_composite_alarm Creates or updates a composite alarm
put_dashboard Creates a dashboard if it does not already exist, or updates an existing dashboard
put_insight_rule Creates a Contributor Insights rule
put_metric_alarm Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model
put_metric_data Publishes metric data points to Amazon CloudWatch
set_alarm_state Temporarily sets the state of an alarm for testing purposes
tag_resource Assigns one or more tags (key-value pairs) to the specified CloudWatch resource
untag_resource Removes one or more tags from the specified resource

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- cloudwatch()
svc$delete_alarms(
  Foo = 123
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.