Class: Aws::DevOpsGuru::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DevOpsGuru::Client
- 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
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
365 366 367 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 365 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. DevOps Guru only supports standard SNS topics. For more information, see Permissions for cross account Amazon SNS topics.
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.
430 431 432 433 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 430 def add_notification_channel(params = {}, = {}) req = build_request(:add_notification_channel, params) req.send_request() end |
#delete_insight(params = {}) ⇒ Struct
Deletes the insight along with the associated anomalies, events and recommendations.
453 454 455 456 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 453 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.
483 484 485 486 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 483 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.
527 528 529 530 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 527 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.
683 684 685 686 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 683 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.
706 707 708 709 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 706 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.
736 737 738 739 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 736 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.
798 799 800 801 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 798 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.
837 838 839 840 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 837 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.
886 887 888 889 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 886 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.
970 971 972 973 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 970 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.
1042 1043 1044 1045 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1042 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.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1065 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 and Amazon DevOps Guru pricing.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1125 1126 1127 1128 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1125 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.
1176 1177 1178 1179 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1176 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.
1366 1367 1368 1369 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1366 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.
1424 1425 1426 1427 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1424 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.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1509 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.
1609 1610 1611 1612 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1609 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.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1667 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.
1710 1711 1712 1713 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1710 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.
1815 1816 1817 1818 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1815 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.
1881 1882 1883 1884 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1881 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.
1907 1908 1909 1910 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1907 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.
1931 1932 1933 1934 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1931 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.
2048 2049 2050 2051 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2048 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.
2169 2170 2171 2172 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2169 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.
2210 2211 2212 2213 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2210 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.
2240 2241 2242 2243 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2240 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.
2285 2286 2287 2288 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2285 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.
2319 2320 2321 2322 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2319 def update_service_integration(params = {}, = {}) req = build_request(:update_service_integration, params) req.send_request() end |