aws-sdk-xray 1.33.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ebba8f1051d572baf59542ca288fc9015455e459c71d356ee0dc494aa918cc7
-  data.tar.gz: 817588d72be2005e8f2e3952346d8edab5adb8699b2b47f50c012c88c2399355
+  metadata.gz: b4b6cfa688df8a7338ddba4e159d4e9e1cddc264d6b3221f1089d0b43991de20
+  data.tar.gz: 0e4239ba337f4417a819334279620c7db4a5db0f5368ccc24d53b03dc7ba3eb4
 SHA512:
-  metadata.gz: 894370f442dbf90dd2115dfadb7b67f4e445208f575a23f7c91c36a2056b5b09048ddadfda53c240a71f367d89ac4c297a9376e6f5c10a04300ac8344a22b9e8
-  data.tar.gz: 0ce607b4212224c2b47722c8026529aa5aa81bbdad057cd84acd80d689255230f616f3d6575b6a2f1fda9155d5f7f61c4e8a7aecfccf5c8d501ef1d96cdc4ce0
+  metadata.gz: f5b744df9fb0deb0c1b45d20e95bcd844f566737df6202b163f9217e67c6ef9bc419b4a832144958bc05f54e036e70797ac3bc8e5e03ffdf2fb4768bf89116ac
+  data.tar.gz: 405c78cfceaaece86e1187b97cb702d83b453eb6bb86f0b5d43986ec217709cba15331307cca4b87ec01a5558f25715e14c1c7d2fa2ac33a9f295945d9231444

data/lib/aws-sdk-xray.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-xray/customizations'
 # @!group service
 module Aws::XRay
 
-  GEM_VERSION = '1.33.0'
+  GEM_VERSION = '1.34.0'
 
 end

data/lib/aws-sdk-xray/client.rb

@@ -357,6 +357,7 @@ module Aws::XRay
     #   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
@@ -383,9 +384,14 @@ module Aws::XRay
     #   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
@@ -422,6 +428,7 @@ module Aws::XRay
     #     filter_expression: "FilterExpression",
     #     insights_configuration: {
     #       insights_enabled: false,
+    #       notifications_enabled: false,
     #     },
     #     tags: [
     #       {
@@ -437,6 +444,7 @@ module Aws::XRay
     #   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
     #
@@ -664,6 +672,7 @@ module Aws::XRay
     #   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
     #
@@ -699,6 +708,7 @@ module Aws::XRay
     #   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
@@ -864,10 +874,11 @@ module Aws::XRay
     #   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.
@@ -967,7 +978,8 @@ module Aws::XRay
     #   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
@@ -1153,7 +1165,7 @@ module Aws::XRay
     #   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
@@ -1439,7 +1451,7 @@ module Aws::XRay
     # 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.
     #
@@ -1459,17 +1471,17 @@ module Aws::XRay
     #
     # * `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
@@ -1608,9 +1620,14 @@ module Aws::XRay
     #   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:
     #
@@ -1624,6 +1641,7 @@ module Aws::XRay
     #     filter_expression: "FilterExpression",
     #     insights_configuration: {
     #       insights_enabled: false,
+    #       notifications_enabled: false,
     #     },
     #   })
     #
@@ -1633,6 +1651,7 @@ module Aws::XRay
     #   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
     #
@@ -1714,7 +1733,7 @@ module Aws::XRay
         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
 

data/lib/aws-sdk-xray/client_api.rb

@@ -465,6 +465,7 @@ module Aws::XRay
     Http.struct_class = Types::Http
 
     InsightsConfiguration.add_member(:insights_enabled, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "InsightsEnabled"))
+    InsightsConfiguration.add_member(:notifications_enabled, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "NotificationsEnabled"))
     InsightsConfiguration.struct_class = Types::InsightsConfiguration
 
     InstanceIdDetail.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "Id"))
@@ -690,6 +691,7 @@ module Aws::XRay
 
     Trace.add_member(:id, Shapes::ShapeRef.new(shape: TraceId, location_name: "Id"))
     Trace.add_member(:duration, Shapes::ShapeRef.new(shape: NullableDouble, location_name: "Duration"))
+    Trace.add_member(:limit_exceeded, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "LimitExceeded"))
     Trace.add_member(:segments, Shapes::ShapeRef.new(shape: SegmentList, location_name: "Segments"))
     Trace.struct_class = Types::Trace
 

data/lib/aws-sdk-xray/types.rb

@@ -35,7 +35,7 @@ module Aws::XRay
     end
 
     # Value of a segment annotation. Has one of three value types: Number,
-    # Boolean or String.
+    # Boolean, or String.
     #
     # @!attribute [rw] number_value
     #   Value for a Number annotation.
@@ -59,10 +59,10 @@ module Aws::XRay
       include Aws::Structure
     end
 
