lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.34.0 vs lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.35.0

- old
+ new

@@ -718,10 +718,281 @@ def get_groups(params = {}, options = {}) req = build_request(:get_groups, params) req.send_request(options) end + # Retrieves the summary information of an insight. This includes impact + # to clients and root cause services, the top anomalous services, the + # category, the state of the insight, and the start and end time of the + # insight. + # + # @option params [required, String] :insight_id + # The insight's unique identifier. Use the GetInsightSummaries action + # to retrieve an InsightId. + # + # @return [Types::GetInsightResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetInsightResult#insight #insight} => Types::Insight + # + # @example Request syntax with placeholder values + # + # resp = client.get_insight({ + # insight_id: "InsightId", # required + # }) + # + # @example Response structure + # + # resp.insight.insight_id #=> String + # resp.insight.group_arn #=> String + # resp.insight.group_name #=> String + # resp.insight.root_cause_service_id.name #=> String + # resp.insight.root_cause_service_id.names #=> Array + # resp.insight.root_cause_service_id.names[0] #=> String + # resp.insight.root_cause_service_id.account_id #=> String + # resp.insight.root_cause_service_id.type #=> String + # resp.insight.categories #=> Array + # resp.insight.categories[0] #=> String, one of "FAULT" + # resp.insight.state #=> String, one of "ACTIVE", "CLOSED" + # resp.insight.start_time #=> Time + # resp.insight.end_time #=> Time + # resp.insight.summary #=> String + # resp.insight.client_request_impact_statistics.fault_count #=> Integer + # resp.insight.client_request_impact_statistics.ok_count #=> Integer + # resp.insight.client_request_impact_statistics.total_count #=> Integer + # resp.insight.root_cause_service_request_impact_statistics.fault_count #=> Integer + # resp.insight.root_cause_service_request_impact_statistics.ok_count #=> Integer + # resp.insight.root_cause_service_request_impact_statistics.total_count #=> Integer + # resp.insight.top_anomalous_services #=> Array + # resp.insight.top_anomalous_services[0].service_id.name #=> String + # resp.insight.top_anomalous_services[0].service_id.names #=> Array + # resp.insight.top_anomalous_services[0].service_id.names[0] #=> String + # resp.insight.top_anomalous_services[0].service_id.account_id #=> String + # resp.insight.top_anomalous_services[0].service_id.type #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsight AWS API Documentation + # + # @overload get_insight(params = {}) + # @param [Hash] params ({}) + def get_insight(params = {}, options = {}) + req = build_request(:get_insight, params) + req.send_request(options) + end + + # X-Ray reevaluates insights periodically until they're resolved, and + # records each intermediate state as an event. You can review an + # insight's events in the Impact Timeline on the Inspect page in the + # X-Ray console. + # + # @option params [required, String] :insight_id + # The insight's unique identifier. Use the GetInsightSummaries action + # to retrieve an InsightId. + # + # @option params [Integer] :max_results + # Used to retrieve at most the specified value of events. + # + # @option params [String] :next_token + # Specify the pagination token returned by a previous request to + # retrieve the next page of events. + # + # @return [Types::GetInsightEventsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetInsightEventsResult#insight_events #insight_events} => Array&lt;Types::InsightEvent&gt; + # * {Types::GetInsightEventsResult#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.get_insight_events({ + # insight_id: "InsightId", # required + # max_results: 1, + # next_token: "Token", + # }) + # + # @example Response structure + # + # resp.insight_events #=> Array + # resp.insight_events[0].summary #=> String + # resp.insight_events[0].event_time #=> Time + # resp.insight_events[0].client_request_impact_statistics.fault_count #=> Integer + # resp.insight_events[0].client_request_impact_statistics.ok_count #=> Integer + # resp.insight_events[0].client_request_impact_statistics.total_count #=> Integer + # resp.insight_events[0].root_cause_service_request_impact_statistics.fault_count #=> Integer + # resp.insight_events[0].root_cause_service_request_impact_statistics.ok_count #=> Integer + # resp.insight_events[0].root_cause_service_request_impact_statistics.total_count #=> Integer + # resp.insight_events[0].top_anomalous_services #=> Array + # resp.insight_events[0].top_anomalous_services[0].service_id.name #=> String + # resp.insight_events[0].top_anomalous_services[0].service_id.names #=> Array + # resp.insight_events[0].top_anomalous_services[0].service_id.names[0] #=> String + # resp.insight_events[0].top_anomalous_services[0].service_id.account_id #=> String + # resp.insight_events[0].top_anomalous_services[0].service_id.type #=> String + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightEvents AWS API Documentation + # + # @overload get_insight_events(params = {}) + # @param [Hash] params ({}) + def get_insight_events(params = {}, options = {}) + req = build_request(:get_insight_events, params) + req.send_request(options) + end + + # Retrieves a service graph structure filtered by the specified insight. + # The service graph is limited to only structural information. For a + # complete service graph, use this API with the GetServiceGraph API. + # + # @option params [required, String] :insight_id + # The insight's unique identifier. Use the GetInsightSummaries action + # to retrieve an InsightId. + # + # @option params [required, Time,DateTime,Date,Integer,String] :start_time + # The estimated start time of the insight, in Unix time seconds. The + # StartTime is inclusive of the value provided and can't be more than + # 30 days old. + # + # @option params [required, Time,DateTime,Date,Integer,String] :end_time + # The estimated end time of the insight, in Unix time seconds. The + # EndTime is exclusive of the value provided. The time range between the + # start time and end time can't be more than six hours. + # + # @option params [String] :next_token + # Specify the pagination token returned by a previous request to + # retrieve the next page of results. + # + # @return [Types::GetInsightImpactGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetInsightImpactGraphResult#insight_id #insight_id} => String + # * {Types::GetInsightImpactGraphResult#start_time #start_time} => Time + # * {Types::GetInsightImpactGraphResult#end_time #end_time} => Time + # * {Types::GetInsightImpactGraphResult#service_graph_start_time #service_graph_start_time} => Time + # * {Types::GetInsightImpactGraphResult#service_graph_end_time #service_graph_end_time} => Time + # * {Types::GetInsightImpactGraphResult#services #services} => Array&lt;Types::InsightImpactGraphService&gt; + # * {Types::GetInsightImpactGraphResult#next_token #next_token} => String + # + # @example Request syntax with placeholder values + # + # resp = client.get_insight_impact_graph({ + # insight_id: "InsightId", # required + # start_time: Time.now, # required + # end_time: Time.now, # required + # next_token: "Token", + # }) + # + # @example Response structure + # + # resp.insight_id #=> String + # resp.start_time #=> Time + # resp.end_time #=> Time + # resp.service_graph_start_time #=> Time + # resp.service_graph_end_time #=> Time + # resp.services #=> Array + # resp.services[0].reference_id #=> Integer + # resp.services[0].type #=> String + # resp.services[0].name #=> String + # resp.services[0].names #=> Array + # resp.services[0].names[0] #=> String + # resp.services[0].account_id #=> String + # resp.services[0].edges #=> Array + # resp.services[0].edges[0].reference_id #=> Integer + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightImpactGraph AWS API Documentation + # + # @overload get_insight_impact_graph(params = {}) + # @param [Hash] params ({}) + def get_insight_impact_graph(params = {}, options = {}) + req = build_request(:get_insight_impact_graph, params) + req.send_request(options) + end + + # Retrieves the summaries of all insights in the specified group + # matching the provided filter values. + # + # @option params [Array<String>] :states + # The list of insight states. + # + # @option params [String] :group_arn + # The Amazon Resource Name (ARN) of the group. Required if the GroupName + # isn't provided. + # + # @option params [String] :group_name + # The name of the group. Required if the GroupARN isn't provided. + # + # @option params [required, Time,DateTime,Date,Integer,String] :start_time + # The beginning of the time frame in which the insights started. The + # start time can't be more than 30 days old. + # + # @option params [required, Time,DateTime,Date,Integer,String] :end_time + # The end of the time frame in which the insights ended. The end time + # can't be more than 30 days old. + # + # @option params [Integer] :max_results + # The maximum number of results to display. + # + # @option params [String] :next_token + # Pagination token. + # + # @return [Types::GetInsightSummariesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetInsightSummariesResult#insight_summaries #insight_summaries} => Array&lt;Types::InsightSummary&gt; + # * {Types::GetInsightSummariesResult#next_token #next_token} => String + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.get_insight_summaries({ + # states: ["ACTIVE"], # accepts ACTIVE, CLOSED + # group_arn: "GroupARN", + # group_name: "GroupName", + # start_time: Time.now, # required + # end_time: Time.now, # required + # max_results: 1, + # next_token: "Token", + # }) + # + # @example Response structure + # + # resp.insight_summaries #=> Array + # resp.insight_summaries[0].insight_id #=> String + # resp.insight_summaries[0].group_arn #=> String + # resp.insight_summaries[0].group_name #=> String + # resp.insight_summaries[0].root_cause_service_id.name #=> String + # resp.insight_summaries[0].root_cause_service_id.names #=> Array + # resp.insight_summaries[0].root_cause_service_id.names[0] #=> String + # resp.insight_summaries[0].root_cause_service_id.account_id #=> String + # resp.insight_summaries[0].root_cause_service_id.type #=> String + # resp.insight_summaries[0].categories #=> Array + # resp.insight_summaries[0].categories[0] #=> String, one of "FAULT" + # resp.insight_summaries[0].state #=> String, one of "ACTIVE", "CLOSED" + # resp.insight_summaries[0].start_time #=> Time + # resp.insight_summaries[0].end_time #=> Time + # resp.insight_summaries[0].summary #=> String + # resp.insight_summaries[0].client_request_impact_statistics.fault_count #=> Integer + # resp.insight_summaries[0].client_request_impact_statistics.ok_count #=> Integer + # resp.insight_summaries[0].client_request_impact_statistics.total_count #=> Integer + # resp.insight_summaries[0].root_cause_service_request_impact_statistics.fault_count #=> Integer + # resp.insight_summaries[0].root_cause_service_request_impact_statistics.ok_count #=> Integer + # resp.insight_summaries[0].root_cause_service_request_impact_statistics.total_count #=> Integer + # resp.insight_summaries[0].top_anomalous_services #=> Array + # resp.insight_summaries[0].top_anomalous_services[0].service_id.name #=> String + # resp.insight_summaries[0].top_anomalous_services[0].service_id.names #=> Array + # resp.insight_summaries[0].top_anomalous_services[0].service_id.names[0] #=> String + # resp.insight_summaries[0].top_anomalous_services[0].service_id.account_id #=> String + # resp.insight_summaries[0].top_anomalous_services[0].service_id.type #=> String + # resp.insight_summaries[0].last_update_time #=> Time + # resp.next_token #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetInsightSummaries AWS API Documentation + # + # @overload get_insight_summaries(params = {}) + # @param [Hash] params ({}) + def get_insight_summaries(params = {}, options = {}) + req = build_request(:get_insight_summaries, params) + req.send_request(options) + end + # Retrieves all sampling rules. # # @option params [String] :next_token # Pagination token. # @@ -987,10 +1258,14 @@ # expression is specified, edge statistics are returned. # # @option params [Integer] :period # Aggregation period in seconds. # + # @option params [Boolean] :forecast_statistics + # The forecasted high and low fault count values. Forecast enabled + # requests require the EntitySelectorExpression ID be provided. + # # @option params [String] :next_token # Pagination token. # # @return [Types::GetTimeSeriesServiceStatisticsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1007,10 +1282,11 @@ # end_time: Time.now, # required # group_name: "GroupName", # group_arn: "GroupARN", # entity_selector_expression: "EntitySelectorExpression", # period: 1, + # forecast_statistics: false, # next_token: "String", # }) # # @example Response structure # @@ -1030,10 +1306,12 @@ # resp.time_series_service_statistics[0].service_summary_statistics.error_statistics.total_count #=> Integer # resp.time_series_service_statistics[0].service_summary_statistics.fault_statistics.other_count #=> Integer # resp.time_series_service_statistics[0].service_summary_statistics.fault_statistics.total_count #=> Integer # resp.time_series_service_statistics[0].service_summary_statistics.total_count #=> Integer # resp.time_series_service_statistics[0].service_summary_statistics.total_response_time #=> Float + # resp.time_series_service_statistics[0].service_forecast_statistics.fault_count_high #=> Integer + # resp.time_series_service_statistics[0].service_forecast_statistics.fault_count_low #=> Integer # resp.time_series_service_statistics[0].response_time_histogram #=> Array # resp.time_series_service_statistics[0].response_time_histogram[0].value #=> Float # resp.time_series_service_statistics[0].response_time_histogram[0].count #=> Integer # resp.contains_old_group_versions #=> Boolean # resp.next_token #=> String @@ -1731,10 +2009,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-xray' - context[:gem_version] = '1.34.0' + context[:gem_version] = '1.35.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated