Class: Aws::DevOpsGuru::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb

Overview

An API client for DevOpsGuru. To construct a client, you need to configure a :region and :credentials.

client = Aws::DevOpsGuru::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



335
336
337
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 335

def initialize(*args)
  super
end

Instance Method Details

#add_notification_channel(params = {}) ⇒ Types::AddNotificationChannelResponse

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

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

If you use an Amazon SNS topic that is encrypted by an 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.

Examples:

Request syntax with placeholder values


resp = client.add_notification_channel({
  config: { # required
    sns: { # required
      topic_arn: "TopicArn",
    },
  },
})

Response structure


resp.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :config (required, Types::NotificationChannelConfig)

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

Returns:

See Also:



389
390
391
392
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 389

def add_notification_channel(params = {}, options = {})
  req = build_request(:add_notification_channel, params)
  req.send_request(options)
end

#describe_account_health(params = {}) ⇒ Types::DescribeAccountHealthResponse

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

Examples:

Response structure


resp.open_reactive_insights #=> Integer
resp.open_proactive_insights #=> Integer
resp.metrics_analyzed #=> Integer
resp.resource_hours #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



417
418
419
420
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 417

def (params = {}, options = {})
  req = build_request(:describe_account_health, params)
  req.send_request(options)
end

#describe_account_overview(params = {}) ⇒ Types::DescribeAccountOverviewResponse

For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights.

Examples:

Request syntax with placeholder values


resp = client.({
  from_time: Time.now, # required
  to_time: Time.now,
})

Response structure


resp.reactive_insights #=> Integer
resp.proactive_insights #=> Integer
resp.mean_time_to_recover_in_milliseconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :from_time (required, Time, DateTime, Date, Integer, String)

    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.

  • :to_time (Time, DateTime, Date, Integer, String)

    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.

Returns:

See Also:



461
462
463
464
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 461

def (params = {}, options = {})
  req = build_request(:describe_account_overview, params)
  req.send_request(options)
end

#describe_anomaly(params = {}) ⇒ Types::DescribeAnomalyResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_anomaly({
  id: "AnomalyId", # required
  account_id: "AwsAccountId",
})

Response structure


resp.proactive_anomaly.id #=> String
resp.proactive_anomaly.severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.proactive_anomaly.status #=> String, one of "ONGOING", "CLOSED"
resp.proactive_anomaly.update_time #=> Time
resp.proactive_anomaly.anomaly_time_range.start_time #=> Time
resp.proactive_anomaly.anomaly_time_range.end_time #=> Time
resp.proactive_anomaly.anomaly_reported_time_range.open_time #=> Time
resp.proactive_anomaly.anomaly_reported_time_range.close_time #=> Time
resp.proactive_anomaly.prediction_time_range.start_time #=> Time
resp.proactive_anomaly.prediction_time_range.end_time #=> Time
resp.proactive_anomaly.source_details.cloud_watch_metrics #=> Array
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].metric_name #=> String
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].namespace #=> String
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].dimensions #=> Array
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].dimensions[0].name #=> String
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].dimensions[0].value #=> String
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].stat #=> String, one of "Sum", "Average", "SampleCount", "Minimum", "Maximum", "p99", "p90", "p50"
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].unit #=> String
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].period #=> Integer
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list #=> Array
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list[0].timestamp #=> Time
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list[0].metric_value #=> Float
resp.proactive_anomaly.source_details.cloud_watch_metrics[0].metric_data_summary.status_code #=> String, one of "Complete", "InternalError", "PartialData"
resp.proactive_anomaly.source_details.performance_insights_metrics #=> Array
resp.proactive_anomaly.source_details.performance_insights_metrics[0].metric_display_name #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].unit #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].metric_query.metric #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].metric_query.group_by.group #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].metric_query.group_by.dimensions #=> Array
resp.proactive_anomaly.source_details.performance_insights_metrics[0].metric_query.group_by.dimensions[0] #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].metric_query.group_by.limit #=> Integer
resp.proactive_anomaly.source_details.performance_insights_metrics[0].metric_query.filter #=> Hash
resp.proactive_anomaly.source_details.performance_insights_metrics[0].metric_query.filter["PerformanceInsightsMetricFilterKey"] #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data #=> Array
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].name #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_scalar.value #=> Float
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.metric #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.group #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.dimensions #=> Array
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.dimensions[0] #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.limit #=> Integer
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.filter #=> Hash
resp.proactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.filter["PerformanceInsightsMetricFilterKey"] #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].stats_at_anomaly #=> Array
resp.proactive_anomaly.source_details.performance_insights_metrics[0].stats_at_anomaly[0].type #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].stats_at_anomaly[0].value #=> Float
resp.proactive_anomaly.source_details.performance_insights_metrics[0].stats_at_baseline #=> Array
resp.proactive_anomaly.source_details.performance_insights_metrics[0].stats_at_baseline[0].type #=> String
resp.proactive_anomaly.source_details.performance_insights_metrics[0].stats_at_baseline[0].value #=> Float
resp.proactive_anomaly.associated_insight_id #=> String
resp.proactive_anomaly.resource_collection.cloud_formation.stack_names #=> Array
resp.proactive_anomaly.resource_collection.cloud_formation.stack_names[0] #=> String
resp.proactive_anomaly.resource_collection.tags #=> Array
resp.proactive_anomaly.resource_collection.tags[0].app_boundary_key #=> String
resp.proactive_anomaly.resource_collection.tags[0].tag_values #=> Array
resp.proactive_anomaly.resource_collection.tags[0].tag_values[0] #=> String
resp.proactive_anomaly.limit #=> Float
resp.reactive_anomaly.id #=> String
resp.reactive_anomaly.severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.reactive_anomaly.status #=> String, one of "ONGOING", "CLOSED"
resp.reactive_anomaly.anomaly_time_range.start_time #=> Time
resp.reactive_anomaly.anomaly_time_range.end_time #=> Time
resp.reactive_anomaly.anomaly_reported_time_range.open_time #=> Time
resp.reactive_anomaly.anomaly_reported_time_range.close_time #=> Time
resp.reactive_anomaly.source_details.cloud_watch_metrics #=> Array
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].metric_name #=> String
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].namespace #=> String
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].dimensions #=> Array
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].dimensions[0].name #=> String
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].dimensions[0].value #=> String
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].stat #=> String, one of "Sum", "Average", "SampleCount", "Minimum", "Maximum", "p99", "p90", "p50"
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].unit #=> String
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].period #=> Integer
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list #=> Array
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list[0].timestamp #=> Time
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list[0].metric_value #=> Float
resp.reactive_anomaly.source_details.cloud_watch_metrics[0].metric_data_summary.status_code #=> String, one of "Complete", "InternalError", "PartialData"
resp.reactive_anomaly.source_details.performance_insights_metrics #=> Array
resp.reactive_anomaly.source_details.performance_insights_metrics[0].metric_display_name #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].unit #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].metric_query.metric #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].metric_query.group_by.group #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].metric_query.group_by.dimensions #=> Array
resp.reactive_anomaly.source_details.performance_insights_metrics[0].metric_query.group_by.dimensions[0] #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].metric_query.group_by.limit #=> Integer
resp.reactive_anomaly.source_details.performance_insights_metrics[0].metric_query.filter #=> Hash
resp.reactive_anomaly.source_details.performance_insights_metrics[0].metric_query.filter["PerformanceInsightsMetricFilterKey"] #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data #=> Array
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].name #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_scalar.value #=> Float
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.metric #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.group #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.dimensions #=> Array
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.dimensions[0] #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.limit #=> Integer
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.filter #=> Hash
resp.reactive_anomaly.source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.filter["PerformanceInsightsMetricFilterKey"] #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].stats_at_anomaly #=> Array
resp.reactive_anomaly.source_details.performance_insights_metrics[0].stats_at_anomaly[0].type #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].stats_at_anomaly[0].value #=> Float
resp.reactive_anomaly.source_details.performance_insights_metrics[0].stats_at_baseline #=> Array
resp.reactive_anomaly.source_details.performance_insights_metrics[0].stats_at_baseline[0].type #=> String
resp.reactive_anomaly.source_details.performance_insights_metrics[0].stats_at_baseline[0].value #=> Float
resp.reactive_anomaly.associated_insight_id #=> String
resp.reactive_anomaly.resource_collection.cloud_formation.stack_names #=> Array
resp.reactive_anomaly.resource_collection.cloud_formation.stack_names[0] #=> String
resp.reactive_anomaly.resource_collection.tags #=> Array
resp.reactive_anomaly.resource_collection.tags[0].app_boundary_key #=> String
resp.reactive_anomaly.resource_collection.tags[0].tag_values #=> Array
resp.reactive_anomaly.resource_collection.tags[0].tag_values[0] #=> String
resp.reactive_anomaly.type #=> String, one of "CAUSAL", "CONTEXTUAL"
resp.reactive_anomaly.name #=> String
resp.reactive_anomaly.description #=> String
resp.reactive_anomaly.causal_anomaly_id #=> String
resp.reactive_anomaly.anomaly_resources #=> Array
resp.reactive_anomaly.anomaly_resources[0].name #=> String
resp.reactive_anomaly.anomaly_resources[0].type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the anomaly.

  • :account_id (String)

    The ID of the member account.

