aws-sdk-xray 1.28.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5571bfaaba06d1bfeba874705b082671517517a1fefeb79672ada2a76ffa9553
-  data.tar.gz: b97078aa19e2eb61b4f195dec5e287b18acd56c378cfbe8e3f861575aabd30d7
+  metadata.gz: b4b6cfa688df8a7338ddba4e159d4e9e1cddc264d6b3221f1089d0b43991de20
+  data.tar.gz: 0e4239ba337f4417a819334279620c7db4a5db0f5368ccc24d53b03dc7ba3eb4
 SHA512:
-  metadata.gz: 73feeec840386ca30598f54a3ce15d53a8efb9a1777e5d18eb1628b5b56a2fe8f1a0b37cdaf000c87b3b325b8b05e0424c239def70942d70e634fc1afe6ce50b
-  data.tar.gz: 4794472807ba98d9df54226d3de05eec263986b980feea23fd025710b0e7f437541ddd15051492bdebba5d747e0b7689ae44bbdf7a98f5a74f1440004b58fb94
+  metadata.gz: f5b744df9fb0deb0c1b45d20e95bcd844f566737df6202b163f9217e67c6ef9bc419b4a832144958bc05f54e036e70797ac3bc8e5e03ffdf2fb4768bf89116ac
+  data.tar.gz: 405c78cfceaaece86e1187b97cb702d83b453eb6bb86f0b5d43986ec217709cba15331307cca4b87ec01a5558f25715e14c1c7d2fa2ac33a9f295945d9231444

data/lib/aws-sdk-xray.rb

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-xray/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::XRay
 
-  GEM_VERSION = '1.28.0'
+  GEM_VERSION = '1.34.0'
 
 end

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

@@ -85,13 +85,28 @@ module Aws::XRay
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::XRay
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -342,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
@@ -367,6 +383,40 @@ module Aws::XRay
     # @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 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*.
+    #
+    #   The following restrictions apply to tags:
+    #
+    #   * Maximum number of user-applied tags per resource: 50
+    #
+    #   * Maximum tag key length: 128 Unicode characters
+    #
+    #   * Maximum tag value length: 256 Unicode characters
+    #
+    #   * Valid values for key and value: a-z, A-Z, 0-9, space, and the
+    #     following characters: \_ . : / = + - and @
+    #
+    #   * Tag keys and values are case sensitive.
+    #
+    #   * Don't use `aws:` as a prefix for keys; it's reserved for AWS use.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
+    #
     # @return [Types::CreateGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateGroupResult#group #group} => Types::Group
@@ -376,6 +426,16 @@ module Aws::XRay
     #   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
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -383,6 +443,8 @@ module Aws::XRay
     #   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
     #
@@ -405,6 +467,30 @@ module Aws::XRay
     # @option params [required, Types::SamplingRule] :sampling_rule
     #   The rule definition.
     #
+    # @option params [Array<Types::Tag>] :tags
+    #   A map that contains one or more tag keys and tag values to attach to
+    #   an X-Ray sampling rule. For more information about ways to use tags,
+    #   see [Tagging AWS resources][1] in the *AWS General Reference*.
+    #
+    #   The following restrictions apply to tags:
+    #
+    #   * Maximum number of user-applied tags per resource: 50
+    #
+    #   * Maximum tag key length: 128 Unicode characters
+    #
+    #   * Maximum tag value length: 256 Unicode characters
+    #
+    #   * Valid values for key and value: a-z, A-Z, 0-9, space, and the
+    #     following characters: \_ . : / = + - and @
+    #
+    #   * Tag keys and values are case sensitive.
+    #
+    #   * Don't use `aws:` as a prefix for keys; it's reserved for AWS use.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
+    #
     # @return [Types::CreateSamplingRuleResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateSamplingRuleResult#sampling_rule_record #sampling_rule_record} => Types::SamplingRuleRecord
@@ -429,6 +515,12 @@ module Aws::XRay
     #         "AttributeKey" => "AttributeValue",
     #       },
     #     },
+    #     tags: [
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
     #   })
     #
     # @example Response structure
@@ -579,6 +671,8 @@ module Aws::XRay
     #   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
     #
@@ -613,6 +707,8 @@ module Aws::XRay
     #   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
@@ -778,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.
@@ -881,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
@@ -1067,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
@@ -1211,6 +1309,45 @@ module Aws::XRay
       req.send_request(options)
     end
 
