Class: AWS.DevOpsGuru

var params = {
  Id: 'STRING_VALUE' /* required */
};
devopsguru.deleteInsight(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.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services account.

    • OpenProactiveInsights — (Integer)

      An integer that specifies the number of open proactive insights in your Amazon Web Services account.

    • MetricsAnalyzed — (Integer)

      An integer that specifies the number of metrics that have been analyzed in your Amazon Web Services account.

    • ResourceHours — (Integer)

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

    • AnalyzedResourceCount — (Integer)

      Number of resources that DevOps Guru is monitoring in your Amazon Web Services account.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services account that were created during the time range passed in.

    • ProactiveInsights — (Integer)

      An integer that specifies the number of open proactive insights in your Amazon Web Services 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.

var params = {
  Id: 'STRING_VALUE', /* required */
  AccountId: 'STRING_VALUE'
};
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.

  • AccountId — (String)

    The ID of the member account.

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 ProactiveAnomaly object that represents the requested anomaly.

      • Id — (String)

        The ID of a proactive anomaly.

      • Severity — (String)

        The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

        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)

        An 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 objects that contain information about analyzed CloudWatch metrics that show 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.

          • MetricDataSummary — (map)

            This object returns anomaly metric data.

            • TimestampMetricValuePairList — (Array<map>)

              This is a list of Amazon CloudWatch metric values at given timestamp.

              • Timestamp — (Date)

                A Timestamp that specifies the time the event occurred.

              • MetricValue — (Float)

                Value of the anomalous metric data point at respective Timestamp.

            • StatusCode — (String)

              This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.

              Possible values include:
              • "Complete"
              • "InternalError"
              • "PartialData"
        • PerformanceInsightsMetrics — (Array<map>)

          An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.

          • MetricDisplayName — (String)

            The name used for a specific Performance Insights metric.

          • Unit — (String)

            The unit of measure for a metric. For example, a session or a process.

          • MetricQuery — (map)

            A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .

            • Metric — (String)

              The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

              Valid values for Metric are:

              • db.load.avg - a scaled representation of the number of active sessions for the database engine.

              • db.sampledload.avg - the raw number of active sessions for the database engine.

              If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

            • GroupBy — (map)

              The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

              • Group — (String)

                The name of the dimension group. Its valid values are:

                • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.host - The host name of the connected client (all engines)

                • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.sql - The SQL that is currently executing (all engines)

                • db.sql_tokenized - The SQL digest (all engines)

                • db.wait_event - The event for which the database backend is waiting (all engines)

                • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

                • db.user - The user logged in to the database (all engines)

              • Dimensions — (Array<String>)

                A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

                Valid values for elements in the Dimensions array are:

                • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.host.id - The host ID of the connected client (all engines)

                • db.host.name - The host name of the connected client (all engines)

                • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.sql.id - The SQL ID generated by Performance Insights (all engines)

                • db.sql.db_id - The SQL ID generated by the database (all engines)

                • db.sql.statement - The SQL text that is being executed (all engines)

                • db.sql.tokenized_id

                • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

                • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

                • db.sql_tokenized.statement - The SQL digest text (all engines)

                • db.user.id - The ID of the user logged in to the database (all engines)

                • db.user.name - The name of the user logged in to the database (all engines)

                • db.wait_event.name - The event for which the backend is waiting (all engines)

                • db.wait_event.type - The type of event for which the backend is waiting (all engines)

                • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

              • Limit — (Integer)

                The maximum number of items to fetch for this dimension group.

            • Filter — (map<String>)

              One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

              • Any number of filters by the same dimension, as specified in the GroupBy parameter.

              • A single filter for any other dimension in this dimension group.

          • ReferenceData — (Array<map>)

            For more information, see PerformanceInsightsReferenceData .

            • Name — (String)

              The name of the reference data.

            • ComparisonValues — (map)

              The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .

              • ReferenceScalar — (map)

                A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used to determine if an actual metric value should be considered anomalous.

                • Value — (Float)

                  The reference value.

              • ReferenceMetric — (map)

                A metric that DevOps Guru compares to actual metric values. This reference metric is used to determine if an actual metric should be considered anomalous.

                • MetricQuery — (map)

                  A query to be processed on the metric.

                  • Metric — (String)

                    The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

                    Valid values for Metric are:

                    • db.load.avg - a scaled representation of the number of active sessions for the database engine.

                    • db.sampledload.avg - the raw number of active sessions for the database engine.

                    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

                  • GroupBy — (map)

                    The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

                    • Group — (String)

                      The name of the dimension group. Its valid values are:

                      • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                      • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.host - The host name of the connected client (all engines)

                      • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.sql - The SQL that is currently executing (all engines)

                      • db.sql_tokenized - The SQL digest (all engines)

                      • db.wait_event - The event for which the database backend is waiting (all engines)

                      • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

                      • db.user - The user logged in to the database (all engines)

                    • Dimensions — (Array<String>)

                      A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

                      Valid values for elements in the Dimensions array are:

                      • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.host.id - The host ID of the connected client (all engines)

                      • db.host.name - The host name of the connected client (all engines)

                      • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                      • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.sql.id - The SQL ID generated by Performance Insights (all engines)

                      • db.sql.db_id - The SQL ID generated by the database (all engines)

                      • db.sql.statement - The SQL text that is being executed (all engines)

                      • db.sql.tokenized_id

                      • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

                      • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

                      • db.sql_tokenized.statement - The SQL digest text (all engines)

                      • db.user.id - The ID of the user logged in to the database (all engines)

                      • db.user.name - The name of the user logged in to the database (all engines)

                      • db.wait_event.name - The event for which the backend is waiting (all engines)

                      • db.wait_event.type - The type of event for which the backend is waiting (all engines)

                      • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

                    • Limit — (Integer)

                      The maximum number of items to fetch for this dimension group.

                  • Filter — (map<String>)

                    One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

                    • Any number of filters by the same dimension, as specified in the GroupBy parameter.

                    • A single filter for any other dimension in this dimension group.

          • StatsAtAnomaly — (Array<map>)

            The metric statistics during the anomalous period detected by DevOps Guru;

            • Type — (String)

              The statistic type.

            • Value — (Float)

              The value of the statistic.

          • StatsAtBaseline — (Array<map>)

            Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.

            • Type — (String)

              The statistic type.

            • Value — (Float)

              The value of the statistic.

      • AssociatedInsightId — (String)

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

      • ResourceCollection — (map)

        A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • 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.

      • SourceMetadata — (map)

        The metadata for the anomaly.

        • Source — (String)

          The source of the anomaly.

        • SourceResourceName — (String)

          The name of the anomaly's resource.

        • SourceResourceType — (String)

          The anomaly's resource type.

      • AnomalyResources — (Array<map>)

        Information about a resource in which DevOps Guru detected anomalous behavior.

        • Name — (String)

          The name of the Amazon Web Services resource.

        • Type — (String)

          The type of the Amazon Web Services resource.

      • Description — (String)

        A description of the proactive anomaly.

    • ReactiveAnomaly — (map)

      A ReactiveAnomaly object that represents the requested anomaly.

      • Id — (String)

        The ID of the reactive anomaly.

      • Severity — (String)

        The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

        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)

        An 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 objects that contain information about analyzed CloudWatch metrics that show 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.

          • MetricDataSummary — (map)

            This object returns anomaly metric data.

            • TimestampMetricValuePairList — (Array<map>)

              This is a list of Amazon CloudWatch metric values at given timestamp.

              • Timestamp — (Date)

                A Timestamp that specifies the time the event occurred.

              • MetricValue — (Float)

                Value of the anomalous metric data point at respective Timestamp.

            • StatusCode — (String)

              This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.

              Possible values include:
              • "Complete"
              • "InternalError"
              • "PartialData"
        • PerformanceInsightsMetrics — (Array<map>)

          An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.

          • MetricDisplayName — (String)

            The name used for a specific Performance Insights metric.

          • Unit — (String)

            The unit of measure for a metric. For example, a session or a process.

          • MetricQuery — (map)

            A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .

            • Metric — (String)

              The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

              Valid values for Metric are:

              • db.load.avg - a scaled representation of the number of active sessions for the database engine.

              • db.sampledload.avg - the raw number of active sessions for the database engine.

              If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

            • GroupBy — (map)

              The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

              • Group — (String)

                The name of the dimension group. Its valid values are:

                • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.host - The host name of the connected client (all engines)

                • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.sql - The SQL that is currently executing (all engines)

                • db.sql_tokenized - The SQL digest (all engines)

                • db.wait_event - The event for which the database backend is waiting (all engines)

                • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

                • db.user - The user logged in to the database (all engines)

              • Dimensions — (Array<String>)

                A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

                Valid values for elements in the Dimensions array are:

                • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.host.id - The host ID of the connected client (all engines)

                • db.host.name - The host name of the connected client (all engines)

                • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.sql.id - The SQL ID generated by Performance Insights (all engines)

                • db.sql.db_id - The SQL ID generated by the database (all engines)

                • db.sql.statement - The SQL text that is being executed (all engines)

                • db.sql.tokenized_id

                • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

                • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

                • db.sql_tokenized.statement - The SQL digest text (all engines)

                • db.user.id - The ID of the user logged in to the database (all engines)

                • db.user.name - The name of the user logged in to the database (all engines)

                • db.wait_event.name - The event for which the backend is waiting (all engines)

                • db.wait_event.type - The type of event for which the backend is waiting (all engines)

                • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

              • Limit — (Integer)

                The maximum number of items to fetch for this dimension group.

            • Filter — (map<String>)

              One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

              • Any number of filters by the same dimension, as specified in the GroupBy parameter.

              • A single filter for any other dimension in this dimension group.

          • ReferenceData — (Array<map>)

            For more information, see PerformanceInsightsReferenceData .

            • Name — (String)

              The name of the reference data.

            • ComparisonValues — (map)

              The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .

              • ReferenceScalar — (map)

                A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used to determine if an actual metric value should be considered anomalous.

                • Value — (Float)

                  The reference value.

              • ReferenceMetric — (map)

                A metric that DevOps Guru compares to actual metric values. This reference metric is used to determine if an actual metric should be considered anomalous.

                • MetricQuery — (map)

                  A query to be processed on the metric.

                  • Metric — (String)

                    The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

                    Valid values for Metric are:

                    • db.load.avg - a scaled representation of the number of active sessions for the database engine.

                    • db.sampledload.avg - the raw number of active sessions for the database engine.

                    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

                  • GroupBy — (map)

                    The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

                    • Group — (String)

                      The name of the dimension group. Its valid values are:

                      • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                      • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.host - The host name of the connected client (all engines)

                      • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.sql - The SQL that is currently executing (all engines)

                      • db.sql_tokenized - The SQL digest (all engines)

                      • db.wait_event - The event for which the database backend is waiting (all engines)

                      • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

                      • db.user - The user logged in to the database (all engines)

                    • Dimensions — (Array<String>)

                      A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

                      Valid values for elements in the Dimensions array are:

                      • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.host.id - The host ID of the connected client (all engines)

                      • db.host.name - The host name of the connected client (all engines)

                      • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                      • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.sql.id - The SQL ID generated by Performance Insights (all engines)

                      • db.sql.db_id - The SQL ID generated by the database (all engines)

                      • db.sql.statement - The SQL text that is being executed (all engines)

                      • db.sql.tokenized_id

                      • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

                      • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

                      • db.sql_tokenized.statement - The SQL digest text (all engines)

                      • db.user.id - The ID of the user logged in to the database (all engines)

                      • db.user.name - The name of the user logged in to the database (all engines)

                      • db.wait_event.name - The event for which the backend is waiting (all engines)

                      • db.wait_event.type - The type of event for which the backend is waiting (all engines)

                      • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

                    • Limit — (Integer)

                      The maximum number of items to fetch for this dimension group.

                  • Filter — (map<String>)

                    One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

                    • Any number of filters by the same dimension, as specified in the GroupBy parameter.

                    • A single filter for any other dimension in this dimension group.

          • StatsAtAnomaly — (Array<map>)

            The metric statistics during the anomalous period detected by DevOps Guru;

            • Type — (String)

              The statistic type.

            • Value — (Float)

              The value of the statistic.

          • StatsAtBaseline — (Array<map>)

            Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.

            • Type — (String)

              The statistic type.

            • Value — (Float)

              The value of the statistic.

      • AssociatedInsightId — (String)

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

      • ResourceCollection — (map)

        A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • Type — (String)

        The type of the reactive anomaly. It can be one of the following types.

        • CAUSAL - the anomaly can cause a new insight.

        • CONTEXTUAL - the anomaly contains additional information about an insight or its causal anomaly.

        Possible values include:
        • "CAUSAL"
        • "CONTEXTUAL"
      • Name — (String)

        The name of the reactive anomaly.

      • Description — (String)

        A description of the reactive anomaly.

      • CausalAnomalyId — (String)

        The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a CAUSAL anomaly is always NULL.

      • AnomalyResources — (Array<map>)

        The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.

        • Name — (String)

          The name of the Amazon Web Services resource.

        • Type — (String)

          The type of the Amazon Web Services resource.

Returns:

• (AWS.Request) —

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

var params = {
};
devopsguru.describeEventSourcesConfig(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:

    • EventSources — (map)

      Lists the event sources in the configuration.

      • AmazonCodeGuruProfiler — (map)

        Information about whether DevOps Guru is configured to consume recommendations which are generated from AWS CodeGuru Profiler.

        • Status — (String)

          The status of the CodeGuru Profiler integration. Specifies if DevOps Guru is enabled to consume recommendations that are generated from Amazon CodeGuru Profiler.

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

Returns:

• (AWS.Request) —

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

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.

var params = {
  Id: 'STRING_VALUE', /* required */
  AccountId: 'STRING_VALUE'
};
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.

  • AccountId — (String)

    The ID of the member account in the organization.

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 insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

        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 Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • SsmOpsItemId — (String)

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

      • Description — (String)

        Describes the proactive 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 the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

        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 Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • SsmOpsItemId — (String)

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

      • Description — (String)

        Describes the reactive insight.

Returns:

• (AWS.Request) —

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

var params = {
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  OrganizationalUnitIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
devopsguru.describeOrganizationHealth(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: {}) —
  • AccountIds — (Array<String>)

    The ID of the Amazon Web Services account.

  • OrganizationalUnitIds — (Array<String>)

    The ID of the organizational unit.

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 Amazon Web Services account.

    • OpenProactiveInsights — (Integer)

      An integer that specifies the number of open proactive insights in your Amazon Web Services account.

    • MetricsAnalyzed — (Integer)

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

    • ResourceHours — (Integer)

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

Returns:

• (AWS.Request) —

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

var params = {
  FromTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  OrganizationalUnitIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
devopsguru.describeOrganizationOverview(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.

  • AccountIds — (Array<String>)

    The ID of the Amazon Web Services account.

  • OrganizationalUnitIds — (Array<String>)

    The ID of the organizational unit.

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 Amazon Web Services account.

    • ProactiveInsights — (Integer)

      An integer that specifies the number of open proactive insights in your Amazon Web Services account.

Returns:

• (AWS.Request) —

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

var params = {
  OrganizationResourceCollectionType: AWS_CLOUD_FORMATION | AWS_SERVICE | AWS_ACCOUNT | AWS_TAGS, /* required */
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OrganizationalUnitIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
devopsguru.describeOrganizationResourceCollectionHealth(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: {}) —
  • OrganizationResourceCollectionType — (String)

    An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

    Possible values include:
    • "AWS_CLOUD_FORMATION"
    • "AWS_SERVICE"
    • "AWS_ACCOUNT"
    • "AWS_TAGS"
  • AccountIds — (Array<String>)

    The ID of the Amazon Web Services account.

  • OrganizationalUnitIds — (Array<String>)

    The ID of the organizational unit.

  • 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.

  • 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.

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 Amazon Web Services resources in your account that are specified by an Amazon Web Services 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.

      • AnalyzedResourceCount — (Integer)

        Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services CloudFormation stack.

    • Service — (Array<map>)

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

      • ServiceName — (String)

        The name of the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services service

        • OpenReactiveInsights — (Integer)

          The number of open reactive insights in the Amazon Web Services service

      • AnalyzedResourceCount — (Integer)

        Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web Services service.

    • Account — (Array<map>)

      The name of the organization's account.

      • AccountId — (String)

        The ID of the Amazon Web Services account.

      • Insight — (map)

        Information about the health of the Amazon Web Services resources in your account, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

        • OpenProactiveInsights — (Integer)

          An integer that specifies the number of open proactive insights in your Amazon Web Services account.

        • OpenReactiveInsights — (Integer)

          An integer that specifies the number of open reactive insights in your Amazon Web Services account.

    • 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.

    • Tags — (Array<map>)

      Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

      Each Amazon Web Services tag has two parts.

      • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

      • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

      Together these are known as key-value pairs.

      The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

      • AppBoundaryKey — (String)

        An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

        The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

      • TagValue — (String)

        The value in an Amazon Web Services tag.

        The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • Insight — (map)

        Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, 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.

      • AnalyzedResourceCount — (Integer)

        Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services tag.

Returns:

• (AWS.Request) —

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

var params = {
  ResourceCollectionType: AWS_CLOUD_FORMATION | AWS_SERVICE | AWS_TAGS, /* 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 Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

    Possible values include:
    • "AWS_CLOUD_FORMATION"
    • "AWS_SERVICE"
    • "AWS_TAGS"
  • 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 Amazon Web Services resources in your account that are specified by an Amazon Web Services 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.

      • AnalyzedResourceCount — (Integer)

        Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services CloudFormation stack.

    • Service — (Array<map>)

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

      • ServiceName — (String)

        The name of the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services service

        • OpenReactiveInsights — (Integer)

          The number of open reactive insights in the Amazon Web Services service

      • AnalyzedResourceCount — (Integer)

        Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web Services 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.

    • Tags — (Array<map>)

      The Amazon Web Services tags that are used by resources in the resource collection.

      Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

      Each Amazon Web Services tag has two parts.

      • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

      • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

      Together these are known as key-value pairs.

      The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

      • AppBoundaryKey — (String)

        An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

        The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

      • TagValue — (String)

        The value in an Amazon Web Services tag.

        The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • Insight — (map)

        Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, 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.

      • AnalyzedResourceCount — (Integer)

        Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services tag.

Returns:

• (AWS.Request) —

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

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 Amazon Web Services service, such as Amazon Web Services Systems Manager.

      • OpsCenter — (map)

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

        • OptInStatus — (String)

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

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • LogsAnomalyDetection — (map)

        Information about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups.

        • OptInStatus — (String)

          Specifies if DevOps Guru is configured to perform log anomaly detection on CloudWatch log groups.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • KMSServerSideEncryption — (map)

        Information about whether DevOps Guru is configured to encrypt server-side data using KMS.

        • KMSKeyId — (String)

          Describes the specified KMS key.

          To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), Amazon Web Services KMS associates the alias with an Amazon Web Services managed key and returns its KeyId and Arn in the response. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

          For example:

          Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

          Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

          Alias name: alias/ExampleAlias

          Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

        • OptInStatus — (String)

          Specifies if DevOps Guru is enabled for customer managed keys.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • Type — (String)

          The type of KMS key used. Customer managed keys are the KMS keys that you create. Amazon Web Services owned keys are keys that are owned and managed by DevOps Guru.

          Possible values include:
          • "CUSTOMER_MANAGED_KEY"
          • "AWS_OWNED_KMS_KEY"

Returns:

• (AWS.Request) —

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

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 Amazon Web Services resources used to create your monthly DevOps Guru cost estimate.

      • CloudFormation — (map)

        An object that specifies the CloudFormation stack that defines the Amazon Web Services 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.

      • Tags — (Array<map>)

        The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.

        Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

        Each Amazon Web Services tag has two parts.

        • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

        • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

        Together these are known as key-value pairs.

        The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

        • AppBoundaryKey — required — (String)

          An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

        • TagValues — required — (Array<String>)

          The values in an Amazon Web Services tag collection.

          The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

    • 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 Amazon Web Services resources.

      • Type — (String)

        The type of the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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.

var params = {
  ResourceCollectionType: AWS_CLOUD_FORMATION | AWS_SERVICE | AWS_TAGS, /* 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 Amazon Web Services resource collections to return. The one valid value is CLOUD_FORMATION for Amazon Web Services CloudFormation stacks.

    Possible values include:
    • "AWS_CLOUD_FORMATION"
    • "AWS_SERVICE"
    • "AWS_TAGS"
  • 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 Amazon Web Services resource collections. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

      • CloudFormation — (map)

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

        • StackNames — (Array<String>)

          An array of CloudFormation stack names.

      • Tags — (Array<map>)

        The Amazon Web Services tags used to filter the resources in the resource collection.

        Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

        Each Amazon Web Services tag has two parts.

        • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

        • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

        Together these are known as key-value pairs.

        The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

        • AppBoundaryKey — required — (String)

          An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

        • TagValues — required — (Array<String>)

          The values in an Amazon Web Services tag collection.

          The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

    • 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.

var params = {
  InsightId: 'STRING_VALUE', /* required */
  AccountId: 'STRING_VALUE',
  Filters: {
    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 */
      ]
    }
  },
  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.

  • AccountId — (String)

    The ID of the Amazon Web Services account.

  • Filters — (map)

    Specifies one or more service names that are used to list anomalies.

    • ServiceCollection — (map)

      A collection of the names of Amazon Web Services services.

      • ServiceNames — (Array<String>)

        An array of strings that each specifies the name of an Amazon Web Services service.

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. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

        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)

        An 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 objects that contain information about analyzed CloudWatch metrics that show 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.

          • MetricDataSummary — (map)

            This object returns anomaly metric data.

            • TimestampMetricValuePairList — (Array<map>)

              This is a list of Amazon CloudWatch metric values at given timestamp.

              • Timestamp — (Date)

                A Timestamp that specifies the time the event occurred.

              • MetricValue — (Float)

                Value of the anomalous metric data point at respective Timestamp.

            • StatusCode — (String)

              This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.

              Possible values include:
              • "Complete"
              • "InternalError"
              • "PartialData"
        • PerformanceInsightsMetrics — (Array<map>)

          An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.

          • MetricDisplayName — (String)

            The name used for a specific Performance Insights metric.

          • Unit — (String)

            The unit of measure for a metric. For example, a session or a process.

          • MetricQuery — (map)

            A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .

            • Metric — (String)

              The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

              Valid values for Metric are:

              • db.load.avg - a scaled representation of the number of active sessions for the database engine.

              • db.sampledload.avg - the raw number of active sessions for the database engine.

              If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

            • GroupBy — (map)

              The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

              • Group — (String)

                The name of the dimension group. Its valid values are:

                • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.host - The host name of the connected client (all engines)

                • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.sql - The SQL that is currently executing (all engines)

                • db.sql_tokenized - The SQL digest (all engines)

                • db.wait_event - The event for which the database backend is waiting (all engines)

                • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

                • db.user - The user logged in to the database (all engines)

              • Dimensions — (Array<String>)

                A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

                Valid values for elements in the Dimensions array are:

                • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.host.id - The host ID of the connected client (all engines)

                • db.host.name - The host name of the connected client (all engines)

                • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.sql.id - The SQL ID generated by Performance Insights (all engines)

                • db.sql.db_id - The SQL ID generated by the database (all engines)

                • db.sql.statement - The SQL text that is being executed (all engines)

                • db.sql.tokenized_id

                • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

                • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

                • db.sql_tokenized.statement - The SQL digest text (all engines)

                • db.user.id - The ID of the user logged in to the database (all engines)

                • db.user.name - The name of the user logged in to the database (all engines)

                • db.wait_event.name - The event for which the backend is waiting (all engines)

                • db.wait_event.type - The type of event for which the backend is waiting (all engines)

                • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

              • Limit — (Integer)

                The maximum number of items to fetch for this dimension group.

            • Filter — (map<String>)

              One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

              • Any number of filters by the same dimension, as specified in the GroupBy parameter.

              • A single filter for any other dimension in this dimension group.

          • ReferenceData — (Array<map>)

            For more information, see PerformanceInsightsReferenceData .

            • Name — (String)

              The name of the reference data.

            • ComparisonValues — (map)

              The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .

              • ReferenceScalar — (map)

                A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used to determine if an actual metric value should be considered anomalous.

                • Value — (Float)

                  The reference value.

              • ReferenceMetric — (map)

                A metric that DevOps Guru compares to actual metric values. This reference metric is used to determine if an actual metric should be considered anomalous.

                • MetricQuery — (map)

                  A query to be processed on the metric.

                  • Metric — (String)

                    The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

                    Valid values for Metric are:

                    • db.load.avg - a scaled representation of the number of active sessions for the database engine.

                    • db.sampledload.avg - the raw number of active sessions for the database engine.

                    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

                  • GroupBy — (map)

                    The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

                    • Group — (String)

                      The name of the dimension group. Its valid values are:

                      • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                      • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.host - The host name of the connected client (all engines)

                      • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.sql - The SQL that is currently executing (all engines)

                      • db.sql_tokenized - The SQL digest (all engines)

                      • db.wait_event - The event for which the database backend is waiting (all engines)

                      • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

                      • db.user - The user logged in to the database (all engines)

                    • Dimensions — (Array<String>)

                      A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

                      Valid values for elements in the Dimensions array are:

                      • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.host.id - The host ID of the connected client (all engines)

                      • db.host.name - The host name of the connected client (all engines)

                      • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                      • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.sql.id - The SQL ID generated by Performance Insights (all engines)

                      • db.sql.db_id - The SQL ID generated by the database (all engines)

                      • db.sql.statement - The SQL text that is being executed (all engines)

                      • db.sql.tokenized_id

                      • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

                      • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

                      • db.sql_tokenized.statement - The SQL digest text (all engines)

                      • db.user.id - The ID of the user logged in to the database (all engines)

                      • db.user.name - The name of the user logged in to the database (all engines)

                      • db.wait_event.name - The event for which the backend is waiting (all engines)

                      • db.wait_event.type - The type of event for which the backend is waiting (all engines)

                      • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

                    • Limit — (Integer)

                      The maximum number of items to fetch for this dimension group.

                  • Filter — (map<String>)

                    One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

                    • Any number of filters by the same dimension, as specified in the GroupBy parameter.

                    • A single filter for any other dimension in this dimension group.

          • StatsAtAnomaly — (Array<map>)

            The metric statistics during the anomalous period detected by DevOps Guru;

            • Type — (String)

              The statistic type.

            • Value — (Float)

              The value of the statistic.

          • StatsAtBaseline — (Array<map>)

            Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.

            • Type — (String)

              The statistic type.

            • Value — (Float)

              The value of the statistic.

      • AssociatedInsightId — (String)

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

      • ResourceCollection — (map)

        A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • 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.

      • SourceMetadata — (map)

        The metadata of the source which detects proactive anomalies.

        • Source — (String)

          The source of the anomaly.

        • SourceResourceName — (String)

          The name of the anomaly's resource.

        • SourceResourceType — (String)

          The anomaly's resource type.

      • AnomalyResources — (Array<map>)

        Information about a resource in which DevOps Guru detected anomalous behavior.

        • Name — (String)

          The name of the Amazon Web Services resource.

        • Type — (String)

          The type of the Amazon Web Services resource.

      • Description — (String)

        A description of the proactive 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 anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

        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)

        An 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 objects that contain information about analyzed CloudWatch metrics that show 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.

          • MetricDataSummary — (map)

            This object returns anomaly metric data.

            • TimestampMetricValuePairList — (Array<map>)

              This is a list of Amazon CloudWatch metric values at given timestamp.

              • Timestamp — (Date)

                A Timestamp that specifies the time the event occurred.

              • MetricValue — (Float)

                Value of the anomalous metric data point at respective Timestamp.

            • StatusCode — (String)

              This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error.

              Possible values include:
              • "Complete"
              • "InternalError"
              • "PartialData"
        • PerformanceInsightsMetrics — (Array<map>)

          An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.

          • MetricDisplayName — (String)

            The name used for a specific Performance Insights metric.

          • Unit — (String)

            The unit of measure for a metric. For example, a session or a process.

          • MetricQuery — (map)

            A single query to be processed for the metric. For more information, see PerformanceInsightsMetricQuery .

            • Metric — (String)

              The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

              Valid values for Metric are:

              • db.load.avg - a scaled representation of the number of active sessions for the database engine.

              • db.sampledload.avg - the raw number of active sessions for the database engine.

              If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

            • GroupBy — (map)

              The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

              • Group — (String)

                The name of the dimension group. Its valid values are:

                • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.host - The host name of the connected client (all engines)

                • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.sql - The SQL that is currently executing (all engines)

                • db.sql_tokenized - The SQL digest (all engines)

                • db.wait_event - The event for which the database backend is waiting (all engines)

                • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

                • db.user - The user logged in to the database (all engines)

              • Dimensions — (Array<String>)

                A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

                Valid values for elements in the Dimensions array are:

                • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.host.id - The host ID of the connected client (all engines)

                • db.host.name - The host name of the connected client (all engines)

                • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                • db.sql.id - The SQL ID generated by Performance Insights (all engines)

                • db.sql.db_id - The SQL ID generated by the database (all engines)

                • db.sql.statement - The SQL text that is being executed (all engines)

                • db.sql.tokenized_id

                • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

                • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

                • db.sql_tokenized.statement - The SQL digest text (all engines)

                • db.user.id - The ID of the user logged in to the database (all engines)

                • db.user.name - The name of the user logged in to the database (all engines)

                • db.wait_event.name - The event for which the backend is waiting (all engines)

                • db.wait_event.type - The type of event for which the backend is waiting (all engines)

                • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

              • Limit — (Integer)

                The maximum number of items to fetch for this dimension group.

            • Filter — (map<String>)

              One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

              • Any number of filters by the same dimension, as specified in the GroupBy parameter.

              • A single filter for any other dimension in this dimension group.

          • ReferenceData — (Array<map>)

            For more information, see PerformanceInsightsReferenceData .

            • Name — (String)

              The name of the reference data.

            • ComparisonValues — (map)

              The specific reference values used to evaluate the Performance Insights. For more information, see PerformanceInsightsReferenceComparisonValues .

              • ReferenceScalar — (map)

                A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used to determine if an actual metric value should be considered anomalous.

                • Value — (Float)

                  The reference value.

              • ReferenceMetric — (map)

                A metric that DevOps Guru compares to actual metric values. This reference metric is used to determine if an actual metric should be considered anomalous.

                • MetricQuery — (map)

                  A query to be processed on the metric.

                  • Metric — (String)

                    The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.

                    Valid values for Metric are:

                    • db.load.avg - a scaled representation of the number of active sessions for the database engine.

                    • db.sampledload.avg - the raw number of active sessions for the database engine.

                    If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

                  • GroupBy — (map)

                    The specification for how to aggregate the data points from a Performance Insights GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

                    • Group — (String)

                      The name of the dimension group. Its valid values are:

                      • db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                      • db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.host - The host name of the connected client (all engines)

                      • db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.sql - The SQL that is currently executing (all engines)

                      • db.sql_tokenized - The SQL digest (all engines)

                      • db.wait_event - The event for which the database backend is waiting (all engines)

                      • db.wait_event_type - The type of event for which the database backend is waiting (all engines)

                      • db.user - The user logged in to the database (all engines)

                    • Dimensions — (Array<String>)

                      A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.

                      Valid values for elements in the Dimensions array are:

                      • db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.host.id - The host ID of the connected client (all engines)

                      • db.host.name - The host name of the connected client (all engines)

                      • db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)

                      • db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)

                      • db.sql.id - The SQL ID generated by Performance Insights (all engines)

                      • db.sql.db_id - The SQL ID generated by the database (all engines)

                      • db.sql.statement - The SQL text that is being executed (all engines)

                      • db.sql.tokenized_id

                      • db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)

                      • db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)

                      • db.sql_tokenized.statement - The SQL digest text (all engines)

                      • db.user.id - The ID of the user logged in to the database (all engines)

                      • db.user.name - The name of the user logged in to the database (all engines)

                      • db.wait_event.name - The event for which the backend is waiting (all engines)

                      • db.wait_event.type - The type of event for which the backend is waiting (all engines)

                      • db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)

                    • Limit — (Integer)

                      The maximum number of items to fetch for this dimension group.

                  • Filter — (map<String>)

                    One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:

                    • Any number of filters by the same dimension, as specified in the GroupBy parameter.

                    • A single filter for any other dimension in this dimension group.

          • StatsAtAnomaly — (Array<map>)

            The metric statistics during the anomalous period detected by DevOps Guru;

            • Type — (String)

              The statistic type.

            • Value — (Float)

              The value of the statistic.

          • StatsAtBaseline — (Array<map>)

            Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.

            • Type — (String)

              The statistic type.

            • Value — (Float)

              The value of the statistic.

      • AssociatedInsightId — (String)

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

      • ResourceCollection — (map)

        A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • Type — (String)

        The type of the reactive anomaly. It can be one of the following types.

        • CAUSAL - the anomaly can cause a new insight.

        • CONTEXTUAL - the anomaly contains additional information about an insight or its causal anomaly.

        Possible values include:
        • "CAUSAL"
        • "CONTEXTUAL"
      • Name — (String)

        The name of the reactive anomaly.

      • Description — (String)

        A description of the reactive anomaly.

      • CausalAnomalyId — (String)

        The ID of the causal anomaly that is associated with this reactive anomaly. The ID of a CAUSAL anomaly is always NULL.

      • AnomalyResources — (Array<map>)

        The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.

        • Name — (String)

          The name of the Amazon Web Services resource.

        • Type — (String)

          The type of the Amazon Web Services resource.

    • 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.

var params = {
  InsightId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
devopsguru.listAnomalousLogGroups(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 containing the log groups.

  • 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:

    • InsightId — (String)

      The ID of the insight containing the log groups.

    • AnomalousLogGroups — (Array<map>)

      The list of Amazon CloudWatch log groups that are related to an insight.

      • LogGroupName — (String)

        The name of the CloudWatch log group.

      • ImpactStartTime — (Date)

        The time the anomalous log events began. The impact start time indicates the time of the first log anomaly event that occurs.

      • ImpactEndTime — (Date)

        The time the anomalous log events stopped.

      • NumberOfLogLinesScanned — (Integer)

        The number of log lines that were scanned for anomalous log events.

      • LogAnomalyShowcases — (Array<map>)

        The log anomalies in the log group. Each log anomaly displayed represents a cluster of similar anomalous log events.

        • LogAnomalyClasses — (Array<map>)

          A list of anomalous log events that may be related.

          • LogStreamName — (String)

            The name of the Amazon CloudWatch log stream that the anomalous log event belongs to. A log stream is a sequence of log events that share the same source.

          • LogAnomalyType — (String)

            The type of log anomaly that has been detected.

            Possible values include:
            • "KEYWORD"
            • "KEYWORD_TOKEN"
            • "FORMAT"
            • "HTTP_CODE"
            • "BLOCK_FORMAT"
            • "NUMERICAL_POINT"
            • "NUMERICAL_NAN"
            • "NEW_FIELD_NAME"
          • LogAnomalyToken — (String)

            The token where the anomaly was detected. This may refer to an exception or another location, or it may be blank for log anomalies such as format anomalies.

          • LogEventId — (String)

            The ID of the log event.

          • Explanation — (String)

            The explanation for why the log event is considered an anomaly.

          • NumberOfLogLinesOccurrences — (Integer)

            The number of log lines where this anomalous log event occurs.

          • LogEventTimestamp — (Date)

            The time of the first occurrence of the anomalous log 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.

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 */
        ]
      },
      Tags: [
        {
          AppBoundaryKey: 'STRING_VALUE', /* required */
          TagValues: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        },
        /* more items */
      ]
    }
  },
  AccountId: 'STRING_VALUE',
  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 Amazon Web Services 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 Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

      • CloudFormation — (map)

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

        • StackNames — (Array<String>)

          An array of CloudFormation stack names.

      • Tags — (Array<map>)

        The Amazon Web Services tags that are used by resources in the resource collection.

        Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

        Each Amazon Web Services tag has two parts.

        • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

        • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

        Together these are known as key-value pairs.

        The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

        • AppBoundaryKey — required — (String)

          An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

        • TagValues — required — (Array<String>)

          The values in an Amazon Web Services tag collection.

          The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

  • 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.

  • AccountId — (String)

    The ID of the Amazon Web Services account.

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 Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • Id — (String)

        The ID of the event.

      • Time — (Date)

        A Timestamp that specifies the time the event occurred.

      • EventSource — (String)

        The Amazon Web Services 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.

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 insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

        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 Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • ServiceCollection — (map)

        A collection of the names of Amazon Web Services services.

        • ServiceNames — (Array<String>)

          An array of strings that each specifies the name of an Amazon Web Services service.

      • AssociatedResourceArns — (Array<String>)

        The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.

    • 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 the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.

        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 Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

      • ServiceCollection — (map)

        A collection of the names of Amazon Web Services services.

        • ServiceNames — (Array<String>)

          An array of strings that each specifies the name of an Amazon Web Services service.

      • AssociatedResourceArns — (Array<String>)

        The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.

    • 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.

var params = {
  Filters: {
    ResourcePermission: FULL_PERMISSION | MISSING_PERMISSION, /* required */
    ResourceTypeFilters: [ /* required */
      LOG_GROUPS | CLOUDFRONT_DISTRIBUTION | DYNAMODB_TABLE | EC2_NAT_GATEWAY | ECS_CLUSTER | ECS_SERVICE | EKS_CLUSTER | ELASTIC_BEANSTALK_ENVIRONMENT | ELASTIC_LOAD_BALANCER_LOAD_BALANCER | ELASTIC_LOAD_BALANCING_V2_LOAD_BALANCER | ELASTIC_LOAD_BALANCING_V2_TARGET_GROUP | ELASTICACHE_CACHE_CLUSTER | ELASTICSEARCH_DOMAIN | KINESIS_STREAM | LAMBDA_FUNCTION | OPEN_SEARCH_SERVICE_DOMAIN | RDS_DB_INSTANCE | RDS_DB_CLUSTER | REDSHIFT_CLUSTER | ROUTE53_HOSTED_ZONE | ROUTE53_HEALTH_CHECK | S3_BUCKET | SAGEMAKER_ENDPOINT | SNS_TOPIC | SQS_QUEUE | STEP_FUNCTIONS_ACTIVITY | STEP_FUNCTIONS_STATE_MACHINE,
      /* more items */
    ]
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
devopsguru.listMonitoredResources(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)

    Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status.

    • ResourcePermission — required — (String)

      The permission status of a resource.

      Possible values include:
      • "FULL_PERMISSION"
      • "MISSING_PERMISSION"
    • ResourceTypeFilters — required — (Array<String>)

      The type of resource that you wish to retrieve, such as log groups.

  • 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:

    • MonitoredResourceIdentifiers — (Array<map>)

      Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource.

      • MonitoredResourceName — (String)

        The name of the resource being monitored.

      • Type — (String)

        The type of resource being monitored.

      • ResourcePermission — (String)

        The permission status of a resource.

        Possible values include:
        • "FULL_PERMISSION"
        • "MISSING_PERMISSION"
      • LastUpdated — (Date)

        The time at which DevOps Guru last updated this resource.

      • ResourceCollection — (map)

        A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

        • CloudFormation — (map)

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

          • StackNames — (Array<String>)

            An array of CloudFormation stack names.

        • Tags — (Array<map>)

          The Amazon Web Services tags that are used by resources in the resource collection.

          Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

          Each Amazon Web Services tag has two parts.

          • A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.

          • An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

          Together these are known as key-value pairs.

          The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • AppBoundaryKey — required — (String)

            An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.

            The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

          • TagValues — required — (Array<String>)

            The values in an Amazon Web Services tag collection.

            The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.

    • 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.

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 send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics.

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

          • TopicArn — (String)

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

        • Filters — (map)

          The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. If you do not provide filter configurations, the default configurations are to receive notifications for all message types of High or Medium severity.

          • Severities — (Array<String>)

            The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights with HIGH and MEDIUM severity levels. For more information, see Understanding insight severities.

          • MessageTypes — (Array<String>)

            The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created.

    • 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.

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 */
    }
  },
  AccountIds: [
    'STRING_VALUE',
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  OrganizationalUnitIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
devopsguru.listOrganizationInsights(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 by ListInsights to specify which insights to return.

    • 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.

  • AccountIds — (Array<String>)

    The ID of the Amazon Web Services account.

  • OrganizationalUnitIds — (Array<String>)

    The ID of the organizational unit.

  • 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.