lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.13.0 vs lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.14.0

- old
+ new

@@ -197,10 +197,53 @@ # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # + # @option options [URI::HTTP,String] :http_proxy A proxy to send + # requests through. Formatted like 'http://proxy.com:123'. + # + # @option options [Float] :http_open_timeout (15) The number of + # seconds to wait when opening a HTTP session before rasing a + # `Timeout::Error`. + # + # @option options [Integer] :http_read_timeout (60) The default + # number of seconds to wait for response data. This value can + # safely be set + # per-request on the session yeidled by {#session_for}. + # + # @option options [Float] :http_idle_timeout (5) The number of + # seconds a connection is allowed to sit idble before it is + # considered stale. Stale connections are closed and removed + # from the pool before making a request. + # + # @option options [Float] :http_continue_timeout (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 yeidled by {#session_for}. + # + # @option options [Boolean] :http_wire_trace (false) When `true`, + # HTTP debug output will be sent to the `:logger`. + # + # @option options [Boolean] :ssl_verify_peer (true) When `true`, + # SSL peer certificates are verified when establishing a + # connection. + # + # @option options [String] :ssl_ca_bundle 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. + # + # @option options [String] :ssl_ca_directory 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. + # def initialize(*args) super end # @!group API Operations @@ -744,10 +787,90 @@ def get_service_graph(params = {}, options = {}) req = build_request(:get_service_graph, params) req.send_request(options) end + # Get an aggregation of service statistics defined by a specific time + # range. + # + # @option params [required, Time,DateTime,Date,Integer,String] :start_time + # The start of the time frame for which to aggregate statistics. + # + # @option params [required, Time,DateTime,Date,Integer,String] :end_time + # The end of the time frame for which to aggregate statistics. + # + # @option params [String] :group_name + # The case-sensitive name of the group for which to pull statistics + # from. + # + # @option params [String] :group_arn + # The ARN of the group for which to pull statistics from. + # + # @option params [String] :entity_selector_expression + # A filter expression defining entities that will be aggregated for + # statistics. Supports ID, service, and edge functions. If no selector + # expression is specified, edge statistics are returned. + # + # @option params [Integer] :period + # Aggregation period in seconds. + # + # @option params [String] :next_token + # Pagination token. Not used. + # + # @return [Types::GetTimeSeriesServiceStatisticsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::GetTimeSeriesServiceStatisticsResult#time_series_service_statistics #time_series_service_statistics} => Array&lt;Types::TimeSeriesServiceStatistics&gt; + # * {Types::GetTimeSeriesServiceStatisticsResult#contains_old_group_versions #contains_old_group_versions} => Boolean + # * {Types::GetTimeSeriesServiceStatisticsResult#next_token #next_token} => String + # + # @example Request syntax with placeholder values + # + # resp = client.get_time_series_service_statistics({ + # start_time: Time.now, # required + # end_time: Time.now, # required + # group_name: "GroupName", + # group_arn: "GroupARN", + # entity_selector_expression: "EntitySelectorExpression", + # period: 1, + # next_token: "String", + # }) + # + # @example Response structure + # + # resp.time_series_service_statistics #=> Array + # resp.time_series_service_statistics[0].timestamp #=> Time + # resp.time_series_service_statistics[0].edge_summary_statistics.ok_count #=> Integer + # resp.time_series_service_statistics[0].edge_summary_statistics.error_statistics.throttle_count #=> Integer + # resp.time_series_service_statistics[0].edge_summary_statistics.error_statistics.other_count #=> Integer + # resp.time_series_service_statistics[0].edge_summary_statistics.error_statistics.total_count #=> Integer + # resp.time_series_service_statistics[0].edge_summary_statistics.fault_statistics.other_count #=> Integer + # resp.time_series_service_statistics[0].edge_summary_statistics.fault_statistics.total_count #=> Integer + # resp.time_series_service_statistics[0].edge_summary_statistics.total_count #=> Integer + # resp.time_series_service_statistics[0].edge_summary_statistics.total_response_time #=> Float + # resp.time_series_service_statistics[0].service_summary_statistics.ok_count #=> Integer + # resp.time_series_service_statistics[0].service_summary_statistics.error_statistics.throttle_count #=> Integer + # resp.time_series_service_statistics[0].service_summary_statistics.error_statistics.other_count #=> Integer + # 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].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 + # + # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTimeSeriesServiceStatistics AWS API Documentation + # + # @overload get_time_series_service_statistics(params = {}) + # @param [Hash] params ({}) + def get_time_series_service_statistics(params = {}, options = {}) + req = build_request(:get_time_series_service_statistics, params) + req.send_request(options) + end + # Retrieves a service graph for one or more specific trace IDs. # # @option params [required, Array<String>] :trace_ids # Trace IDs of requests for which to generate a service graph. # @@ -844,21 +967,29 @@ # filter expressions, see [Using Filter Expressions][1] in the *AWS # X-Ray Developer Guide*. # # # - # [1]: http://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html + # [1]: https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html # # @option params [required, Time,DateTime,Date,Integer,String] :start_time # The start of the time frame for which to retrieve traces. # # @option params [required, Time,DateTime,Date,Integer,String] :end_time # The end of the time frame for which to retrieve traces. # + # @option params [String] :time_range_type + # A parameter to indicate whether to query trace summaries by TraceId or + # Event time. + # # @option params [Boolean] :sampling # Set to `true` to get summaries for only a subset of available traces. # + # @option params [Types::SamplingStrategy] :sampling_strategy + # A paramater to indicate whether to enable sampling on trace summaries. + # Input parameters are Name and Value. + # # @option params [String] :filter_expression # Specify a filter expression to retrieve trace summaries for services # or requests that meet certain requirements. # # @option params [String] :next_token @@ -875,11 +1006,16 @@ # @example Request syntax with placeholder values # # resp = client.get_trace_summaries({ # start_time: Time.now, # required # end_time: Time.now, # required + # time_range_type: "TraceId", # accepts TraceId, Event # sampling: false, + # sampling_strategy: { + # name: "PartialScan", # accepts PartialScan, FixedRate + # value: 1.0, + # }, # filter_expression: "FilterExpression", # next_token: "String", # }) # # @example Response structure @@ -972,10 +1108,11 @@ # resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path[0].name #=> String # resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path[0].coverage #=> Float # resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path[0].remote #=> Boolean # resp.trace_summaries[0].response_time_root_causes[0].services[0].inferred #=> Boolean # resp.trace_summaries[0].revision #=> Integer + # resp.trace_summaries[0].matched_event_time #=> Time # resp.approximate_time #=> Time # resp.traces_processed_count #=> Integer # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSummaries AWS API Documentation @@ -1270,10 +1407,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-xray' - context[:gem_version] = '1.13.0' + context[:gem_version] = '1.14.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated