You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.DevOpsGuru

Inherits:
AWS.Service show all
Identifier:
devopsguru
API Version:
2020-12-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the AWS resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and AWS 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 AWS 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.

Sending a Request Using DevOpsGuru

var devopsguru = new AWS.DevOpsGuru();
devopsguru.addNotificationChannel(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DevOpsGuru object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var devopsguru = new AWS.DevOpsGuru({apiVersion: '2020-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the devopsguru service identifier:

AWS.config.apiVersions = {
  devopsguru: '2020-12-01',
  // other service API versions
};

var devopsguru = new AWS.DevOpsGuru();

Version:

  • 2020-12-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DevOpsGuru(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a DevOpsGuru object

var devopsguru = new AWS.DevOpsGuru({apiVersion: '2020-12-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.DevOpsGuru.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.DevOpsGuru.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.DevOpsGuru.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addNotificationChannel(params = {}, callback) ⇒ AWS.Request

Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.

Service Reference:

Examples:

Calling the addNotificationChannel operation

var params = {
  Config: { /* required */
    Sns: { /* required */
      TopicArn: 'STRING_VALUE'
    }
  }
};
devopsguru.addNotificationChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Config — (map)

      A NotificationChannelConfig object that specifies what type of notification channel to add. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

      • Sns — required — (map)

        Information about a notification channel configured in DevOps Guru to send notifications when insights are created.

        If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

        If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.

        • TopicArn — (String)

          The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Id — (String)

        The ID of the added notification channel.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAccountHealth(params = {}, callback) ⇒ AWS.Request

Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account. Use these numbers to gauge the health of operations in your AWS account.

Service Reference:

Examples:

Calling the describeAccountHealth operation

var params = {
};
devopsguru.describeAccountHealth(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OpenReactiveInsights — (Integer)

        An integer that specifies the number of open reactive insights in your AWS account.

      • OpenProactiveInsights — (Integer)

        An integer that specifies the number of open proactive insights in your AWS account.

      • MetricsAnalyzed — (Integer)

        An integer that specifies the number of metrics that have been analyzed in your AWS account.

      • ResourceHours — (Integer)

        The number of Amazon DevOps Guru resource analysis hours billed to the current AWS account in the last hour.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAccountOverview(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeAccountOverview operation

var params = {
  FromTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  ToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
devopsguru.describeAccountOverview(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • FromTime — (Date)

      The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day.

    • ToTime — (Date)

      The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReactiveInsights — (Integer)

        An integer that specifies the number of open reactive insights in your AWS account that were created during the time range passed in.

      • ProactiveInsights — (Integer)

        An integer that specifies the number of open proactive insights in your AWS account that were created during the time range passed in.

      • MeanTimeToRecoverInMilliseconds — (Integer)

        The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed in.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAnomaly(params = {}, callback) ⇒ AWS.Request

Returns details about an anomaly that you specify using its ID.

Service Reference:

Examples:

Calling the describeAnomaly operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
devopsguru.describeAnomaly(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The ID of the anomaly.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProactiveAnomaly — (map)

        A ReactiveAnomaly object that represents the requested anomaly.

        • Id — (String)

          The ID of a proactive anomaly.

        • Severity — (String)

          The severity of a proactive anomaly.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of a proactive anomaly.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • UpdateTime — (Date)

          The time of the anomaly's most recent update.

        • AnomalyTimeRange — (map)

          A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly.

          • StartTime — required — (Date)

            The time when the anomalous behavior started.

          • EndTime — (Date)

            The time when the anomalous behavior ended.

        • AnomalyReportedTimeRange — (map)

          A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

          • OpenTime — required — (Date)

            The time when an anomaly is opened.

          • CloseTime — (Date)

            The time when an anomaly is closed.

        • PredictionTimeRange — (map)

          The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

          • StartTime — required — (Date)

            The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.

          • EndTime — (Date)

            The time when the behavior in a proactive insight is expected to end.

        • SourceDetails — (map)

          Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

          • CloudWatchMetrics — (Array<map>)

            An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.

            • MetricName — (String)

              The name of the CloudWatch metric.

            • Namespace — (String)

              The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

            • Dimensions — (Array<map>)

              An array of CloudWatch dimensions associated with

              • Name — (String)

                The name of the CloudWatch dimension.

              • Value — (String)

                The value of the CloudWatch dimension.

            • Stat — (String)

              The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide.

              Possible values include:
              • "Sum"
              • "Average"
              • "SampleCount"
              • "Minimum"
              • "Maximum"
              • "p99"
              • "p90"
              • "p50"
            • Unit — (String)

              The unit of measure used for the CloudWatch metric. For example, Bytes, Seconds, Count, and Percent.

            • Period — (Integer)

              The length of time associated with the CloudWatch metric in number of seconds.

        • AssociatedInsightId — (String)

          The ID of the insight that contains this anomaly. An insight is composed of related anomalies.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

        • Limit — (Float)

          A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.

      • ReactiveAnomaly — (map)

        A ProactiveAnomaly object that represents the requested anomaly.

        • Id — (String)

          The ID of the reactive anomaly.

        • Severity — (String)

          The severity of the anomaly.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of the anomaly.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • AnomalyTimeRange — (map)

          A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly.

          • StartTime — required — (Date)

            The time when the anomalous behavior started.

          • EndTime — (Date)

            The time when the anomalous behavior ended.

        • AnomalyReportedTimeRange — (map)

          A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

          • OpenTime — required — (Date)

            The time when an anomaly is opened.

          • CloseTime — (Date)

            The time when an anomaly is closed.

        • SourceDetails — (map)

          Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

          • CloudWatchMetrics — (Array<map>)

            An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.

            • MetricName — (String)

              The name of the CloudWatch metric.

            • Namespace — (String)

              The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

            • Dimensions — (Array<map>)

              An array of CloudWatch dimensions associated with

              • Name — (String)

                The name of the CloudWatch dimension.

              • Value — (String)

                The value of the CloudWatch dimension.

            • Stat — (String)

              The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide.

              Possible values include:
              • "Sum"
              • "Average"
              • "SampleCount"
              • "Minimum"
              • "Maximum"
              • "p99"
              • "p90"
              • "p50"
            • Unit — (String)

              The unit of measure used for the CloudWatch metric. For example, Bytes, Seconds, Count, and Percent.

            • Period — (Integer)

              The length of time associated with the CloudWatch metric in number of seconds.

        • AssociatedInsightId — (String)

          The ID of the insight that contains this anomaly. An insight is composed of related anomalies.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeFeedback(params = {}, callback) ⇒ AWS.Request

Returns the most recent feedback submitted in the current AWS account and Region.

Service Reference:

Examples:

Calling the describeFeedback operation

var params = {
  InsightId: 'STRING_VALUE'
};
devopsguru.describeFeedback(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InsightId — (String)

      The ID of the insight for which the feedback was provided.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InsightFeedback — (map)

        Information about insight feedback received from a customer.

        • Id — (String)

          The insight feedback ID.

        • Feedback — (String)

          The feedback provided by the customer.

          Possible values include:
          • "VALID_COLLECTION"
          • "RECOMMENDATION_USEFUL"
          • "ALERT_TOO_SENSITIVE"
          • "DATA_NOISY_ANOMALY"
          • "DATA_INCORRECT"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInsight(params = {}, callback) ⇒ AWS.Request

Returns details about an insight that you specify using its ID.

Service Reference:

Examples:

Calling the describeInsight operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
devopsguru.describeInsight(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The ID of the insight.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProactiveInsight — (map)

        A ProactiveInsight object that represents the requested insight.

        • Id — (String)

          The ID of the proactive insight.

        • Name — (String)

          The name of the proactive insight.

        • Severity — (String)

          The severity of the proactive insight.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of the proactive insight.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • InsightTimeRange — (map)

          A time ranged that specifies when the observed behavior in an insight started and ended.

          • StartTime — required — (Date)

            The time when the behavior described in an insight started.

          • EndTime — (Date)

            The time when the behavior described in an insight ended.

        • PredictionTimeRange — (map)

          The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

          • StartTime — required — (Date)

            The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.

          • EndTime — (Date)

            The time when the behavior in a proactive insight is expected to end.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

        • SsmOpsItemId — (String)

          The ID of the AWS System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.

      • ReactiveInsight — (map)

        A ReactiveInsight object that represents the requested insight.

        • Id — (String)

          The ID of a reactive insight.

        • Name — (String)

          The name of a reactive insight.

        • Severity — (String)

          The severity of a reactive insight.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of a reactive insight.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • InsightTimeRange — (map)

          A time ranged that specifies when the observed behavior in an insight started and ended.

          • StartTime — required — (Date)

            The time when the behavior described in an insight started.

          • EndTime — (Date)

            The time when the behavior described in an insight ended.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

        • SsmOpsItemId — (String)

          The ID of the AWS System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeResourceCollectionHealth(params = {}, callback) ⇒ AWS.Request

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. You specify the type of AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

Service Reference:

Examples:

Calling the describeResourceCollectionHealth operation

var params = {
  ResourceCollectionType: AWS_CLOUD_FORMATION | AWS_SERVICE, /* required */
  NextToken: 'STRING_VALUE'
};
devopsguru.describeResourceCollectionHealth(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceCollectionType — (String)

      An AWS resource collection type. This type specifies how analyzed AWS resources are defined. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

      Possible values include:
      • "AWS_CLOUD_FORMATION"
      • "AWS_SERVICE"
    • NextToken — (String)

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CloudFormation — (Array<map>)

        The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.

        • StackName — (String)

          The name of the CloudFormation stack.

        • Insight — (map)

          Information about the health of the AWS resources in your account that are specified by an AWS CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

          • OpenProactiveInsights — (Integer)

            The number of open proactive insights.

          • OpenReactiveInsights — (Integer)

            The number of open reactive insights.

          • MeanTimeToRecoverInMilliseconds — (Integer)

            The Meant Time to Recover (MTTR) for the insight.

      • Service — (Array<map>)

        An array of ServiceHealth objects that describes the health of the AWS services associated with the resources in the collection.

        • ServiceName — (String)

          The name of the AWS service.

          Possible values include:
          • "API_GATEWAY"
          • "APPLICATION_ELB"
          • "AUTO_SCALING_GROUP"
          • "CLOUD_FRONT"
          • "DYNAMO_DB"
          • "EC2"
          • "ECS"
          • "EKS"
          • "ELASTIC_BEANSTALK"
          • "ELASTI_CACHE"
          • "ELB"
          • "ES"
          • "KINESIS"
          • "LAMBDA"
          • "NAT_GATEWAY"
          • "NETWORK_ELB"
          • "RDS"
          • "REDSHIFT"
          • "ROUTE_53"
          • "S3"
          • "SAGE_MAKER"
          • "SNS"
          • "SQS"
          • "STEP_FUNCTIONS"
          • "SWF"
        • Insight — (map)

          Represents the health of an AWS service. This is a ServiceInsightHealth that contains the number of open proactive and reactive insights for this service.

          • OpenProactiveInsights — (Integer)

            The number of open proactive insights in the AWS service

          • OpenReactiveInsights — (Integer)

            The number of open reactive insights in the AWS service

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeServiceIntegration(params = {}, callback) ⇒ AWS.Request

Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight.

Service Reference:

Examples:

Calling the describeServiceIntegration operation

var params = {
};
devopsguru.describeServiceIntegration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServiceIntegration — (map)

        Information about the integration of DevOps Guru with another AWS service, such as AWS Systems Manager.

        • OpsCenter — (map)

          Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.

          • OptInStatus — (String)

            Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.

            Possible values include:
            • "ENABLED"
            • "DISABLED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getCostEstimation(params = {}, callback) ⇒ AWS.Request

Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.

Service Reference:

Examples:

Calling the getCostEstimation operation

var params = {
  NextToken: 'STRING_VALUE'
};
devopsguru.getCostEstimation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceCollection — (map)

        The collection of the AWS resources used to create your monthly DevOps Guru cost estimate.

        • CloudFormation — (map)

          An object that specifies the CloudFormation stack that defines the AWS resources used to create a monthly estimate for DevOps Guru.

          • StackNames — (Array<String>)

            An array of CloudFormation stack names. Its size is fixed at 1 item.

      • Status — (String)

        The status of creating this cost estimate. If it's still in progress, the status ONGOING is returned. If it is finished, the status COMPLETED is returned.

        Possible values include:
        • "ONGOING"
        • "COMPLETED"
      • Costs — (Array<map>)

        An array of ResourceCost objects that each contains details about the monthly cost estimate to analyze one of your AWS resources.

        • Type — (String)

          The type of the AWS resource.

        • State — (String)

          The state of the resource. The resource is ACTIVE if it produces metrics, events, or logs within an hour, otherwise it is INACTIVE. You pay for the number of active AWS resource hours analyzed for each resource. Inactive resources are not charged.

          Possible values include:
          • "ACTIVE"
          • "INACTIVE"
        • Count — (Integer)

          The number of active resources analyzed for this service to create a monthly cost estimate.

        • UnitCost — (Float)

          The price per hour to analyze the resources in the service. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.

        • Cost — (Float)

          The total estimated monthly cost to analyze the active resources for this resource.

      • TimeRange — (map)

        The start and end time of the cost estimation.

        • StartTime — (Date)

          The start time of the cost estimation.

        • EndTime — (Date)

          The end time of the cost estimation.

      • TotalCost — (Float)

        The estimated monthly cost to analyze the AWS resources. This value is the sum of the estimated costs to analyze each resource in the Costs object in this response.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getResourceCollection(params = {}, callback) ⇒ AWS.Request

Returns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

Service Reference:

Examples:

Calling the getResourceCollection operation

var params = {
  ResourceCollectionType: AWS_CLOUD_FORMATION | AWS_SERVICE, /* required */
  NextToken: 'STRING_VALUE'
};
devopsguru.getResourceCollection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceCollectionType — (String)

      The type of AWS resource collections to return. The one valid value is CLOUD_FORMATION for AWS CloudFormation stacks.

      Possible values include:
      • "AWS_CLOUD_FORMATION"
      • "AWS_SERVICE"
    • NextToken — (String)

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceCollection — (map)

        The requested list of AWS resource collections. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

        • CloudFormation — (map)

          Information about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listAnomaliesForInsight(params = {}, callback) ⇒ AWS.Request

Returns a list of the anomalies that belong to an insight that you specify using its ID.

Service Reference:

Examples:

Calling the listAnomaliesForInsight operation

var params = {
  InsightId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartTimeRange: {
    FromTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    ToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  }
};
devopsguru.listAnomaliesForInsight(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InsightId — (String)

      The ID of the insight. The returned anomalies belong to this insight.

    • StartTimeRange — (map)

      A time range used to specify when the requested anomalies started. All returned anomalies started during this time range.

      • FromTime — (Date)

        The start time of the time range.

      • ToTime — (Date)

        The end time of the time range.

    • MaxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • NextToken — (String)

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProactiveAnomalies — (Array<map>)

        An array of ProactiveAnomalySummary objects that represent the requested anomalies

        • Id — (String)

          The ID of the anomaly.

        • Severity — (String)

          The severity of the anomaly.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of the anomaly.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • UpdateTime — (Date)

          The time of the anomaly's most recent update.

        • AnomalyTimeRange — (map)

          A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly.

          • StartTime — required — (Date)

            The time when the anomalous behavior started.

          • EndTime — (Date)

            The time when the anomalous behavior ended.

        • AnomalyReportedTimeRange — (map)

          A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

          • OpenTime — required — (Date)

            The time when an anomaly is opened.

          • CloseTime — (Date)

            The time when an anomaly is closed.

        • PredictionTimeRange — (map)

          The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

          • StartTime — required — (Date)

            The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.

          • EndTime — (Date)

            The time when the behavior in a proactive insight is expected to end.

        • SourceDetails — (map)

          Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

          • CloudWatchMetrics — (Array<map>)

            An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.

            • MetricName — (String)

              The name of the CloudWatch metric.

            • Namespace — (String)

              The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

            • Dimensions — (Array<map>)

              An array of CloudWatch dimensions associated with

              • Name — (String)

                The name of the CloudWatch dimension.

              • Value — (String)

                The value of the CloudWatch dimension.

            • Stat — (String)

              The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide.

              Possible values include:
              • "Sum"
              • "Average"
              • "SampleCount"
              • "Minimum"
              • "Maximum"
              • "p99"
              • "p90"
              • "p50"
            • Unit — (String)

              The unit of measure used for the CloudWatch metric. For example, Bytes, Seconds, Count, and Percent.

            • Period — (Integer)

              The length of time associated with the CloudWatch metric in number of seconds.

        • AssociatedInsightId — (String)

          The ID of the insight that contains this anomaly. An insight is composed of related anomalies.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

        • Limit — (Float)

          A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly.

      • ReactiveAnomalies — (Array<map>)

        An array of ReactiveAnomalySummary objects that represent the requested anomalies

        • Id — (String)

          The ID of the reactive anomaly.

        • Severity — (String)

          The severity of the reactive anomaly.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of the reactive anomaly.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • AnomalyTimeRange — (map)

          A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly.

          • StartTime — required — (Date)

            The time when the anomalous behavior started.

          • EndTime — (Date)

            The time when the anomalous behavior ended.

        • AnomalyReportedTimeRange — (map)

          A AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed.

          • OpenTime — required — (Date)

            The time when an anomaly is opened.

          • CloseTime — (Date)

            The time when an anomaly is closed.

        • SourceDetails — (map)

          Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics.

          • CloudWatchMetrics — (Array<map>)

            An array of CloudWatchMetricsDetail object that contains information about the analyzed metrics that displayed anomalous behavior.

            • MetricName — (String)

              The name of the CloudWatch metric.

            • Namespace — (String)

              The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

            • Dimensions — (Array<map>)

              An array of CloudWatch dimensions associated with

              • Name — (String)

                The name of the CloudWatch dimension.

              • Value — (String)

                The value of the CloudWatch dimension.

            • Stat — (String)

              The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide.

              Possible values include:
              • "Sum"
              • "Average"
              • "SampleCount"
              • "Minimum"
              • "Maximum"
              • "p99"
              • "p90"
              • "p50"
            • Unit — (String)

              The unit of measure used for the CloudWatch metric. For example, Bytes, Seconds, Count, and Percent.

            • Period — (Integer)

              The length of time associated with the CloudWatch metric in number of seconds.

        • AssociatedInsightId — (String)

          The ID of the insight that contains this anomaly. An insight is composed of related anomalies.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listEvents(params = {}, callback) ⇒ AWS.Request

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.

Service Reference:

Examples:

Calling the listEvents operation

var params = {
  Filters: { /* required */
    DataSource: AWS_CLOUD_TRAIL | AWS_CODE_DEPLOY,
    EventClass: INFRASTRUCTURE | DEPLOYMENT | SECURITY_CHANGE | CONFIG_CHANGE | SCHEMA_CHANGE,
    EventSource: 'STRING_VALUE',
    EventTimeRange: {
      FromTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      ToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
    },
    InsightId: 'STRING_VALUE',
    ResourceCollection: {
      CloudFormation: {
        StackNames: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
devopsguru.listEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Filters — (map)

      A ListEventsFilters object used to specify which events to return.

      • InsightId — (String)

        An ID of an insight that is related to the events you want to filter for.

      • EventTimeRange — (map)

        A time range during which you want the filtered events to have occurred.

        • FromTime — required — (Date)

          The time when the event started.

        • ToTime — required — (Date)

          The time when the event ended.

      • EventClass — (String)

        The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change.

        Possible values include:
        • "INFRASTRUCTURE"
        • "DEPLOYMENT"
        • "SECURITY_CHANGE"
        • "CONFIG_CHANGE"
        • "SCHEMA_CHANGE"
      • EventSource — (String)

        The AWS source that emitted the events you want to filter for.

      • DataSource — (String)

        The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned.

        Possible values include:
        • "AWS_CLOUD_TRAIL"
        • "AWS_CODE_DEPLOY"
      • ResourceCollection — (map)

        A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

        • CloudFormation — (map)

          An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

    • MaxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • NextToken — (String)

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Events — (Array<map>)

        A list of the requested events.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

        • Id — (String)

          The ID of the event.

        • Time — (Date)

          A Timestamp that specifies the time the event occurred.

        • EventSource — (String)

          The AWS source that emitted the event.

        • Name — (String)

          The name of the event.

        • DataSource — (String)

          The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found the event.

          Possible values include:
          • "AWS_CLOUD_TRAIL"
          • "AWS_CODE_DEPLOY"
        • EventClass — (String)

          The class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change.

          Possible values include:
          • "INFRASTRUCTURE"
          • "DEPLOYMENT"
          • "SECURITY_CHANGE"
          • "CONFIG_CHANGE"
          • "SCHEMA_CHANGE"
        • Resources — (Array<map>)

          An EventResource object that contains information about the resource that emitted the event.

          • Type — (String)

            The type of resource that emitted an event.

          • Name — (String)

            The name of the resource that emitted an event.

          • Arn — (String)

            The Amazon Resource Name (ARN) of the resource that emitted an event.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listInsights(params = {}, callback) ⇒ AWS.Request

Returns a list of insights in your AWS account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY).

Service Reference:

Examples:

Calling the listInsights operation

var params = {
  StatusFilter: { /* required */
    Any: {
      StartTimeRange: { /* required */
        FromTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        ToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      Type: REACTIVE | PROACTIVE /* required */
    },
    Closed: {
      EndTimeRange: { /* required */
        FromTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        ToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      Type: REACTIVE | PROACTIVE /* required */
    },
    Ongoing: {
      Type: REACTIVE | PROACTIVE /* required */
    }
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
devopsguru.listInsights(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • StatusFilter — (map)

      A filter used to filter the returned insights by their status. You can specify one status filter.

      • Ongoing — (map)

        A ListInsightsAnyStatusFilter that specifies ongoing insights that are either REACTIVE or PROACTIVE.

        • Type — required — (String)

          Use to filter for either REACTIVE or PROACTIVE insights.

          Possible values include:
          • "REACTIVE"
          • "PROACTIVE"
      • Closed — (map)

        A ListInsightsClosedStatusFilter that specifies closed insights that are either REACTIVE or PROACTIVE.

        • Type — required — (String)

          Use to filter for either REACTIVE or PROACTIVE insights.

          Possible values include:
          • "REACTIVE"
          • "PROACTIVE"
        • EndTimeRange — required — (map)

          A time range used to specify when the behavior of the filtered insights ended.

          • FromTime — (Date)

            The earliest end time in the time range.

          • ToTime — (Date)

            The latest end time in the time range.

      • Any — (map)

        A ListInsightsAnyStatusFilter that specifies insights of any status that are either REACTIVE or PROACTIVE.

        • Type — required — (String)

          Use to filter for either REACTIVE or PROACTIVE insights.

          Possible values include:
          • "REACTIVE"
          • "PROACTIVE"
        • StartTimeRange — required — (map)

          A time range used to specify when the behavior of the filtered insights started.

          • FromTime — (Date)

            The start time of the time range.

          • ToTime — (Date)

            The end time of the time range.

    • MaxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • NextToken — (String)

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProactiveInsights — (Array<map>)

        The returned list of proactive insights.

        • Id — (String)

          The ID of the proactive insight.

        • Name — (String)

          The name of the proactive insight.

        • Severity — (String)

          The severity of the proactive insight.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of the proactive insight.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • InsightTimeRange — (map)

          A time ranged that specifies when the observed behavior in an insight started and ended.

          • StartTime — required — (Date)

            The time when the behavior described in an insight started.

          • EndTime — (Date)

            The time when the behavior described in an insight ended.

        • PredictionTimeRange — (map)

          The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

          • StartTime — required — (Date)

            The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.

          • EndTime — (Date)

            The time when the behavior in a proactive insight is expected to end.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

        • ServiceCollection — (map)

          A collection of the names of AWS services.

          • ServiceNames — (Array<String>)

            An array of strings that each specifies the name of an AWS service.

      • ReactiveInsights — (Array<map>)

        The returned list of reactive insights.

        • Id — (String)

          The ID of a reactive summary.

        • Name — (String)

          The name of a reactive insight.

        • Severity — (String)

          The severity of a reactive insight.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of a reactive insight.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • InsightTimeRange — (map)

          A time ranged that specifies when the observed behavior in an insight started and ended.

          • StartTime — required — (Date)

            The time when the behavior described in an insight started.

          • EndTime — (Date)

            The time when the behavior described in an insight ended.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

        • ServiceCollection — (map)

          A collection of the names of AWS services.

          • ServiceNames — (Array<String>)

            An array of strings that each specifies the name of an AWS service.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listNotificationChannels(params = {}, callback) ⇒ AWS.Request

Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).

Service Reference:

Examples:

Calling the listNotificationChannels operation

var params = {
  NextToken: 'STRING_VALUE'
};
devopsguru.listNotificationChannels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Channels — (Array<map>)

        An array that contains the requested notification channels.

        • Id — (String)

          The ID of a notification channel.

        • Config — (map)

          A NotificationChannelConfig object that contains information about configured notification channels.

          • Sns — required — (map)

            Information about a notification channel configured in DevOps Guru to send notifications when insights are created.

            If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account Amazon SNS topics.

            If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for AWS KMS–encrypted Amazon SNS topics.

            • TopicArn — (String)

              The Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listRecommendations(params = {}, callback) ⇒ AWS.Request

Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.

Service Reference:

Examples:

Calling the listRecommendations operation

var params = {
  InsightId: 'STRING_VALUE', /* required */
  Locale: DE_DE | EN_US | EN_GB | ES_ES | FR_FR | IT_IT | JA_JP | KO_KR | PT_BR | ZH_CN | ZH_TW,
  NextToken: 'STRING_VALUE'
};
devopsguru.listRecommendations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InsightId — (String)

      The ID of the requested insight.

    • NextToken — (String)

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    • Locale — (String)

      A locale that specifies the language to use for recommendations.

      Possible values include:
      • "DE_DE"
      • "EN_US"
      • "EN_GB"
      • "ES_ES"
      • "FR_FR"
      • "IT_IT"
      • "JA_JP"
      • "KO_KR"
      • "PT_BR"
      • "ZH_CN"
      • "ZH_TW"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Recommendations — (Array<map>)

        An array of the requested recommendations.

        • Description — (String)

          A description of the problem.

        • Link — (String)

          A hyperlink to information to help you address the problem.

        • Name — (String)

          The name of the recommendation.

        • Reason — (String)

          The reason DevOps Guru flagged the anomalous behavior as a problem.

        • RelatedEvents — (Array<map>)

          Events that are related to the problem. Use these events to learn more about what's happening and to help address the issue.

          • Name — (String)

            The name of the event. This corresponds to the Name field in an Event object.

          • Resources — (Array<map>)

            A ResourceCollection object that contains arrays of the names of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.

            • Name — (String)

              The name of the resource that emitted the event. This corresponds to the Name field in an EventResource object.

            • Type — (String)

              The type of the resource that emitted the event. This corresponds to the Type field in an EventResource object.

        • RelatedAnomalies — (Array<map>)

          Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue.

          • Resources — (Array<map>)

            An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name and type of the resource.

            • Name — (String)

              The name of the resource.

            • Type — (String)

              The type of the resource.

          • SourceDetails — (Array<map>)

            Information about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics.

            • CloudWatchMetrics — (Array<map>)

              An array of CloudWatchMetricsDetail objects that contains information about the analyzed metrics that displayed anomalous behavior.

              • MetricName — (String)

                The name of the CloudWatch metric.

              • Namespace — (String)

                The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putFeedback(params = {}, callback) ⇒ AWS.Request

Collects customer feedback about the specified insight.

Service Reference:

Examples:

Calling the putFeedback operation

var params = {
  InsightFeedback: {
    Feedback: VALID_COLLECTION | RECOMMENDATION_USEFUL | ALERT_TOO_SENSITIVE | DATA_NOISY_ANOMALY | DATA_INCORRECT,
    Id: 'STRING_VALUE'
  }
};
devopsguru.putFeedback(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InsightFeedback — (map)

      The feedback from customers is about the recommendations in this insight.

      • Id — (String)

        The insight feedback ID.

      • Feedback — (String)

        The feedback provided by the customer.

        Possible values include:
        • "VALID_COLLECTION"
        • "RECOMMENDATION_USEFUL"
        • "ALERT_TOO_SENSITIVE"
        • "DATA_NOISY_ANOMALY"
        • "DATA_INCORRECT"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

removeNotificationChannel(params = {}, callback) ⇒ AWS.Request

Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations.

Service Reference:

Examples:

Calling the removeNotificationChannel operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
devopsguru.removeNotificationChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Id — (String)

      The ID of the notification channel to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

searchInsights(params = {}, callback) ⇒ AWS.Request

Returns a list of insights in your AWS account. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE).

Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.

Service Reference:

Examples:

Calling the searchInsights operation

var params = {
  StartTimeRange: { /* required */
    FromTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    ToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  Type: REACTIVE | PROACTIVE, /* required */
  Filters: {
    ResourceCollection: {
      CloudFormation: {
        StackNames: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    },
    ServiceCollection: {
      ServiceNames: [
        API_GATEWAY | APPLICATION_ELB | AUTO_SCALING_GROUP | CLOUD_FRONT | DYNAMO_DB | EC2 | ECS | EKS | ELASTIC_BEANSTALK | ELASTI_CACHE | ELB | ES | KINESIS | LAMBDA | NAT_GATEWAY | NETWORK_ELB | RDS | REDSHIFT | ROUTE_53 | S3 | SAGE_MAKER | SNS | SQS | STEP_FUNCTIONS | SWF,
        /* more items */
      ]
    },
    Severities: [
      LOW | MEDIUM | HIGH,
      /* more items */
    ],
    Statuses: [
      ONGOING | CLOSED,
      /* more items */
    ]
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
devopsguru.searchInsights(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • StartTimeRange — (map)

      The start of the time range passed in. Returned insights occurred after this time.

      • FromTime — (Date)

        The start time of the time range.

      • ToTime — (Date)

        The end time of the time range.

    • Filters — (map)

      A SearchInsightsFilters object that is used to set the severity and status filters on your insight search.

      • Severities — (Array<String>)

        An array of severity values used to search for insights.

      • Statuses — (Array<String>)

        An array of status values used to search for insights.

      • ResourceCollection — (map)

        A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

        • CloudFormation — (map)

          An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

      • ServiceCollection — (map)

        A collection of the names of AWS services.

        • ServiceNames — (Array<String>)

          An array of strings that each specifies the name of an AWS service.

    • MaxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • NextToken — (String)

      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    • Type — (String)

      The type of insights you are searching for (REACTIVE or PROACTIVE).

      Possible values include:
      • "REACTIVE"
      • "PROACTIVE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProactiveInsights — (Array<map>)

        The returned proactive insights.

        • Id — (String)

          The ID of the proactive insight.

        • Name — (String)

          The name of the proactive insight.

        • Severity — (String)

          The severity of the proactive insight.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of the proactive insight.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • InsightTimeRange — (map)

          A time ranged that specifies when the observed behavior in an insight started and ended.

          • StartTime — required — (Date)

            The time when the behavior described in an insight started.

          • EndTime — (Date)

            The time when the behavior described in an insight ended.

        • PredictionTimeRange — (map)

          The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.

          • StartTime — required — (Date)

            The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.

          • EndTime — (Date)

            The time when the behavior in a proactive insight is expected to end.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

        • ServiceCollection — (map)

          A collection of the names of AWS services.

          • ServiceNames — (Array<String>)

            An array of strings that each specifies the name of an AWS service.

      • ReactiveInsights — (Array<map>)

        The returned reactive insights.

        • Id — (String)

          The ID of a reactive summary.

        • Name — (String)

          The name of a reactive insight.

        • Severity — (String)

          The severity of a reactive insight.

          Possible values include:
          • "LOW"
          • "MEDIUM"
          • "HIGH"
        • Status — (String)

          The status of a reactive insight.

          Possible values include:
          • "ONGOING"
          • "CLOSED"
        • InsightTimeRange — (map)

          A time ranged that specifies when the observed behavior in an insight started and ended.

          • StartTime — required — (Date)

            The time when the behavior described in an insight started.

          • EndTime — (Date)

            The time when the behavior described in an insight ended.

        • ResourceCollection — (map)

          A collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

          • CloudFormation — (map)

            An array of the names of AWS CloudFormation stacks. The stacks define AWS resources that DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.

            • StackNames — (Array<String>)

              An array of CloudFormation stack names.

        • ServiceCollection — (map)

          A collection of the names of AWS services.

          • ServiceNames — (Array<String>)

            An array of strings that each specifies the name of an AWS service.

      • NextToken — (String)

        The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startCostEstimation(params = {}, callback) ⇒ AWS.Request

Starts the creation of an estimate of the monthly cost to analyze your AWS resources.

Service Reference:

Examples:

Calling the startCostEstimation operation

var params = {
  ResourceCollection: { /* required */
    CloudFormation: {
      StackNames: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  ClientToken: 'STRING_VALUE'
};
devopsguru.startCostEstimation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceCollection — (map)

      The collection of AWS resources used to create a monthly DevOps Guru cost estimate.

      • CloudFormation — (map)

        An object that specifies the CloudFormation stack that defines the AWS resources used to create a monthly estimate for DevOps Guru.

        • StackNames — (Array<String>)

          An array of CloudFormation stack names. Its size is fixed at 1 item.

    • ClientToken — (String)

      The idempotency token used to identify each cost estimate request.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateResourceCollection(params = {}, callback) ⇒ AWS.Request

Updates the collection of resources that DevOps Guru analyzes. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru.

Service Reference:

Examples:

Calling the updateResourceCollection operation

var params = {
  Action: ADD | REMOVE, /* required */
  ResourceCollection: { /* required */
    CloudFormation: {
      StackNames: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  }
};
devopsguru.updateResourceCollection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Action — (String)

      Specifies if the resource collection in the request is added or deleted to the resource collection.

      Possible values include:
      • "ADD"
      • "REMOVE"
    • ResourceCollection — (map)

      Contains information used to update a collection of AWS resources.

      • CloudFormation — (map)

        An collection of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.

        • StackNames — (Array<String>)

          An array of the names of the AWS CloudFormation stacks to update. You can specify up to 500 AWS CloudFormation stacks.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateServiceIntegration(params = {}, callback) ⇒ AWS.Request

Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight.

Service Reference:

Examples:

Calling the updateServiceIntegration operation

var params = {
  ServiceIntegration: { /* required */
    OpsCenter: {
      OptInStatus: ENABLED | DISABLED
    }
  }
};
devopsguru.updateServiceIntegration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceIntegration — (map)

      An IntegratedServiceConfig object used to specify the integrated service you want to update, and whether you want to update it to enabled or disabled.

      • OpsCenter — (map)

        Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.

        • OptInStatus — (String)

          Specifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.

          Possible values include:
          • "ENABLED"
          • "DISABLED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.