Returns:

See Also:



610
611
612
613
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 610

def describe_anomaly(params = {}, options = {})
  req = build_request(:describe_anomaly, params)
  req.send_request(options)
end

#describe_feedback(params = {}) ⇒ Types::DescribeFeedbackResponse

Returns the most recent feedback submitted in the current Amazon Web Services account and Region.

Examples:

Request syntax with placeholder values


resp = client.describe_feedback({
  insight_id: "InsightId",
})

Response structure


resp.insight_feedback.id #=> String
resp.insight_feedback.feedback #=> String, one of "VALID_COLLECTION", "RECOMMENDATION_USEFUL", "ALERT_TOO_SENSITIVE", "DATA_NOISY_ANOMALY", "DATA_INCORRECT"

Parameters:

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

    ({})

Options Hash (params):

  • :insight_id (String)

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

Returns:

See Also:



640
641
642
643
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 640

def describe_feedback(params = {}, options = {})
  req = build_request(:describe_feedback, params)
  req.send_request(options)
end

#describe_insight(params = {}) ⇒ Types::DescribeInsightResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_insight({
  id: "InsightId", # required
  account_id: "AwsAccountId",
})

Response structure


resp.proactive_insight.id #=> String
resp.proactive_insight.name #=> String
resp.proactive_insight.severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.proactive_insight.status #=> String, one of "ONGOING", "CLOSED"
resp.proactive_insight.insight_time_range.start_time #=> Time
resp.proactive_insight.insight_time_range.end_time #=> Time
resp.proactive_insight.prediction_time_range.start_time #=> Time
resp.proactive_insight.prediction_time_range.end_time #=> Time
resp.proactive_insight.resource_collection.cloud_formation.stack_names #=> Array
resp.proactive_insight.resource_collection.cloud_formation.stack_names[0] #=> String
resp.proactive_insight.resource_collection.tags #=> Array
resp.proactive_insight.resource_collection.tags[0].app_boundary_key #=> String
resp.proactive_insight.resource_collection.tags[0].tag_values #=> Array
resp.proactive_insight.resource_collection.tags[0].tag_values[0] #=> String
resp.proactive_insight.ssm_ops_item_id #=> String
resp.reactive_insight.id #=> String
resp.reactive_insight.name #=> String
resp.reactive_insight.severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.reactive_insight.status #=> String, one of "ONGOING", "CLOSED"
resp.reactive_insight.insight_time_range.start_time #=> Time
resp.reactive_insight.insight_time_range.end_time #=> Time
resp.reactive_insight.resource_collection.cloud_formation.stack_names #=> Array
resp.reactive_insight.resource_collection.cloud_formation.stack_names[0] #=> String
resp.reactive_insight.resource_collection.tags #=> Array
resp.reactive_insight.resource_collection.tags[0].app_boundary_key #=> String
resp.reactive_insight.resource_collection.tags[0].tag_values #=> Array
resp.reactive_insight.resource_collection.tags[0].tag_values[0] #=> String
resp.reactive_insight.ssm_ops_item_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the insight.

  • :account_id (String)

    The ID of the member account in the organization.

Returns:

See Also:



700
701
702
703
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 700

def describe_insight(params = {}, options = {})
  req = build_request(:describe_insight, params)
  req.send_request(options)
end

#describe_organization_health(params = {}) ⇒ Types::DescribeOrganizationHealthResponse

Returns active insights, predictive insights, and resource hours analyzed in last hour.

Examples:

Request syntax with placeholder values


resp = client.describe_organization_health({
  account_ids: ["AwsAccountId"],
  organizational_unit_ids: ["OrganizationalUnitId"],
})

Response structure


resp.open_reactive_insights #=> Integer
resp.open_proactive_insights #=> Integer
resp.metrics_analyzed #=> Integer
resp.resource_hours #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :account_ids (Array<String>)

    The ID of the Amazon Web Services account.

  • :organizational_unit_ids (Array<String>)

    The ID of the organizational unit.

Returns:

See Also:



739
740
741
742
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 739

def describe_organization_health(params = {}, options = {})
  req = build_request(:describe_organization_health, params)
  req.send_request(options)
end

#describe_organization_overview(params = {}) ⇒ Types::DescribeOrganizationOverviewResponse

Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.

Examples:

Request syntax with placeholder values


resp = client.describe_organization_overview({
  from_time: Time.now, # required
  to_time: Time.now,
  account_ids: ["AwsAccountId"],
  organizational_unit_ids: ["OrganizationalUnitId"],
})

Response structure


resp.reactive_insights #=> Integer
resp.proactive_insights #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :from_time (required, Time, DateTime, Date, Integer, String)

    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.

  • :to_time (Time, DateTime, Date, Integer, String)

    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.

  • :account_ids (Array<String>)

    The ID of the Amazon Web Services account.

  • :organizational_unit_ids (Array<String>)

    The ID of the organizational unit.

Returns:

See Also:



788
789
790
791
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 788

def describe_organization_overview(params = {}, options = {})
  req = build_request(:describe_organization_overview, params)
  req.send_request(options)
end

#describe_organization_resource_collection_health(params = {}) ⇒ Types::DescribeOrganizationResourceCollectionHealthResponse

Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_organization_resource_collection_health({
  organization_resource_collection_type: "AWS_CLOUD_FORMATION", # required, accepts AWS_CLOUD_FORMATION, AWS_SERVICE, AWS_ACCOUNT
  account_ids: ["AwsAccountId"],
  organizational_unit_ids: ["OrganizationalUnitId"],
  next_token: "UuidNextToken",
  max_results: 1,
})

Response structure


