Client

cloudwatch

R Documentation

Amazon CloudWatch¶

Description¶

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the applications you run on Amazon Web Services 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 Amazon Web Services, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

Usage¶

cloudwatch(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

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

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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¶

svc <- cloudwatch(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  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
delete_metric_stream: Permanently deletes the metric stream that you specify
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 CloudWatch metric values
get_metric_statistics: Gets statistics for the specified metric
get_metric_stream: Returns information about the metric stream that you specify
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_managed_insight_rules: Returns a list that contains the number of managed Contributor Insights rules in your account
list_metrics: List the specified metrics
list_metric_streams: Returns a list of metric streams in this account
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_managed_insight_rules: Creates a managed Contributor Insights rule for a specified Amazon Web Services resource
put_metric_alarm: Creates or updates an alarm and associates it with the specified metric, metric math expression, anomaly detection model, or Metrics Insights query
put_metric_data: Publishes metric data points to Amazon CloudWatch
put_metric_stream: Creates or updates a metric stream
set_alarm_state: Temporarily sets the state of an alarm for testing purposes
start_metric_streams: Starts the streaming of metrics for one or more of your metric streams
stop_metric_streams: Stops the streaming of metrics for one or more of your metric streams
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¶

## Not run: 
svc <- cloudwatch()
svc$delete_alarms(
  Foo = 123
)

## End(Not run)