-    # A list of availability zones corresponding to the segments in a trace.
+    # A list of Availability Zones corresponding to the segments in a trace.
     #
     # @!attribute [rw] name
-    #   The name of a corresponding availability zone.
+    #   The name of a corresponding Availability Zone.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/AvailabilityZoneDetail AWS API Documentation
@@ -171,6 +171,7 @@ module Aws::XRay
     #         filter_expression: "FilterExpression",
     #         insights_configuration: {
     #           insights_enabled: false,
+    #           notifications_enabled: false,
     #         },
     #         tags: [
     #           {
@@ -190,9 +191,14 @@ module Aws::XRay
     #   @return [String]
     #
     # @!attribute [rw] 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.
     #   @return [Types::InsightsConfiguration]
     #
     # @!attribute [rw] tags
@@ -234,9 +240,9 @@ module Aws::XRay
 
     # @!attribute [rw] group
     #   The group that was created. Contains the name of the group that was
-    #   created, the ARN of the group that was generated based on the group
-    #   name, the filter expression, and the insight configuration that was
-    #   assigned to the group.
+    #   created, the Amazon Resource Name (ARN) of the group that was
+    #   generated based on the group name, the filter expression, and the
+    #   insight configuration that was assigned to the group.
     #   @return [Types::Group]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/CreateGroupResult AWS API Documentation
@@ -767,8 +773,8 @@ module Aws::XRay
 
     # @!attribute [rw] group
     #   The group that was requested. Contains the name of the group, the
-    #   ARN of the group, and the filter expression that assigned to the
-    #   group.
+    #   ARN of the group, the filter expression, and the insight
+    #   configuration assigned to the group.
     #   @return [Types::Group]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetGroupResult AWS API Documentation
@@ -963,11 +969,12 @@ module Aws::XRay
     #   @return [Time]
     #
     # @!attribute [rw] 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.
     #   @return [String]
     #
     # @!attribute [rw] 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.
     #   @return [String]
     #
     # @!attribute [rw] next_token
@@ -1048,7 +1055,8 @@ module Aws::XRay
     #   @return [String]
     #
     # @!attribute [rw] 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.
     #   @return [String]
     #
     # @!attribute [rw] entity_selector_expression
@@ -1085,7 +1093,7 @@ module Aws::XRay
     #
     # @!attribute [rw] contains_old_group_versions
     #   A flag indicating whether or not a group's filter expression has
-    #   been consistent, or if a returned aggregation may show statistics
+    #   been consistent, or if a returned aggregation might show statistics
     #   from an older version of the group's filter expression.
     #   @return [Boolean]
     #
@@ -1180,7 +1188,7 @@ module Aws::XRay
     #   @return [Boolean]
     #
     # @!attribute [rw] sampling_strategy
-    #   A paramater to indicate whether to enable sampling on trace
+    #   A parameter to indicate whether to enable sampling on trace
     #   summaries. Input parameters are Name and Value.
     #   @return [Types::SamplingStrategy]
     #
@@ -1225,8 +1233,8 @@ module Aws::XRay
     # @!attribute [rw] next_token
     #   If the requested time frame contained more than one page of results,
     #   you can use this token to retrieve the next page. The first page
-    #   contains the most most recent results, closest to the end of the
-    #   time frame.
+    #   contains the most recent results, closest to the end of the time
+    #   frame.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GetTraceSummariesResult AWS API Documentation
@@ -1247,7 +1255,8 @@ module Aws::XRay
     #   @return [String]
     #
     # @!attribute [rw] group_arn
-    #   The ARN of the group generated based on the GroupName.
+    #   The Amazon Resource Name (ARN) of the group generated based on the
+    #   GroupName.
     #   @return [String]
     #
     # @!attribute [rw] filter_expression
@@ -1255,9 +1264,13 @@ module Aws::XRay
     #   @return [String]
     #
     # @!attribute [rw] 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 through Amazon EventBridge for the group.
     #   @return [Types::InsightsConfiguration]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/Group AWS API Documentation
@@ -1286,9 +1299,14 @@ module Aws::XRay
     #   @return [String]
     #
     # @!attribute [rw] insights_configuration
-    #   The structure containing configurations related to insights. The
-    #   InsightsEnabled boolean can be set to true to enable insights for
-    #   the groups or false to disable insights for the groups.
+    #   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 NotificationsEnabled boolean can be set to true to enable
+    #     insights notifications. Notifications can only be enabled on a
+    #     group with InsightsEnabled set to true.
     #   @return [Types::InsightsConfiguration]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/GroupSummary AWS API Documentation
@@ -1364,6 +1382,7 @@ module Aws::XRay
     #
     #       {
     #         insights_enabled: false,
+    #         notifications_enabled: false,
     #       }
     #
     # @!attribute [rw] insights_enabled
