lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.33.0 vs lib/aws-sdk-xray/client.rb in aws-sdk-xray-1.34.0
- old
+ new
@@ -355,10 +355,11 @@
# @example Response structure
#
# resp.traces #=> Array
# resp.traces[0].id #=> String
# resp.traces[0].duration #=> Float
+ # resp.traces[0].limit_exceeded #=> Boolean
# resp.traces[0].segments #=> Array
# resp.traces[0].segments[0].id #=> String
# resp.traces[0].segments[0].document #=> String
# resp.unprocessed_trace_ids #=> Array
# resp.unprocessed_trace_ids[0] #=> String
@@ -381,14 +382,19 @@
#
# @option params [String] :filter_expression
# The filter expression defining criteria by which to group traces.
#
# @option params [Types::InsightsConfiguration] :insights_configuration
- # The structure containing configurations related to insights. The
- # InsightsEnabled boolean can be set to true to enable insights for the
- # new group or false to disable insights for the new group.
+ # The structure containing configurations related to insights.
#
+ # * The InsightsEnabled boolean can be set to true to enable insights
+ # for the new group or false to disable insights for the new group.
+ #
+ # * The NotifcationsEnabled boolean can be set to true to enable
+ # insights notifications for the new group. Notifications may only be
+ # enabled on a group with InsightsEnabled set to true.
+ #
# @option params [Array<Types::Tag>] :tags
# A map that contains one or more tag keys and tag values to attach to
# an X-Ray group. For more information about ways to use tags, see
# [Tagging AWS resources][1] in the *AWS General Reference*.
#
@@ -420,10 +426,11 @@
# resp = client.create_group({
# group_name: "GroupName", # required
# filter_expression: "FilterExpression",
# insights_configuration: {
# insights_enabled: false,
+ # notifications_enabled: false,
# },
# tags: [
# {
# key: "TagKey", # required
# value: "TagValue", # required
@@ -435,10 +442,11 @@
#
# resp.group.group_name #=> String
# resp.group.group_arn #=> String
# resp.group.filter_expression #=> String
# resp.group.insights_configuration.insights_enabled #=> Boolean
+ # resp.group.insights_configuration.notifications_enabled #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/CreateGroup AWS API Documentation
#
# @overload create_group(params = {})
# @param [Hash] params ({})
@@ -662,10 +670,11 @@
#
# resp.group.group_name #=> String
# resp.group.group_arn #=> String
# resp.group.filter_expression #=> String
# resp.group.insights_configuration.insights_enabled #=> Boolean
+ # resp.group.insights_configuration.notifications_enabled #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroup AWS API Documentation
#
# @overload get_group(params = {})
# @param [Hash] params ({})
@@ -697,10 +706,11 @@
# resp.groups #=> Array
# resp.groups[0].group_name #=> String
# resp.groups[0].group_arn #=> String
# resp.groups[0].filter_expression #=> String
# resp.groups[0].insights_configuration.insights_enabled #=> Boolean
+ # resp.groups[0].insights_configuration.notifications_enabled #=> Boolean
# resp.next_token #=> String
#
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroups AWS API Documentation
#
# @overload get_groups(params = {})
@@ -862,14 +872,15 @@
#
# @option params [required, Time,DateTime,Date,Integer,String] :end_time
# The end of the timeframe for which to generate a graph.
#
# @option params [String] :group_name
- # The name of a group to generate a graph based on.
+ # The name of a group based on which you want to generate a graph.
#
# @option params [String] :group_arn
- # The ARN of a group to generate a graph based on.
+ # The Amazon Resource Name (ARN) of a group based on which you want to
+ # generate a graph.
#
# @option params [String] :next_token
# Pagination token.
#
# @return [Types::GetServiceGraphResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -965,11 +976,12 @@
# @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.
+ # The Amazon Resource Name (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.
@@ -1151,11 +1163,11 @@
#
# @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.
+ # A parameter 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.
@@ -1437,11 +1449,11 @@
#
# Segments must include the following fields. For the full segment
# document schema, see [AWS X-Ray Segment Documents][2] in the *AWS
# X-Ray Developer Guide*.
#
- # **Required Segment Document Fields**
+ # **Required segment document fields**
#
# * `name` - The name of the service that handled the request.
#
# * `id` - A 64-bit identifier for the segment, unique among segments in
# the same trace, in 16 hexadecimal digits.
@@ -1457,21 +1469,21 @@
# `1480615200.090` or `1.480615200090E9`. Specify either an `end_time`
# or `in_progress`.
#
# * `in_progress` - Set to `true` instead of specifying an `end_time` to
# record that a segment has been started, but is not complete. Send an
- # in progress segment when your application receives a request that
- # will take a long time to serve, to trace the fact that the request
- # was received. When the response is sent, send the complete segment
- # to overwrite the in-progress segment.
+ # in-progress segment when your application receives a request that
+ # will take a long time to serve, to trace that the request was
+ # received. When the response is sent, send the complete segment to
+ # overwrite the in-progress segment.
#
# A `trace_id` consists of three numbers separated by hyphens. For
# example, 1-58406520-a006649127e371903a2de979. This includes:
#
# **Trace ID Format**
#
- # * The version number, i.e. `1`.
+ # * The version number, for instance, `1`.
#
# * The time of the original request, in Unix epoch time, in 8
# hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in
# epoch time is `1480615200` seconds, or `58406520` in hexadecimal.
#
@@ -1606,14 +1618,19 @@
# @option params [String] :filter_expression
# The updated filter expression defining criteria by which to group
# traces.
#
# @option params [Types::InsightsConfiguration] :insights_configuration
- # The structure containing configurations related to insights. The
- # InsightsEnabled boolean can be set to true to enable insights for the
- # group or false to disable insights for the group.
+ # The structure containing configurations related to insights.
#
+ # * The InsightsEnabled boolean can be set to true to enable insights
+ # for the group or false to disable insights for the group.
+ #
+ # * The NotifcationsEnabled boolean can be set to true to enable
+ # insights notifications for the group. Notifications can only be
+ # enabled on a group with InsightsEnabled set to true.
+ #
# @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
@@ -1622,19 +1639,21 @@
# group_name: "GroupName",
# group_arn: "GroupARN",
# filter_expression: "FilterExpression",
# insights_configuration: {
# insights_enabled: false,
+ # notifications_enabled: false,
# },
# })
#
# @example Response structure
#
# resp.group.group_name #=> String
# resp.group.group_arn #=> String
# resp.group.filter_expression #=> String
# resp.group.insights_configuration.insights_enabled #=> Boolean
+ # resp.group.insights_configuration.notifications_enabled #=> Boolean
#
# @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UpdateGroup AWS API Documentation
#
# @overload update_group(params = {})
# @param [Hash] params ({})
@@ -1712,10 +1731,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-xray'
- context[:gem_version] = '1.33.0'
+ context[:gem_version] = '1.34.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated