lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.8.0 vs lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.9.0
- old
+ new
@@ -13,10 +13,12 @@
require 'aws-sdk-core/plugins/user_agent.rb'
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
require 'aws-sdk-core/plugins/retry_errors.rb'
require 'aws-sdk-core/plugins/global_configuration.rb'
require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/endpoint_discovery.rb'
+require 'aws-sdk-core/plugins/endpoint_pattern.rb'
require 'aws-sdk-core/plugins/response_paging.rb'
require 'aws-sdk-core/plugins/stub_responses.rb'
require 'aws-sdk-core/plugins/idempotency_token.rb'
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
@@ -43,10 +45,12 @@
add_plugin(Aws::Plugins::UserAgent)
add_plugin(Aws::Plugins::HelpfulSocketErrors)
add_plugin(Aws::Plugins::RetryErrors)
add_plugin(Aws::Plugins::GlobalConfiguration)
add_plugin(Aws::Plugins::RegionalEndpoint)
+ add_plugin(Aws::Plugins::EndpointDiscovery)
+ add_plugin(Aws::Plugins::EndpointPattern)
add_plugin(Aws::Plugins::ResponsePaging)
add_plugin(Aws::Plugins::StubResponses)
add_plugin(Aws::Plugins::IdempotencyToken)
add_plugin(Aws::Plugins::JsonvalueConverter)
add_plugin(Aws::Plugins::ClientMetricsPlugin)
@@ -96,10 +100,14 @@
# * `~/.aws/credentials`
# * `~/.aws/config`
#
# @option options [String] :access_key_id
#
+ # @option options [Boolean] :active_endpoint_cache (false)
+ # When set to `true`, a thread polling for endpoints will be running in
+ # the background every 60 secs (default). Defaults to `false`.
+ #
# @option options [Boolean] :client_side_monitoring (false)
# When `true`, client-side metrics will be collected for all API requests from
# this client.
#
# @option options [String] :client_side_monitoring_client_id ("")
@@ -116,15 +124,34 @@
#
# @option options [Boolean] :convert_params (true)
# When `true`, an attempt is made to coerce request parameters into
# the required types.
#
+ # @option options [Boolean] :disable_host_prefix_injection (false)
+ # Set to true to disable SDK automatically adding host prefix
+ # to default service endpoint when available.
+ #
# @option options [String] :endpoint
# The client endpoint is normally constructed from the `:region`
# option. You should only configure an `:endpoint` when connecting
# to test endpoints. This should be avalid HTTP(S) URI.
#
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
+ # Used for the maximum size limit of the LRU cache storing endpoints data
+ # for endpoint discovery enabled operations. Defaults to 1000.
+ #
+ # @option options [Integer] :endpoint_cache_max_threads (10)
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
+ #
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
+ # Use this option to config the time interval in seconds for making
+ # requests fetching endpoints information. Defaults to 60 sec.
+ #
+ # @option options [Boolean] :endpoint_discovery (false)
+ # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+ #
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
# The log formatter.
#
# @option options [Symbol] :log_level (:info)
# The log level to send messages to the `:logger` at.
@@ -220,10 +247,45 @@
def batch_get_traces(params = {}, options = {})
req = build_request(:batch_get_traces, params)
req.send_request(options)
end
+ # Creates a group resource with a name and a filter expression.
+ #
+ # @option params [required, String] :group_name
+ # The case-sensitive name of the new group. Default is a reserved name
+ # and names must be unique.
+ #
+ # @option params [String] :filter_expression
+ # The filter expression defining criteria by which to group traces.
+ #
+ # @return [Types::CreateGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::CreateGroupResult#group #group} => Types::Group
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.create_group({
+ # group_name: "GroupName", # required
+ # filter_expression: "FilterExpression",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.group.group_name #=> String
+ # resp.group.group_arn #=> String
+ # resp.group.filter_expression #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/CreateGroup AWS API Documentation
+ #
+ # @overload create_group(params = {})
+ # @param [Hash] params ({})
+ def create_group(params = {}, options = {})
+ req = build_request(:create_group, params)
+ req.send_request(options)
+ end
+
# Creates a rule to control sampling behavior for instrumented
# applications. Services retrieve rules with GetSamplingRules, and
# evaluate each rule in ascending order of *priority* for each request.
# If a rule matches, the service records a trace, borrowing it from the
# reservoir size. After 10 seconds, the service reports back to X-Ray
@@ -286,10 +348,36 @@
def create_sampling_rule(params = {}, options = {})
req = build_request(:create_sampling_rule, params)
req.send_request(options)
end
+ # Deletes a group resource.
+ #
+ # @option params [String] :group_name
+ # The case-sensitive name of the group.
+ #
+ # @option params [String] :group_arn
+ # The ARN of the group that was generated on creation.
+ #
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.delete_group({
+ # group_name: "GroupName",
+ # group_arn: "GroupARN",
+ # })
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/DeleteGroup AWS API Documentation
+ #
+ # @overload delete_group(params = {})
+ # @param [Hash] params ({})
+ def delete_group(params = {}, options = {})
+ req = build_request(:delete_group, params)
+ req.send_request(options)
+ end
+
# Deletes a sampling rule.
#
# @option params [String] :rule_name
# The name of the sampling rule. Specify a rule by either name or ARN,
# but not both.
@@ -356,10 +444,77 @@
def get_encryption_config(params = {}, options = {})
req = build_request(:get_encryption_config, params)
req.send_request(options)
end
+ # Retrieves group resource details.
+ #
+ # @option params [String] :group_name
+ # The case-sensitive name of the group.
+ #
+ # @option params [String] :group_arn
+ # The ARN of the group that was generated on creation.
+ #
+ # @return [Types::GetGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::GetGroupResult#group #group} => Types::Group
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.get_group({
+ # group_name: "GroupName",
+ # group_arn: "GroupARN",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.group.group_name #=> String
+ # resp.group.group_arn #=> String
+ # resp.group.filter_expression #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroup AWS API Documentation
+ #
+ # @overload get_group(params = {})
+ # @param [Hash] params ({})
+ def get_group(params = {}, options = {})
+ req = build_request(:get_group, params)
+ req.send_request(options)
+ end
+
+ # Retrieves all active group details.
+ #
+ # @option params [String] :next_token
+ # Pagination token. Not used.
+ #
+ # @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
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.get_groups({
+ # next_token: "GetGroupsNextToken",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.groups #=> Array
+ # resp.groups[0].group_name #=> String
+ # resp.groups[0].group_arn #=> String
+ # resp.groups[0].filter_expression #=> String
+ # resp.next_token #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroups AWS API Documentation
+ #
+ # @overload get_groups(params = {})
+ # @param [Hash] params ({})
+ def get_groups(params = {}, options = {})
+ req = build_request(:get_groups, params)
+ req.send_request(options)
+ end
+
# Retrieves all sampling rules.
#
# @option params [String] :next_token
# Pagination token. Not used.
#
@@ -501,25 +656,34 @@
# The start of the time frame for which to generate a graph.
#
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
# The end of the time frame for which to generate a graph.
#
+ # @option params [String] :group_name
+ # The name of a group to generate a graph based on.
+ #
+ # @option params [String] :group_arn
+ # The ARN of a group to generate a graph based on.
+ #
# @option params [String] :next_token
# Pagination token. Not used.
#
# @return [Types::GetServiceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::GetServiceGraphResult#start_time #start_time} => Time
# * {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
#
# @example Request syntax with placeholder values
#
# resp = client.get_service_graph({
# start_time: Time.now, # required
# end_time: Time.now, # required
+ # group_name: "GroupName",
+ # group_arn: "GroupARN",
# next_token: "String",
# })
#
# @example Response structure
#
@@ -568,10 +732,11 @@
# resp.services[0].duration_histogram[0].value #=> Float
# resp.services[0].duration_histogram[0].count #=> Integer
# resp.services[0].response_time_histogram #=> Array
# resp.services[0].response_time_histogram[0].value #=> Float
# resp.services[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/GetServiceGraph AWS API Documentation
#
# @overload get_service_graph(params = {})
@@ -943,10 +1108,49 @@
def put_trace_segments(params = {}, options = {})
req = build_request(:put_trace_segments, params)
req.send_request(options)
end
+ # Updates a group resource.
+ #
+ # @option params [String] :group_name
+ # The case-sensitive name of the group.
+ #
+ # @option params [String] :group_arn
+ # The ARN that was generated upon create.
+ #
+ # @option params [String] :filter_expression
+ # The updated filter expression defining criteria by which to group
+ # traces.
+ #
+ # @return [Types::UpdateGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+ #
+ # * {Types::UpdateGroupResult#group #group} => Types::Group
+ #
+ # @example Request syntax with placeholder values
+ #
+ # resp = client.update_group({
+ # group_name: "GroupName",
+ # group_arn: "GroupARN",
+ # filter_expression: "FilterExpression",
+ # })
+ #
+ # @example Response structure
+ #
+ # resp.group.group_name #=> String
+ # resp.group.group_arn #=> String
+ # resp.group.filter_expression #=> String
+ #
+ # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UpdateGroup AWS API Documentation
+ #
+ # @overload update_group(params = {})
+ # @param [Hash] params ({})
+ def update_group(params = {}, options = {})
+ req = build_request(:update_group, params)
+ req.send_request(options)
+ end
+
# Modifies a sampling rule's configuration.
#
# @option params [required, Types::SamplingRuleUpdate] :sampling_rule_update
# The rule and fields to change.
#
@@ -1014,10 +1218,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-xray'
- context[:gem_version] = '1.8.0'
+ context[:gem_version] = '1.9.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated