lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.23.0 vs lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.24.0

- old
+ new

@@ -30,15 +30,15 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:xray) module Aws::XRay # An API client for XRay. To construct a client, you need to configure a `:region` and `:credentials`. # - # client = Aws::XRay::Client.new( - # region: region_name, - # credentials: credentials, - # # ... - # ) + # client = Aws::XRay::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. @@ -227,20 +227,24 @@ # used by the default backoff function. This option is only used in the # `legacy` retry mode. # # @option options [String] :retry_mode ("legacy") # Specifies which retry algorithm to use. Values are: - # * `legacy` - The pre-existing retry behavior. This is default value if - # no retry mode is provided. - # * `standard` - A standardized set of retry rules across the AWS SDKs. - # This includes support for retry quotas, which limit the number of - # unsuccessful retries a client can make. - # * `adaptive` - An experimental retry mode that includes all the - # functionality of `standard` mode along with automatic client side - # throttling. This is a provisional mode that may change behavior - # in the future. # + # * `legacy` - The pre-existing retry behavior. This is default value if + # no retry mode is provided. + # + # * `standard` - A standardized set of retry rules across the AWS SDKs. + # This includes support for retry quotas, which limit the number of + # unsuccessful retries a client can make. + # + # * `adaptive` - An experimental retry mode that includes all the + # functionality of `standard` mode along with automatic client side + # throttling. This is a provisional mode that may change behavior + # in the future. + # + # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :stub_responses (false) @@ -263,12 +267,11 @@ # seconds to wait when opening a HTTP session before raising 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 yielded by {#session_for}. + # safely be set per-request on the session. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idle before it is # considered stale. Stale connections are closed and removed # from the pool before making a request. @@ -276,11 +279,11 @@ # @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 yielded by {#session_for}. + # request on the session. # # @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`, @@ -319,10 +322,12 @@ # # * {Types::BatchGetTracesResult#traces #traces} => Array<Types::Trace> # * {Types::BatchGetTracesResult#unprocessed_trace_ids #unprocessed_trace_ids} => Array<String> # * {Types::BatchGetTracesResult#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.batch_get_traces({ # trace_ids: ["TraceId"], # required # next_token: "String", @@ -588,10 +593,12 @@ # @return [Types::GetGroupsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetGroupsResult#groups #groups} => Array<Types::GroupSummary> # * {Types::GetGroupsResult#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_groups({ # next_token: "GetGroupsNextToken", # }) @@ -621,10 +628,12 @@ # @return [Types::GetSamplingRulesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetSamplingRulesResult#sampling_rule_records #sampling_rule_records} => Array<Types::SamplingRuleRecord> # * {Types::GetSamplingRulesResult#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_sampling_rules({ # next_token: "String", # }) @@ -668,10 +677,12 @@ # @return [Types::GetSamplingStatisticSummariesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetSamplingStatisticSummariesResult#sampling_statistic_summaries #sampling_statistic_summaries} => Array<Types::SamplingStatisticSummary> # * {Types::GetSamplingStatisticSummariesResult#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_sampling_statistic_summaries({ # next_token: "String", # }) @@ -777,10 +788,12 @@ # * {Types::GetServiceGraphResult#end_time #end_time} => Time # * {Types::GetServiceGraphResult#services #services} => Array<Types::Service> # * {Types::GetServiceGraphResult#contains_old_group_versions #contains_old_group_versions} => Boolean # * {Types::GetServiceGraphResult#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_service_graph({ # start_time: Time.now, # required # end_time: Time.now, # required @@ -881,10 +894,12 @@ # # * {Types::GetTimeSeriesServiceStatisticsResult#time_series_service_statistics #time_series_service_statistics} => Array<Types::TimeSeriesServiceStatistics> # * {Types::GetTimeSeriesServiceStatisticsResult#contains_old_group_versions #contains_old_group_versions} => Boolean # * {Types::GetTimeSeriesServiceStatisticsResult#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_time_series_service_statistics({ # start_time: Time.now, # required # end_time: Time.now, # required @@ -941,10 +956,12 @@ # @return [Types::GetTraceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetTraceGraphResult#services #services} => Array<Types::Service> # * {Types::GetTraceGraphResult#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_trace_graph({ # trace_ids: ["TraceId"], # required # next_token: "String", @@ -1062,10 +1079,12 @@ # * {Types::GetTraceSummariesResult#trace_summaries #trace_summaries} => Array<Types::TraceSummary> # * {Types::GetTraceSummariesResult#approximate_time #approximate_time} => Time # * {Types::GetTraceSummariesResult#traces_processed_count #traces_processed_count} => Integer # * {Types::GetTraceSummariesResult#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_trace_summaries({ # start_time: Time.now, # required # end_time: Time.now, # required @@ -1142,10 +1161,11 @@ # resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].exceptions #=> Array # resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].exceptions[0].name #=> String # resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].exceptions[0].message #=> String # resp.trace_summaries[0].fault_root_causes[0].services[0].entity_path[0].remote #=> Boolean # resp.trace_summaries[0].fault_root_causes[0].services[0].inferred #=> Boolean + # resp.trace_summaries[0].fault_root_causes[0].client_impacting #=> Boolean # resp.trace_summaries[0].error_root_causes #=> Array # resp.trace_summaries[0].error_root_causes[0].services #=> Array # resp.trace_summaries[0].error_root_causes[0].services[0].name #=> String # resp.trace_summaries[0].error_root_causes[0].services[0].names #=> Array # resp.trace_summaries[0].error_root_causes[0].services[0].names[0] #=> String @@ -1156,10 +1176,11 @@ # resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].exceptions #=> Array # resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].exceptions[0].name #=> String # resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].exceptions[0].message #=> String # resp.trace_summaries[0].error_root_causes[0].services[0].entity_path[0].remote #=> Boolean # resp.trace_summaries[0].error_root_causes[0].services[0].inferred #=> Boolean + # resp.trace_summaries[0].error_root_causes[0].client_impacting #=> Boolean # resp.trace_summaries[0].response_time_root_causes #=> Array # resp.trace_summaries[0].response_time_root_causes[0].services #=> Array # resp.trace_summaries[0].response_time_root_causes[0].services[0].name #=> String # resp.trace_summaries[0].response_time_root_causes[0].services[0].names #=> Array # resp.trace_summaries[0].response_time_root_causes[0].services[0].names[0] #=> String @@ -1168,10 +1189,11 @@ # resp.trace_summaries[0].response_time_root_causes[0].services[0].entity_path #=> Array # 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].response_time_root_causes[0].client_impacting #=> 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 @@ -1470,10 +1492,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-xray' - context[:gem_version] = '1.23.0' + context[:gem_version] = '1.24.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated