Client

devopsguru

R Documentation

Amazon DevOps Guru¶

Description¶

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the Amazon Web Services resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an insight that includes recommendations, related events, and related metrics that can help you improve your operational applications. For more information, see What is Amazon DevOps Guru.

You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight is created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each insight to help you manage and track your work addressing insights.

To learn about the DevOps Guru workflow, see How DevOps Guru works. To learn about DevOps Guru concepts, see Concepts in DevOps Guru.

Usage¶

devopsguru(
  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 <- devopsguru(
  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¶

add_notification_channel: Adds a notification channel to DevOps Guru
delete_insight: Deletes the insight along with the associated anomalies, events and recommendations
describe_account_health: Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account
describe_account_overview: For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights
describe_anomaly: Returns details about an anomaly that you specify using its ID
describe_event_sources_config: Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge
describe_feedback: Returns the most recent feedback submitted in the current Amazon Web Services account and Region
describe_insight: Returns details about an insight that you specify using its ID
describe_organization_health: Returns active insights, predictive insights, and resource hours analyzed in last hour
describe_organization_overview: Returns an overview of your organization's history based on the specified time range; Provides an overview of your system's health
describe_resource_collection_health: Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account
describe_service_integration: Returns the integration status of services that are integrated with DevOps Guru
get_cost_estimation: Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources
get_resource_collection: Returns lists Amazon Web Services resources that are of the specified resource collection type
list_anomalies_for_insight: Returns a list of the anomalies that belong to an insight that you specify using its ID
list_anomalous_log_groups: Returns the list of log groups that contain log anomalies
list_events: Returns a list of the events emitted by the resources that are evaluated by DevOps Guru
list_insights: Returns a list of insights in your Amazon Web Services account
list_monitored_resources: Returns the list of all log groups that are being monitored and tagged by DevOps Guru
list_notification_channels: Returns a list of notification channels configured for DevOps Guru
list_organization_insights: Returns a list of insights associated with the account or OU Id
list_recommendations: Returns a list of a specified insight's recommendations
put_feedback: Collects customer feedback about the specified insight
remove_notification_channel: Removes a notification channel from DevOps Guru
search_insights: Returns a list of insights in your Amazon Web Services account
search_organization_insights: Returns a list of insights in your organization
start_cost_estimation: Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources
update_event_sources_config: Enables or disables integration with a service that can be integrated with DevOps Guru
update_resource_collection: Updates the collection of resources that DevOps Guru analyzes
update_service_integration: Enables or disables integration with a service that can be integrated with DevOps Guru

Examples¶

## Not run: 
svc <- devopsguru()
svc$add_notification_channel(
  Foo = 123
)

## End(Not run)