paws (version 0.4.0)

lookoutmetrics: Amazon Lookout for Metrics

Description

This is the Amazon Lookout for Metrics API Reference. For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics Developer Guide.

Usage

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

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.

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.

Service syntax

svc <- lookoutmetrics(
  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

activate_anomaly_detector	Activates an anomaly detector
back_test_anomaly_detector	Runs a backtest for anomaly detection for the specified resource
create_alert	Creates an alert for an anomaly detector
create_anomaly_detector	Creates an anomaly detector
create_metric_set	Creates a dataset
deactivate_anomaly_detector	Deactivates an anomaly detector
delete_alert	Deletes an alert
delete_anomaly_detector	Deletes a detector
describe_alert	Describes an alert
describe_anomaly_detection_executions	Returns information about the status of the specified anomaly detection jobs
describe_anomaly_detector	Describes a detector
describe_metric_set	Describes a dataset
detect_metric_set_config	Detects an Amazon S3 dataset's file format, interval, and offset
get_anomaly_group	Returns details about a group of anomalous metrics
get_data_quality_metrics	Returns details about the requested data quality metrics
get_feedback	Get feedback for an anomaly group
get_sample_data	Returns a selection of sample records from an Amazon S3 datasource
list_alerts	Lists the alerts attached to a detector
list_anomaly_detectors	Lists the detectors in the current AWS Region
list_anomaly_group_related_metrics	Returns a list of measures that are potential causes or effects of an anomaly group
list_anomaly_group_summaries	Returns a list of anomaly groups
list_anomaly_group_time_series	Gets a list of anomalous metrics for a measure in an anomaly group
list_metric_sets	Lists the datasets in the current AWS Region
list_tags_for_resource	Gets a list of tags for a detector, dataset, or alert
put_feedback	Add feedback for an anomalous metric
tag_resource	Adds tags to a detector, dataset, or alert
untag_resource	Removes tags from a detector, dataset, or alert
update_alert	Make changes to an existing alert
update_anomaly_detector	Updates a detector
update_metric_set	Updates a dataset

Examples

if (FALSE) {
svc <- lookoutmetrics()
svc$activate_anomaly_detector(
  Foo = 123
)
}