+    # Returns a list of tags that are applied to the specified AWS X-Ray
+    # group or sampling rule.
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
+    #
+    # @option params [String] :next_token
+    #   A pagination token. If multiple pages of results are returned, use the
+    #   `NextToken` value returned with the current page of results as the
+    #   value of this parameter to get the next page of results.
+    #
+    # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
+    #   * {Types::ListTagsForResourceResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_tags_for_resource({
+    #     resource_arn: "AmazonResourceName", # required
+    #     next_token: "String",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.tags #=> Array
+    #   resp.tags[0].key #=> String
+    #   resp.tags[0].value #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/ListTagsForResource AWS API Documentation
+    #
+    # @overload list_tags_for_resource(params = {})
+    # @param [Hash] params ({})
+    def list_tags_for_resource(params = {}, options = {})
+      req = build_request(:list_tags_for_resource, params)
+      req.send_request(options)
+    end
+
     # Updates the encryption configuration for X-Ray data.
     #
     # @option params [String] :key_id
@@ -1314,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.
     #
@@ -1334,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
@@ -1388,6 +1525,88 @@ module Aws::XRay
       req.send_request(options)
     end
 
+    # Applies tags to an existing AWS X-Ray group or sampling rule.
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
+    #
+    # @option params [required, Array<Types::Tag>] :tags
+    #   A map that contains one or more tag keys and tag values to attach to
+    #   an X-Ray group or sampling rule. For more information about ways to
+    #   use tags, see [Tagging AWS resources][1] in the *AWS General
+    #   Reference*.
+    #
+    #   The following restrictions apply to tags:
+    #
+    #   * Maximum number of user-applied tags per resource: 50
+    #
+    #   * Maximum tag key length: 128 Unicode characters
+    #
+    #   * Maximum tag value length: 256 Unicode characters
+    #
+    #   * Valid values for key and value: a-z, A-Z, 0-9, space, and the
+    #     following characters: \_ . : / = + - and @
+    #
+    #   * Tag keys and values are case sensitive.
+    #
+    #   * Don't use `aws:` as a prefix for keys; it's reserved for AWS use.
+    #     You cannot edit or delete system tags.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.tag_resource({
+    #     resource_arn: "AmazonResourceName", # required
+    #     tags: [ # required
+    #       {
+    #         key: "TagKey", # required
+    #         value: "TagValue", # required
+    #       },
+    #     ],
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/TagResource AWS API Documentation
+    #
+    # @overload tag_resource(params = {})
+    # @param [Hash] params ({})
+    def tag_resource(params = {}, options = {})
+      req = build_request(:tag_resource, params)
+      req.send_request(options)
+    end
+
+    # Removes tags from an AWS X-Ray group or sampling rule. You cannot edit
+    # or delete system tags (those with an `aws:` prefix).
+    #
+    # @option params [required, String] :resource_arn
+    #   The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
+    #
+    # @option params [required, Array<String>] :tag_keys
+    #   Keys for one or more tags that you want to remove from an X-Ray group
+    #   or sampling rule.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.untag_resource({
+    #     resource_arn: "AmazonResourceName", # required
+    #     tag_keys: ["TagKey"], # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/UntagResource AWS API Documentation
+    #
+    # @overload untag_resource(params = {})
+    # @param [Hash] params ({})
+    def untag_resource(params = {}, options = {})
+      req = build_request(:untag_resource, params)
+      req.send_request(options)
+    end
+
     # Updates a group resource.
     #
     # @option params [String] :group_name
@@ -1400,6 +1619,16 @@ module Aws::XRay
     #   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 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
@@ -1410,6 +1639,10 @@ module Aws::XRay
     #     group_name: "GroupName",
     #     group_arn: "GroupARN",
     #     filter_expression: "FilterExpression",
+    #     insights_configuration: {
+    #       insights_enabled: false,
+    #       notifications_enabled: false,
+    #     },
     #   })
     #
     # @example Response structure
@@ -1417,6 +1650,8 @@ module Aws::XRay
     #   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
     #
@@ -1498,7 +1733,7 @@ module Aws::XRay
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-xray'
-      context[:gem_version] = '1.28.0'
+      context[:gem_version] = '1.34.0'
       Seahorse::Client::Request.new(handlers, context)
     end