Class: Aws::DevOpsGuru::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DevOpsGuru::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#add_notification_channel(params = {}) ⇒ Types::AddNotificationChannelResponse
Adds a notification channel to DevOps Guru.
-
#delete_insight(params = {}) ⇒ Struct
Deletes the insight along with the associated anomalies, events and recommendations.
-
#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.
-
#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.
-
#describe_anomaly(params = {}) ⇒ Types::DescribeAnomalyResponse
Returns details about an anomaly that you specify using its ID.
-
#describe_event_sources_config(params = {}) ⇒ Types::DescribeEventSourcesConfigResponse
Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge.
-
#describe_feedback(params = {}) ⇒ Types::DescribeFeedbackResponse
Returns the most recent feedback submitted in the current Amazon Web Services account and Region.
-
#describe_insight(params = {}) ⇒ Types::DescribeInsightResponse
Returns details about an insight that you specify using its ID.
-
#describe_organization_health(params = {}) ⇒ Types::DescribeOrganizationHealthResponse
Returns active insights, predictive insights, and resource hours analyzed in last hour.
-
#describe_organization_overview(params = {}) ⇒ Types::DescribeOrganizationOverviewResponse
Returns an overview of your organization’s history based on the specified time range.
-
#describe_organization_resource_collection_health(params = {}) ⇒ Types::DescribeOrganizationResourceCollectionHealthResponse
Provides an overview of your system’s health.
-
#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.
-
#describe_service_integration(params = {}) ⇒ Types::DescribeServiceIntegrationResponse
Returns the integration status of services that are integrated with DevOps Guru.
-
#get_cost_estimation(params = {}) ⇒ Types::GetCostEstimationResponse
Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources.
-
#get_resource_collection(params = {}) ⇒ Types::GetResourceCollectionResponse
Returns lists Amazon Web Services resources that are of the specified resource collection type.
-
#list_anomalies_for_insight(params = {}) ⇒ Types::ListAnomaliesForInsightResponse
Returns a list of the anomalies that belong to an insight that you specify using its ID.
-
#list_anomalous_log_groups(params = {}) ⇒ Types::ListAnomalousLogGroupsResponse
Returns the list of log groups that contain log anomalies.
-
#list_events(params = {}) ⇒ Types::ListEventsResponse
Returns a list of the events emitted by the resources that are evaluated by DevOps Guru.
-
#list_insights(params = {}) ⇒ Types::ListInsightsResponse
Returns a list of insights in your Amazon Web Services account.
-
#list_monitored_resources(params = {}) ⇒ Types::ListMonitoredResourcesResponse
Returns the list of all log groups that are being monitored and tagged by DevOps Guru.
-
#list_notification_channels(params = {}) ⇒ Types::ListNotificationChannelsResponse
Returns a list of notification channels configured for DevOps Guru.
-
#list_organization_insights(params = {}) ⇒ Types::ListOrganizationInsightsResponse
Returns a list of insights associated with the account or OU Id.
-
#list_recommendations(params = {}) ⇒ Types::ListRecommendationsResponse
Returns a list of a specified insight’s recommendations.
-
#put_feedback(params = {}) ⇒ Struct
Collects customer feedback about the specified insight.
-
#remove_notification_channel(params = {}) ⇒ Struct
Removes a notification channel from DevOps Guru.
-
#search_insights(params = {}) ⇒ Types::SearchInsightsResponse
Returns a list of insights in your Amazon Web Services account.
-
#search_organization_insights(params = {}) ⇒ Types::SearchOrganizationInsightsResponse
Returns a list of insights in your organization.
-
#start_cost_estimation(params = {}) ⇒ Struct
Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.
-
#update_event_sources_config(params = {}) ⇒ Struct
Enables or disables integration with a service that can be integrated with DevOps Guru.
-
#update_resource_collection(params = {}) ⇒ Struct
Updates the collection of resources that DevOps Guru analyzes.
-
#update_service_integration(params = {}) ⇒ Struct
Enables or disables integration with a service that can be integrated with DevOps Guru.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 422 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2409 2410 2411 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2409 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2412 2413 2414 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2412 def errors_module Errors 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 send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see [Permissions for Amazon SNS topics].
If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see [Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics].
[1]: docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html [2]: docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html
481 482 483 484 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 481 def add_notification_channel(params = {}, = {}) req = build_request(:add_notification_channel, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2387 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-devopsguru' context[:gem_version] = '1.47.0' Seahorse::Client::Request.new(handlers, context) end |
#delete_insight(params = {}) ⇒ Struct
Deletes the insight along with the associated anomalies, events and recommendations.
504 505 506 507 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 504 def delete_insight(params = {}, = {}) req = build_request(:delete_insight, params) req.send_request() 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.
534 535 536 537 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 534 def describe_account_health(params = {}, = {}) req = build_request(:describe_account_health, params) req.send_request() 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.
578 579 580 581 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 578 def describe_account_overview(params = {}, = {}) req = build_request(:describe_account_overview, params) req.send_request() end |
#describe_anomaly(params = {}) ⇒ Types::DescribeAnomalyResponse
Returns details about an anomaly that you specify using its ID.
734 735 736 737 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 734 def describe_anomaly(params = {}, = {}) req = build_request(:describe_anomaly, params) req.send_request() end |
#describe_event_sources_config(params = {}) ⇒ Types::DescribeEventSourcesConfigResponse
Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.
757 758 759 760 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 757 def describe_event_sources_config(params = {}, = {}) req = build_request(:describe_event_sources_config, params) req.send_request() end |
#describe_feedback(params = {}) ⇒ Types::DescribeFeedbackResponse
Returns the most recent feedback submitted in the current Amazon Web Services account and Region.
787 788 789 790 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 787 def describe_feedback(params = {}, = {}) req = build_request(:describe_feedback, params) req.send_request() end |
#describe_insight(params = {}) ⇒ Types::DescribeInsightResponse
Returns details about an insight that you specify using its ID.
849 850 851 852 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 849 def describe_insight(params = {}, = {}) req = build_request(:describe_insight, params) req.send_request() end |
#describe_organization_health(params = {}) ⇒ Types::DescribeOrganizationHealthResponse
Returns active insights, predictive insights, and resource hours analyzed in last hour.
888 889 890 891 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 888 def describe_organization_health(params = {}, = {}) req = build_request(:describe_organization_health, params) req.send_request() 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.
937 938 939 940 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 937 def describe_organization_overview(params = {}, = {}) req = build_request(:describe_organization_overview, params) req.send_request() 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.
1021 1022 1023 1024 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1021 def describe_organization_resource_collection_health(params = {}, = {}) req = build_request(:describe_organization_resource_collection_health, params) req.send_request() 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.
1093 1094 1095 1096 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1093 def describe_resource_collection_health(params = {}, = {}) req = build_request(:describe_resource_collection_health, params) req.send_request() 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.
1119 1120 1121 1122 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1119 def describe_service_integration(params = {}, = {}) req = build_request(:describe_service_integration, params) req.send_request() 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][1
-
and [Amazon DevOps Guru
[1]: docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html [2]: aws.amazon.com/devops-guru/pricing/
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1179 1180 1181 1182 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1179 def get_cost_estimation(params = {}, = {}) req = build_request(:get_cost_estimation, params) req.send_request() 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.
1230 1231 1232 1233 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1230 def get_resource_collection(params = {}, = {}) req = build_request(:get_resource_collection, params) req.send_request() 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.
1420 1421 1422 1423 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1420 def list_anomalies_for_insight(params = {}, = {}) req = build_request(:list_anomalies_for_insight, params) req.send_request() end |
#list_anomalous_log_groups(params = {}) ⇒ Types::ListAnomalousLogGroupsResponse
Returns the list of log groups that contain log anomalies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1478 1479 1480 1481 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1478 def list_anomalous_log_groups(params = {}, = {}) req = build_request(:list_anomalous_log_groups, params) req.send_request() 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.
1563 1564 1565 1566 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1563 def list_events(params = {}, = {}) req = build_request(:list_events, params) req.send_request() 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.
1663 1664 1665 1666 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1663 def list_insights(params = {}, = {}) req = build_request(:list_insights, params) req.send_request() end |
#list_monitored_resources(params = {}) ⇒ Types::ListMonitoredResourcesResponse
Returns the list of all log groups that are being monitored and tagged by DevOps Guru.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1721 1722 1723 1724 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1721 def list_monitored_resources(params = {}, = {}) req = build_request(:list_monitored_resources, params) req.send_request() 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.
1764 1765 1766 1767 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1764 def list_notification_channels(params = {}, = {}) req = build_request(:list_notification_channels, params) req.send_request() 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.
1869 1870 1871 1872 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1869 def list_organization_insights(params = {}, = {}) req = build_request(:list_organization_insights, params) req.send_request() 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.
1935 1936 1937 1938 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1935 def list_recommendations(params = {}, = {}) req = build_request(:list_recommendations, params) req.send_request() end |
#put_feedback(params = {}) ⇒ Struct
Collects customer feedback about the specified insight.
1961 1962 1963 1964 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1961 def put_feedback(params = {}, = {}) req = build_request(:put_feedback, params) req.send_request() 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.
1985 1986 1987 1988 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 1985 def remove_notification_channel(params = {}, = {}) req = build_request(:remove_notification_channel, params) req.send_request() 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` or `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.
2102 2103 2104 2105 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2102 def search_insights(params = {}, = {}) req = build_request(:search_insights, params) req.send_request() 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.
2223 2224 2225 2226 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2223 def search_organization_insights(params = {}, = {}) req = build_request(:search_organization_insights, params) req.send_request() end |
#start_cost_estimation(params = {}) ⇒ Struct
Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.
2264 2265 2266 2267 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2264 def start_cost_estimation(params = {}, = {}) req = build_request(:start_cost_estimation, params) req.send_request() end |
#update_event_sources_config(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 CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru.
2294 2295 2296 2297 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2294 def update_event_sources_config(params = {}, = {}) req = build_request(:update_event_sources_config, params) req.send_request() 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.
2339 2340 2341 2342 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2339 def update_resource_collection(params = {}, = {}) req = build_request(:update_resource_collection, params) req.send_request() 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.
2378 2379 2380 2381 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2378 def update_service_integration(params = {}, = {}) req = build_request(:update_service_integration, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2402 2403 2404 |
# File 'lib/aws-sdk-devopsguru/client.rb', line 2402 def waiter_names [] end |