resp.cloud_formation #=> Array
resp.cloud_formation[0].stack_name #=> String
resp.cloud_formation[0].insight.open_proactive_insights #=> Integer
resp.cloud_formation[0].insight.open_reactive_insights #=> Integer
resp.cloud_formation[0].insight.mean_time_to_recover_in_milliseconds #=> Integer
resp.service #=> Array
resp.service[0].service_name #=> String, one of "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"
resp.service[0].insight.open_proactive_insights #=> Integer
resp.service[0].insight.open_reactive_insights #=> Integer
resp. #=> Array
resp.[0]. #=> String
resp.[0].insight.open_proactive_insights #=> Integer
resp.[0].insight.open_reactive_insights #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :organization_resource_collection_type (required, 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.

  • :account_ids (Array<String>)

    The ID of the Amazon Web Services account.

  • :organizational_unit_ids (Array<String>)

    The ID of the organizational unit.

  • :next_token (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.

  • :max_results (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.

Returns:

See Also:



862
863
864
865
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 862

def describe_organization_resource_collection_health(params = {}, options = {})
  req = build_request(:describe_organization_resource_collection_health, params)
  req.send_request(options)
end

#describe_resource_collection_health(params = {}) ⇒ Types::DescribeResourceCollectionHealthResponse

Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_resource_collection_health({
  resource_collection_type: "AWS_CLOUD_FORMATION", # required, accepts AWS_CLOUD_FORMATION, AWS_SERVICE, AWS_TAGS
  next_token: "UuidNextToken",
})

Response structure


resp.cloud_formation #=> Array
resp.cloud_formation[0].stack_name #=> String
resp.cloud_formation[0].insight.open_proactive_insights #=> Integer
resp.cloud_formation[0].insight.open_reactive_insights #=> Integer
resp.cloud_formation[0].insight.mean_time_to_recover_in_milliseconds #=> Integer
resp.service #=> Array
resp.service[0].service_name #=> String, one of "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"
resp.service[0].insight.open_proactive_insights #=> Integer
resp.service[0].insight.open_reactive_insights #=> Integer
resp.next_token #=> String
resp.tags #=> Array
resp.tags[0].app_boundary_key #=> String
resp.tags[0].tag_value #=> String
resp.tags[0].insight.open_proactive_insights #=> Integer
resp.tags[0].insight.open_reactive_insights #=> Integer
resp.tags[0].insight.mean_time_to_recover_in_milliseconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :resource_collection_type (required, 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.

  • :next_token (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.

Returns:

See Also:



931
932
933
934
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 931

def describe_resource_collection_health(params = {}, options = {})
  req = build_request(:describe_resource_collection_health, params)
  req.send_request(options)
end

#describe_service_integration(params = {}) ⇒ Types::DescribeServiceIntegrationResponse

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

Examples:

Response structure


resp.service_integration.ops_center.opt_in_status #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Returns:

See Also:



953
954
955
956
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 953

def describe_service_integration(params = {}, options = {})
  req = build_request(:describe_service_integration, params)
  req.send_request(options)
end

#get_cost_estimation(params = {}) ⇒ Types::GetCostEstimationResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_cost_estimation({
  next_token: "UuidNextToken",
})

Response structure


resp.resource_collection.cloud_formation.stack_names #=> Array
resp.resource_collection.cloud_formation.stack_names[0] #=> String
resp.resource_collection.tags #=> Array
resp.resource_collection.tags[0].app_boundary_key #=> String
resp.resource_collection.tags[0].tag_values #=> Array
resp.resource_collection.tags[0].tag_values[0] #=> String
resp.status #=> String, one of "ONGOING", "COMPLETED"
resp.costs #=> Array
resp.costs[0].type #=> String
resp.costs[0].state #=> String, one of "ACTIVE", "INACTIVE"
resp.costs[0].count #=> Integer
resp.costs[0].unit_cost #=> Float
resp.costs[0].cost #=> Float
resp.time_range.start_time #=> Time
resp.time_range.end_time #=> Time
resp.total_cost #=> Float
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (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.

Returns:

See Also:



1013
1014
1015
1016
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1013

def get_cost_estimation(params = {}, options = {})
  req = build_request(:get_cost_estimation, params)
  req.send_request(options)
end

#get_resource_collection(params = {}) ⇒ Types::GetResourceCollectionResponse

Returns lists Amazon Web Services resources that are of the specified resource collection type. 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_resource_collection({
  resource_collection_type: "AWS_CLOUD_FORMATION", # required, accepts AWS_CLOUD_FORMATION, AWS_SERVICE, AWS_TAGS
  next_token: "UuidNextToken",
})

Response structure


resp.resource_collection.cloud_formation.stack_names #=> Array
resp.resource_collection.cloud_formation.stack_names[0] #=> String
resp.resource_collection.tags #=> Array
resp.resource_collection.tags[0].app_boundary_key #=> String
resp.resource_collection.tags[0].tag_values #=> Array
resp.resource_collection.tags[0].tag_values[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_collection_type (required, String)

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

  • :next_token (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.

Returns:

See Also:



1064
1065
1066
1067
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1064

def get_resource_collection(params = {}, options = {})
  req = build_request(:get_resource_collection, params)
  req.send_request(options)
end

#list_anomalies_for_insight(params = {}) ⇒ Types::ListAnomaliesForInsightResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_anomalies_for_insight({
  insight_id: "InsightId", # required
  start_time_range: {
    from_time: Time.now,
    to_time: Time.now,
  },
  max_results: 1,
  next_token: "UuidNextToken",
  account_id: "AwsAccountId",
})

Response structure


resp.proactive_anomalies #=> Array
resp.proactive_anomalies[0].id #=> String
resp.proactive_anomalies[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.proactive_anomalies[0].status #=> String, one of "ONGOING", "CLOSED"
resp.proactive_anomalies[0].update_time #=> Time
resp.proactive_anomalies[0].anomaly_time_range.start_time #=> Time
resp.proactive_anomalies[0].anomaly_time_range.end_time #=> Time
resp.proactive_anomalies[0].anomaly_reported_time_range.open_time #=> Time
resp.proactive_anomalies[0].anomaly_reported_time_range.close_time #=> Time
resp.proactive_anomalies[0].prediction_time_range.start_time #=> Time
resp.proactive_anomalies[0].prediction_time_range.end_time #=> Time
resp.proactive_anomalies[0].source_details.cloud_watch_metrics #=> Array
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_name #=> String
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].namespace #=> String
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].dimensions #=> Array
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].dimensions[0].name #=> String
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].dimensions[0].value #=> String
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].stat #=> String, one of "Sum", "Average", "SampleCount", "Minimum", "Maximum", "p99", "p90", "p50"
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].unit #=> String
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].period #=> Integer
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list #=> Array
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list[0].timestamp #=> Time
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list[0].metric_value #=> Float
resp.proactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_data_summary.status_code #=> String, one of "Complete", "InternalError", "PartialData"
resp.proactive_anomalies[0].source_details.performance_insights_metrics #=> Array
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].metric_display_name #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].unit #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.metric #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.group_by.group #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.group_by.dimensions #=> Array
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.group_by.dimensions[0] #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.group_by.limit #=> Integer
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.filter #=> Hash
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.filter["PerformanceInsightsMetricFilterKey"] #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data #=> Array
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].name #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_scalar.value #=> Float
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.metric #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.group #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.dimensions #=> Array
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.dimensions[0] #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.limit #=> Integer
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.filter #=> Hash
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.filter["PerformanceInsightsMetricFilterKey"] #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_anomaly #=> Array
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_anomaly[0].type #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_anomaly[0].value #=> Float
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_baseline #=> Array
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_baseline[0].type #=> String
resp.proactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_baseline[0].value #=> Float
resp.proactive_anomalies[0].associated_insight_id #=> String
resp.proactive_anomalies[0].resource_collection.cloud_formation.stack_names #=> Array
resp.proactive_anomalies[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.proactive_anomalies[0].resource_collection.tags #=> Array
resp.proactive_anomalies[0].resource_collection.tags[0].app_boundary_key #=> String
resp.proactive_anomalies[0].resource_collection.tags[0].tag_values #=> Array
resp.proactive_anomalies[0].resource_collection.tags[0].tag_values[0] #=> String
resp.proactive_anomalies[0].limit #=> Float
resp.reactive_anomalies #=> Array
resp.reactive_anomalies[0].id #=> String
resp.reactive_anomalies[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.reactive_anomalies[0].status #=> String, one of "ONGOING", "CLOSED"
resp.reactive_anomalies[0].anomaly_time_range.start_time #=> Time
resp.reactive_anomalies[0].anomaly_time_range.end_time #=> Time
resp.reactive_anomalies[0].anomaly_reported_time_range.open_time #=> Time
resp.reactive_anomalies[0].anomaly_reported_time_range.close_time #=> Time
resp.reactive_anomalies[0].source_details.cloud_watch_metrics #=> Array
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_name #=> String
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].namespace #=> String
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].dimensions #=> Array
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].dimensions[0].name #=> String
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].dimensions[0].value #=> String
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].stat #=> String, one of "Sum", "Average", "SampleCount", "Minimum", "Maximum", "p99", "p90", "p50"
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].unit #=> String
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].period #=> Integer
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list #=> Array
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list[0].timestamp #=> Time
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_data_summary.timestamp_metric_value_pair_list[0].metric_value #=> Float
resp.reactive_anomalies[0].source_details.cloud_watch_metrics[0].metric_data_summary.status_code #=> String, one of "Complete", "InternalError", "PartialData"
resp.reactive_anomalies[0].source_details.performance_insights_metrics #=> Array
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].metric_display_name #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].unit #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.metric #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.group_by.group #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.group_by.dimensions #=> Array
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.group_by.dimensions[0] #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.group_by.limit #=> Integer
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.filter #=> Hash
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].metric_query.filter["PerformanceInsightsMetricFilterKey"] #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data #=> Array
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].name #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_scalar.value #=> Float
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.metric #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.group #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.dimensions #=> Array
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.dimensions[0] #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.group_by.limit #=> Integer
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.filter #=> Hash
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].reference_data[0].comparison_values.reference_metric.metric_query.filter["PerformanceInsightsMetricFilterKey"] #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_anomaly #=> Array
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_anomaly[0].type #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_anomaly[0].value #=> Float
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_baseline #=> Array
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_baseline[0].type #=> String
resp.reactive_anomalies[0].source_details.performance_insights_metrics[0].stats_at_baseline[0].value #=> Float
resp.reactive_anomalies[0].associated_insight_id #=> String
resp.reactive_anomalies[0].resource_collection.cloud_formation.stack_names #=> Array
resp.reactive_anomalies[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.reactive_anomalies[0].resource_collection.tags #=> Array
resp.reactive_anomalies[0].resource_collection.tags[0].app_boundary_key #=> String
resp.reactive_anomalies[0].resource_collection.tags[0].tag_values #=> Array
resp.reactive_anomalies[0].resource_collection.tags[0].tag_values[0] #=> String
resp.reactive_anomalies[0].type #=> String, one of "CAUSAL", "CONTEXTUAL"
resp.reactive_anomalies[0].name #=> String
resp.reactive_anomalies[0].description #=> String
resp.reactive_anomalies[0].causal_anomaly_id #=> String
resp.reactive_anomalies[0].anomaly_resources #=> Array
resp.reactive_anomalies[0].anomaly_resources[0].name #=> String
resp.reactive_anomalies[0].anomaly_resources[0].type #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :insight_id (required, String)

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

  • :start_time_range (Types::StartTimeRange)

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

  • :max_results (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.

  • :next_token (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.

  • :account_id (String)

    The ID of the Amazon Web Services account.

Returns:

See Also:



1239
1240
1241
1242
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1239

def list_anomalies_for_insight(params = {}, options = {})
  req = build_request(:list_anomalies_for_insight, params)
  req.send_request(options)
end

#list_events(params = {}) ⇒ Types::ListEventsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_events({
  filters: { # required
    insight_id: "InsightId",
    event_time_range: {
      from_time: Time.now, # required
      to_time: Time.now, # required
    },
    event_class: "INFRASTRUCTURE", # accepts INFRASTRUCTURE, DEPLOYMENT, SECURITY_CHANGE, CONFIG_CHANGE, SCHEMA_CHANGE
    event_source: "EventSource",
    data_source: "AWS_CLOUD_TRAIL", # accepts AWS_CLOUD_TRAIL, AWS_CODE_DEPLOY
    resource_collection: {
      cloud_formation: {
        stack_names: ["StackName"],
      },
      tags: [
        {
          app_boundary_key: "AppBoundaryKey", # required
          tag_values: ["TagValue"], # required
        },
      ],
    },
  },
  max_results: 1,
  next_token: "UuidNextToken",
  account_id: "AwsAccountId",
})

Response structure


resp.events #=> Array
resp.events[0].resource_collection.cloud_formation.stack_names #=> Array
resp.events[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.events[0].resource_collection.tags #=> Array
resp.events[0].resource_collection.tags[0].app_boundary_key #=> String
resp.events[0].resource_collection.tags[0].tag_values #=> Array
resp.events[0].resource_collection.tags[0].tag_values[0] #=> String
resp.events[0].id #=> String
resp.events[0].time #=> Time
resp.events[0].event_source #=> String
resp.events[0].name #=> String
resp.events[0].data_source #=> String, one of "AWS_CLOUD_TRAIL", "AWS_CODE_DEPLOY"
resp.events[0].event_class #=> String, one of "INFRASTRUCTURE", "DEPLOYMENT", "SECURITY_CHANGE", "CONFIG_CHANGE", "SCHEMA_CHANGE"
resp.events[0].resources #=> Array
resp.events[0].resources[0].type #=> String
resp.events[0].resources[0].name #=> String
resp.events[0].resources[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (required, Types::ListEventsFilters)

    A ListEventsFilters object used to specify which events to return.

  • :max_results (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.

  • :next_token (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.

  • :account_id (String)

    The ID of the Amazon Web Services account.

Returns:

See Also:



1324
1325
1326
1327
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1324

def list_events(params = {}, options = {})
  req = build_request(:list_events, params)
  req.send_request(options)
end

#list_insights(params = {}) ⇒ Types::ListInsightsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_insights({
  status_filter: { # required
    ongoing: {
      type: "REACTIVE", # required, accepts REACTIVE, PROACTIVE
    },
    closed: {
      type: "REACTIVE", # required, accepts REACTIVE, PROACTIVE
      end_time_range: { # required
        from_time: Time.now,
        to_time: Time.now,
      },
    },
    any: {
      type: "REACTIVE", # required, accepts REACTIVE, PROACTIVE
      start_time_range: { # required
        from_time: Time.now,
        to_time: Time.now,
      },
    },
  },
  max_results: 1,
  next_token: "UuidNextToken",
})

Response structure


resp.proactive_insights #=> Array
resp.proactive_insights[0].id #=> String
resp.proactive_insights[0].name #=> String
resp.proactive_insights[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.proactive_insights[0].status #=> String, one of "ONGOING", "CLOSED"
resp.proactive_insights[0].insight_time_range.start_time #=> Time
resp.proactive_insights[0].insight_time_range.end_time #=> Time
resp.proactive_insights[0].prediction_time_range.start_time #=> Time
resp.proactive_insights[0].prediction_time_range.end_time #=> Time
resp.proactive_insights[0].resource_collection.cloud_formation.stack_names #=> Array
resp.proactive_insights[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.proactive_insights[0].resource_collection.tags #=> Array
resp.proactive_insights[0].resource_collection.tags[0].app_boundary_key #=> String
resp.proactive_insights[0].resource_collection.tags[0].tag_values #=> Array
resp.proactive_insights[0].resource_collection.tags[0].tag_values[0] #=> String
resp.proactive_insights[0].service_collection.service_names #=> Array
resp.proactive_insights[0].service_collection.service_names[0] #=> String, one of "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"
resp.proactive_insights[0].associated_resource_arns #=> Array
resp.proactive_insights[0].associated_resource_arns[0] #=> String
resp.reactive_insights #=> Array
resp.reactive_insights[0].id #=> String
resp.reactive_insights[0].name #=> String
resp.reactive_insights[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.reactive_insights[0].status #=> String, one of "ONGOING", "CLOSED"
resp.reactive_insights[0].insight_time_range.start_time #=> Time
resp.reactive_insights[0].insight_time_range.end_time #=> Time
resp.reactive_insights[0].resource_collection.cloud_formation.stack_names #=> Array
resp.reactive_insights[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.reactive_insights[0].resource_collection.tags #=> Array
resp.reactive_insights[0].resource_collection.tags[0].app_boundary_key #=> String
resp.reactive_insights[0].resource_collection.tags[0].tag_values #=> Array
resp.reactive_insights[0].resource_collection.tags[0].tag_values[0] #=> String
resp.reactive_insights[0].service_collection.service_names #=> Array
resp.reactive_insights[0].service_collection.service_names[0] #=> String, one of "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"
resp.reactive_insights[0].associated_resource_arns #=> Array
resp.reactive_insights[0].associated_resource_arns[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :status_filter (required, Types::ListInsightsStatusFilter)

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

  • :max_results (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.

  • :next_token (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.

Returns:

See Also:



1424
1425
1426
1427
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1424

def list_insights(params = {}, options = {})
  req = build_request(:list_insights, params)
  req.send_request(options)
end

#list_notification_channels(params = {}) ⇒ Types::ListNotificationChannelsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_notification_channels({
  next_token: "UuidNextToken",
})

Response structure


resp.channels #=> Array
resp.channels[0].id #=> String
resp.channels[0].config.sns.topic_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (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.

Returns:

See Also:



1463
1464
1465
1466
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1463

def list_notification_channels(params = {}, options = {})
  req = build_request(:list_notification_channels, params)
  req.send_request(options)
end

#list_organization_insights(params = {}) ⇒ Types::ListOrganizationInsightsResponse

Returns a list of insights associated with the account or OU Id.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_organization_insights({
  status_filter: { # required
    ongoing: {
      type: "REACTIVE", # required, accepts REACTIVE, PROACTIVE
    },
    closed: {
      type: "REACTIVE", # required, accepts REACTIVE, PROACTIVE
      end_time_range: { # required
        from_time: Time.now,
        to_time: Time.now,
      },
    },
    any: {
      type: "REACTIVE", # required, accepts REACTIVE, PROACTIVE
      start_time_range: { # required
        from_time: Time.now,
        to_time: Time.now,
      },
    },
  },
  max_results: 1,
  account_ids: ["AwsAccountId"],
  organizational_unit_ids: ["OrganizationalUnitId"],
  next_token: "UuidNextToken",
})

Response structure


resp.proactive_insights #=> Array
resp.proactive_insights[0].id #=> String
resp.proactive_insights[0]. #=> String
resp.proactive_insights[0].organizational_unit_id #=> String
resp.proactive_insights[0].name #=> String
resp.proactive_insights[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.proactive_insights[0].status #=> String, one of "ONGOING", "CLOSED"
resp.proactive_insights[0].insight_time_range.start_time #=> Time
resp.proactive_insights[0].insight_time_range.end_time #=> Time
resp.proactive_insights[0].prediction_time_range.start_time #=> Time
resp.proactive_insights[0].prediction_time_range.end_time #=> Time
resp.proactive_insights[0].resource_collection.cloud_formation.stack_names #=> Array
resp.proactive_insights[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.proactive_insights[0].resource_collection.tags #=> Array
resp.proactive_insights[0].resource_collection.tags[0].app_boundary_key #=> String
resp.proactive_insights[0].resource_collection.tags[0].tag_values #=> Array
resp.proactive_insights[0].resource_collection.tags[0].tag_values[0] #=> String
resp.proactive_insights[0].service_collection.service_names #=> Array
resp.proactive_insights[0].service_collection.service_names[0] #=> String, one of "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"
resp.reactive_insights #=> Array
resp.reactive_insights[0].id #=> String
resp.reactive_insights[0]. #=> String
resp.reactive_insights[0].organizational_unit_id #=> String
resp.reactive_insights[0].name #=> String
resp.reactive_insights[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.reactive_insights[0].status #=> String, one of "ONGOING", "CLOSED"
resp.reactive_insights[0].insight_time_range.start_time #=> Time
resp.reactive_insights[0].insight_time_range.end_time #=> Time
resp.reactive_insights[0].resource_collection.cloud_formation.stack_names #=> Array
resp.reactive_insights[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.reactive_insights[0].resource_collection.tags #=> Array
resp.reactive_insights[0].resource_collection.tags[0].app_boundary_key #=> String
resp.reactive_insights[0].resource_collection.tags[0].tag_values #=> Array
resp.reactive_insights[0].resource_collection.tags[0].tag_values[0] #=> String
resp.reactive_insights[0].service_collection.service_names #=> Array
resp.reactive_insights[0].service_collection.service_names[0] #=> String, one of "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"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :status_filter (required, Types::ListInsightsStatusFilter)

    A filter used by ListInsights to specify which insights to return.

  • :max_results (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.

  • :account_ids (Array<String>)

    The ID of the Amazon Web Services account.

  • :organizational_unit_ids (Array<String>)

    The ID of the organizational unit.

  • :next_token (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.

Returns:

See Also:



1568
1569
1570
1571
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1568

def list_organization_insights(params = {}, options = {})
  req = build_request(:list_organization_insights, params)
  req.send_request(options)
end

#list_recommendations(params = {}) ⇒ Types::ListRecommendationsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_recommendations({
  insight_id: "InsightId", # required
  next_token: "UuidNextToken",
  locale: "DE_DE", # accepts DE_DE, EN_US, EN_GB, ES_ES, FR_FR, IT_IT, JA_JP, KO_KR, PT_BR, ZH_CN, ZH_TW
  account_id: "AwsAccountId",
})

Response structure


resp.recommendations #=> Array
resp.recommendations[0].description #=> String
resp.recommendations[0].link #=> String
resp.recommendations[0].name #=> String
resp.recommendations[0].reason #=> String
resp.recommendations[0].related_events #=> Array
resp.recommendations[0].related_events[0].name #=> String
resp.recommendations[0].related_events[0].resources #=> Array
resp.recommendations[0].related_events[0].resources[0].name #=> String
resp.recommendations[0].related_events[0].resources[0].type #=> String
resp.recommendations[0].related_anomalies #=> Array
resp.recommendations[0].related_anomalies[0].resources #=> Array
resp.recommendations[0].related_anomalies[0].resources[0].name #=> String
resp.recommendations[0].related_anomalies[0].resources[0].type #=> String
resp.recommendations[0].related_anomalies[0].source_details #=> Array
resp.recommendations[0].related_anomalies[0].source_details[0].cloud_watch_metrics #=> Array
resp.recommendations[0].related_anomalies[0].source_details[0].cloud_watch_metrics[0].metric_name #=> String
resp.recommendations[0].related_anomalies[0].source_details[0].cloud_watch_metrics[0].namespace #=> String
resp.recommendations[0].related_anomalies[0].anomaly_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :insight_id (required, String)

    The ID of the requested insight.

  • :next_token (String)

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

  • :locale (String)

    A locale that specifies the language to use for recommendations.

  • :account_id (String)

    The ID of the Amazon Web Services account.

Returns:

See Also:



1633
1634
1635
1636
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1633

def list_recommendations(params = {}, options = {})
  req = build_request(:list_recommendations, params)
  req.send_request(options)
end

#put_feedback(params = {}) ⇒ Struct

Collects customer feedback about the specified insight.

Examples:

Request syntax with placeholder values


resp = client.put_feedback({
  insight_feedback: {
    id: "InsightId",
    feedback: "VALID_COLLECTION", # accepts VALID_COLLECTION, RECOMMENDATION_USEFUL, ALERT_TOO_SENSITIVE, DATA_NOISY_ANOMALY, DATA_INCORRECT
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :insight_feedback (Types::InsightFeedback)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1659
1660
1661
1662
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1659

def put_feedback(params = {}, options = {})
  req = build_request(:put_feedback, params)
  req.send_request(options)
end

#remove_notification_channel(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.remove_notification_channel({
  id: "NotificationChannelId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the notification channel to be removed.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1683
1684
1685
1686
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1683

def remove_notification_channel(params = {}, options = {})
  req = build_request(:remove_notification_channel, params)
  req.send_request(options)
end

#search_insights(params = {}) ⇒ Types::SearchInsightsResponse

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_insights({
  start_time_range: { # required
    from_time: Time.now,
    to_time: Time.now,
  },
  filters: {
    severities: ["LOW"], # accepts LOW, MEDIUM, HIGH
    statuses: ["ONGOING"], # accepts ONGOING, CLOSED
    resource_collection: {
      cloud_formation: {
        stack_names: ["StackName"],
      },
      tags: [
        {
          app_boundary_key: "AppBoundaryKey", # required
          tag_values: ["TagValue"], # required
        },
      ],
    },
    service_collection: {
      service_names: ["API_GATEWAY"], # accepts 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
    },
  },
  max_results: 1,
  next_token: "UuidNextToken",
  type: "REACTIVE", # required, accepts REACTIVE, PROACTIVE
})

Response structure


resp.proactive_insights #=> Array
resp.proactive_insights[0].id #=> String
resp.proactive_insights[0].name #=> String
resp.proactive_insights[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.proactive_insights[0].status #=> String, one of "ONGOING", "CLOSED"
resp.proactive_insights[0].insight_time_range.start_time #=> Time
resp.proactive_insights[0].insight_time_range.end_time #=> Time
resp.proactive_insights[0].prediction_time_range.start_time #=> Time
resp.proactive_insights[0].prediction_time_range.end_time #=> Time
resp.proactive_insights[0].resource_collection.cloud_formation.stack_names #=> Array
resp.proactive_insights[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.proactive_insights[0].resource_collection.tags #=> Array
resp.proactive_insights[0].resource_collection.tags[0].app_boundary_key #=> String
resp.proactive_insights[0].resource_collection.tags[0].tag_values #=> Array
resp.proactive_insights[0].resource_collection.tags[0].tag_values[0] #=> String
resp.proactive_insights[0].service_collection.service_names #=> Array
resp.proactive_insights[0].service_collection.service_names[0] #=> String, one of "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"
resp.proactive_insights[0].associated_resource_arns #=> Array
resp.proactive_insights[0].associated_resource_arns[0] #=> String
resp.reactive_insights #=> Array
resp.reactive_insights[0].id #=> String
resp.reactive_insights[0].name #=> String
resp.reactive_insights[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.reactive_insights[0].status #=> String, one of "ONGOING", "CLOSED"
resp.reactive_insights[0].insight_time_range.start_time #=> Time
resp.reactive_insights[0].insight_time_range.end_time #=> Time
resp.reactive_insights[0].resource_collection.cloud_formation.stack_names #=> Array
resp.reactive_insights[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.reactive_insights[0].resource_collection.tags #=> Array
resp.reactive_insights[0].resource_collection.tags[0].app_boundary_key #=> String
resp.reactive_insights[0].resource_collection.tags[0].tag_values #=> Array
resp.reactive_insights[0].resource_collection.tags[0].tag_values[0] #=> String
resp.reactive_insights[0].service_collection.service_names #=> Array
resp.reactive_insights[0].service_collection.service_names[0] #=> String, one of "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"
resp.reactive_insights[0].associated_resource_arns #=> Array
resp.reactive_insights[0].associated_resource_arns[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :start_time_range (required, Types::StartTimeRange)

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

  • :filters (Types::SearchInsightsFilters)

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

  • :max_results (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.

  • :next_token (String)

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

  • :type (required, String)

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

Returns:

See Also:



1801
1802
1803
1804
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1801

def search_insights(params = {}, options = {})
  req = build_request(:search_insights, params)
  req.send_request(options)
end

#search_organization_insights(params = {}) ⇒ Types::SearchOrganizationInsightsResponse

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_organization_insights({
  account_ids: ["AwsAccountId"], # required
  start_time_range: { # required
    from_time: Time.now,
    to_time: Time.now,
  },
  filters: {
    severities: ["LOW"], # accepts LOW, MEDIUM, HIGH
    statuses: ["ONGOING"], # accepts ONGOING, CLOSED
    resource_collection: {
      cloud_formation: {
        stack_names: ["StackName"],
      },
      tags: [
        {
          app_boundary_key: "AppBoundaryKey", # required
          tag_values: ["TagValue"], # required
        },
      ],
    },
    service_collection: {
      service_names: ["API_GATEWAY"], # accepts 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
    },
  },
  max_results: 1,
  next_token: "UuidNextToken",
  type: "REACTIVE", # required, accepts REACTIVE, PROACTIVE
})

Response structure


resp.proactive_insights #=> Array
resp.proactive_insights[0].id #=> String
resp.proactive_insights[0].name #=> String
resp.proactive_insights[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.proactive_insights[0].status #=> String, one of "ONGOING", "CLOSED"
resp.proactive_insights[0].insight_time_range.start_time #=> Time
resp.proactive_insights[0].insight_time_range.end_time #=> Time
resp.proactive_insights[0].prediction_time_range.start_time #=> Time
resp.proactive_insights[0].prediction_time_range.end_time #=> Time
resp.proactive_insights[0].resource_collection.cloud_formation.stack_names #=> Array
resp.proactive_insights[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.proactive_insights[0].resource_collection.tags #=> Array
resp.proactive_insights[0].resource_collection.tags[0].app_boundary_key #=> String
resp.proactive_insights[0].resource_collection.tags[0].tag_values #=> Array
resp.proactive_insights[0].resource_collection.tags[0].tag_values[0] #=> String
resp.proactive_insights[0].service_collection.service_names #=> Array
resp.proactive_insights[0].service_collection.service_names[0] #=> String, one of "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"
resp.proactive_insights[0].associated_resource_arns #=> Array
resp.proactive_insights[0].associated_resource_arns[0] #=> String
resp.reactive_insights #=> Array
resp.reactive_insights[0].id #=> String
resp.reactive_insights[0].name #=> String
resp.reactive_insights[0].severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.reactive_insights[0].status #=> String, one of "ONGOING", "CLOSED"
resp.reactive_insights[0].insight_time_range.start_time #=> Time
resp.reactive_insights[0].insight_time_range.end_time #=> Time
resp.reactive_insights[0].resource_collection.cloud_formation.stack_names #=> Array
resp.reactive_insights[0].resource_collection.cloud_formation.stack_names[0] #=> String
resp.reactive_insights[0].resource_collection.tags #=> Array
resp.reactive_insights[0].resource_collection.tags[0].app_boundary_key #=> String
resp.reactive_insights[0].resource_collection.tags[0].tag_values #=> Array
resp.reactive_insights[0].resource_collection.tags[0].tag_values[0] #=> String
resp.reactive_insights[0].service_collection.service_names #=> Array
resp.reactive_insights[0].service_collection.service_names[0] #=> String, one of "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"
resp.reactive_insights[0].associated_resource_arns #=> Array
resp.reactive_insights[0].associated_resource_arns[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :account_ids (required, Array<String>)

    The ID of the Amazon Web Services account.

  • :start_time_range (required, Types::StartTimeRange)

    A time range used to specify when the behavior of an insight or anomaly started.

  • :filters (Types::SearchOrganizationInsightsFilters)

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

  • :max_results (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.

  • :next_token (String)

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

  • :type (required, String)

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

Returns:

See Also:



1922
1923
1924
1925
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1922

def search_organization_insights(params = {}, options = {})
  req = build_request(:search_organization_insights, params)
  req.send_request(options)
end

#start_cost_estimation(params = {}) ⇒ Struct

Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.

Examples:

Request syntax with placeholder values


resp = client.start_cost_estimation({
  resource_collection: { # required
    cloud_formation: {
      stack_names: ["StackName"],
    },
    tags: [
      {
        app_boundary_key: "AppBoundaryKey", # required
        tag_values: ["TagValue"], # required
      },
    ],
  },
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_collection (required, Types::CostEstimationResourceCollectionFilter)

    The collection of Amazon Web Services resources used to create a monthly DevOps Guru cost estimate.

  • :client_token (String)

    The idempotency token used to identify each cost estimate request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1963
1964
1965
1966
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1963

def start_cost_estimation(params = {}, options = {})
  req = build_request(:start_cost_estimation, params)
  req.send_request(options)
end

#update_resource_collection(params = {}) ⇒ Struct

Updates the collection of resources that DevOps Guru analyzes. 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. This method also creates the IAM role required for you to use DevOps Guru.

Examples:

Request syntax with placeholder values


resp = client.update_resource_collection({
  action: "ADD", # required, accepts ADD, REMOVE
  resource_collection: { # required
    cloud_formation: {
      stack_names: ["StackName"],
    },
    tags: [
      {
        app_boundary_key: "AppBoundaryKey", # required
        tag_values: ["TagValue"], # required
      },
    ],
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :action (required, String)

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

  • :resource_collection (required, Types::UpdateResourceCollectionFilter)

    Contains information used to update a collection of Amazon Web Services resources.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2008
2009
2010
2011
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2008

def update_resource_collection(params = {}, options = {})
  req = build_request(:update_resource_collection, params)
  req.send_request(options)
end

#update_service_integration(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.update_service_integration({
  service_integration: { # required
    ops_center: {
      opt_in_status: "ENABLED", # accepts ENABLED, DISABLED
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :service_integration (required, Types::UpdateServiceIntegrationConfig)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2039
2040
2041
2042
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2039

def update_service_integration(params = {}, options = {})
  req = build_request(:update_service_integration, params)
  req.send_request(options)
end