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_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_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.
348 349 350 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 348 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.
409 410 411 412 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 409 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.
432 433 434 435 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 432 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.
460 461 462 463 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 460 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.
504 505 506 507 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 504 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.
659 660 661 662 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 659 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.
682 683 684 685 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 682 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.
712 713 714 715 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 712 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.
774 775 776 777 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 774 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.
813 814 815 816 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 813 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.
862 863 864 865 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 862 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.
943 944 945 946 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 943 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.
1012 1013 1014 1015 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1012 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.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1034 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.
1094 1095 1096 1097 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1094 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.
1145 1146 1147 1148 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1145 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.
1326 1327 1328 1329 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1326 def list_anomalies_for_insight(params = {}, = {}) req = build_request(:list_anomalies_for_insight, 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.
1411 1412 1413 1414 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1411 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.
1511 1512 1513 1514 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1511 def list_insights(params = {}, = {}) req = build_request(:list_insights, 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.
1550 1551 1552 1553 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1550 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.
1655 1656 1657 1658 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1655 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.
1721 1722 1723 1724 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1721 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.
1747 1748 1749 1750 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1747 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.
1771 1772 1773 1774 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1771 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
, 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.
1889 1890 1891 1892 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 1889 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.
2010 2011 2012 2013 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2010 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.
2051 2052 2053 2054 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2051 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.
2081 2082 2083 2084 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2081 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.
2126 2127 2128 2129 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2126 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.
2157 2158 2159 2160 |
# File 'gems/aws-sdk-devopsguru/lib/aws-sdk-devopsguru/client.rb', line 2157 def update_service_integration(params = {}, = {}) req = build_request(:update_service_integration, params) req.send_request() end |