@@ -1371,10 +1390,17 @@ module Aws::XRay
     #   disable insights.
     #   @return [Boolean]
     #
+    # @!attribute [rw] notifications_enabled
+    #   Set the NotificationsEnabled value to true to enable insights
+    #   notifications. Notifications can only be enabled on a group with
+    #   InsightsEnabled set to true.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/InsightsConfiguration AWS API Documentation
     #
     class InsightsConfiguration < Struct.new(
-      :insights_enabled)
+      :insights_enabled,
+      :notifications_enabled)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1604,8 +1630,8 @@ module Aws::XRay
       include Aws::Structure
     end
 
-    # The resource was not found. Verify that the name or ARN of the
-    # resource is correct.
+    # The resource was not found. Verify that the name or Amazon Resource
+    # Name (ARN) of the resource is correct.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -1650,7 +1676,7 @@ module Aws::XRay
     #   @return [String]
     #
     # @!attribute [rw] coverage
-    #   The types and messages of the exceptions.
+    #   The type and messages of the exceptions.
     #   @return [Float]
     #
     # @!attribute [rw] remote
@@ -1966,7 +1992,7 @@ module Aws::XRay
     end
 
     # Aggregated request sampling data for a sampling rule across all
-    # services for a 10 second window.
+    # services for a 10-second window.
     #
     # @!attribute [rw] rule_name
     #   The name of the sampling rule.
@@ -2095,7 +2121,8 @@ module Aws::XRay
     #   @return [Float]
     #
     # @!attribute [rw] reservoir_quota
-    #   The number of requests per second that X-Ray allocated this service.
+    #   The number of requests per second that X-Ray allocated for this
+    #   service.
     #   @return [Integer]
     #
     # @!attribute [rw] reservoir_quota_ttl
@@ -2149,8 +2176,8 @@ module Aws::XRay
     end
 
     # Information about an application that processed requests, users that
-    # made requests, or downstream services, resources and applications that
-    # an application used.
+    # made requests, or downstream services, resources, and applications
+    # that an application used.
     #
     # @!attribute [rw] reference_id
     #   Identifier for the service. Unique within the service map.
@@ -2177,7 +2204,7 @@ module Aws::XRay
     #   The type of service.
     #
     #   * AWS Resource - The type of an AWS resource. For example,
-    #     `AWS::EC2::Instance` for a application running on Amazon EC2 or
+    #     `AWS::EC2::Instance` for an application running on Amazon EC2 or
     #     `AWS::DynamoDB::Table` for an Amazon DynamoDB table that the
     #     application used.
     #
@@ -2526,6 +2553,16 @@ module Aws::XRay
     #   segment and the end time of the last segment that completed.
     #   @return [Float]
     #
+    # @!attribute [rw] limit_exceeded
+    #   LimitExceeded is set to true when the trace has exceeded one of the
+    #   defined quotas. For more information about quotas, see [AWS X-Ray
+    #   endpoints and quotas][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/xray.html
+    #   @return [Boolean]
+    #
     # @!attribute [rw] segments
     #   Segment documents for the segments and subsegments that comprise the
     #   trace.
@@ -2536,6 +2573,7 @@ module Aws::XRay
     class Trace < Struct.new(
       :id,
       :duration,
+      :limit_exceeded,
       :segments)
       SENSITIVE = []
       include Aws::Structure
@@ -2604,7 +2642,7 @@ module Aws::XRay
     #   @return [Array<Types::InstanceIdDetail>]
     #
     # @!attribute [rw] availability_zones
-    #   A list of availability zones for any zone corresponding to the trace
+    #   A list of Availability Zones for any zone corresponding to the trace
     #   segments.
     #   @return [Array<Types::AvailabilityZoneDetail>]
     #
@@ -2613,8 +2651,8 @@ module Aws::XRay
     #   @return [Types::ServiceId]
     #
     # @!attribute [rw] fault_root_causes
-    #   A collection of FaultRootCause structures corresponding to the the
-    #   trace segments.
+    #   A collection of FaultRootCause structures corresponding to the trace
+    #   segments.
     #   @return [Array<Types::FaultRootCause>]
     #
     # @!attribute [rw] error_root_causes
@@ -2769,6 +2807,7 @@ module Aws::XRay
     #         filter_expression: "FilterExpression",
     #         insights_configuration: {
     #           insights_enabled: false,
+    #           notifications_enabled: false,
     #         },
     #       }
     #
@@ -2786,9 +2825,14 @@ module Aws::XRay
     #   @return [String]
     #
     # @!attribute [rw] 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::InsightsConfiguration]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UpdateGroupRequest AWS API Documentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-xray
 version: !ruby/object:Gem::Version
-  version: 1.33.0
+  version: 1.34.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core