aws-sdk-cloudtrail 1.19.0 → 1.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6895c447d0feae813da5dc055dac76e59f266a08
-  data.tar.gz: 31ecefd18da65a7489e73aab3ad2af32af118846
+SHA256:
+  metadata.gz: 33c1b0bded8a999f5ae7ca8a87458795777814b90b36e0cebd2b91b2966ed494
+  data.tar.gz: e659679fb0212a0bd718a5ce655f3cee1a943d03d2c862bb1e79bf5c41a53b5d
 SHA512:
-  metadata.gz: b6a4f7937fe8895ca01284ca5807be215fa81147ea77e22c702e32b5303d1eb437d17f8156fd6aadd88e7d8af1a5c204f2c486f2c83d11bd922e7c03f2c63662
-  data.tar.gz: 66ec1893d9a4b30683f9fa03eed0db42d4615df816208d53baf9bad8ce8d69448bbab4e4407686c7d297650a75f99a42e42a83168c669ae5a0c2e55444c228ce
+  metadata.gz: e3f07e0893a68a7a9d4a5b2532eaae294c76890e98120659789c46c17b2154e2ffd34cc8bf48617a2a0c61e73ef4c1354d44edbdd95c65b2ad83eb39c8ef6cfd
+  data.tar.gz: 4f889f1e4dcc42daa91bad73d42e919b4fd5d880c716dbfe12e36c61e87f4c8000d0cbdce8d6c6e1067ea872d26bee6b9f07c468f4a077202c44b4dc9ffaad5e

data/lib/aws-sdk-cloudtrail.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-cloudtrail/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     cloud_trail = Aws::CloudTrail::Client.new
+#     resp = cloud_trail.add_tags(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from AWS CloudTrail all
-# extend {Errors::ServiceError}.
+# Errors returned from AWS CloudTrail are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::CloudTrail::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all AWS CloudTrail API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-cloudtrail/customizations'
 # @service
 module Aws::CloudTrail
 
-  GEM_VERSION = '1.19.0'
+  GEM_VERSION = '1.24.1'
 
 end

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

@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:cloudtrail)
 
 module Aws::CloudTrail
+  # An API client for CloudTrail.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::CloudTrail::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.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::CloudTrail
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
 
@@ -93,7 +107,7 @@ module Aws::CloudTrail
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::CloudTrail
     #     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] :adaptive_retry_wait_to_fill (true)
+    #     Used only in `adaptive` retry mode.  When true, the request will sleep
+    #     until there is sufficent client side capacity to retry the request.
+    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
+    #     not retry instead of sleeping.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -132,6 +152,10 @@ module Aws::CloudTrail
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::CloudTrail
     #   @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.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::CloudTrail
     #     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`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -166,15 +190,29 @@ module Aws::CloudTrail
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (3)
+    #     An integer representing the maximum number attempts that will be made for
+    #     a single request, including the initial attempt.  For example,
+    #     setting this value to 5 will result in a request being retried up to
+    #     4 times. Used in `standard` and `adaptive` retry modes.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (:none)
-    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #     A delay randomiser function used by the default backoff function.
+    #     Some predefined functions can be referenced by name - :none, :equal, :full,
+    #     otherwise a Proc that takes and returns a number. This option is only used
+    #     in the `legacy` retry mode.
     #
     #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
     #
@@ -182,11 +220,30 @@ module Aws::CloudTrail
     #     The maximum number of times to retry failed requests.  Only
     #     ~ 500 level server errors and certain ~ 400 level client errors
     #     are retried.  Generally, these are throttling errors, data
-    #     checksum errors, networking errors, timeout errors and auth
-    #     errors from expired credentials.
+    #     checksum errors, networking errors, timeout errors, auth errors,
+    #     endpoint discovery, and errors from expired credentials.
+    #     This option is only used in the `legacy` retry mode.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     The maximum number of seconds to delay between retries (0 for no limit)
+    #     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.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -219,16 +276,15 @@ module Aws::CloudTrail
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     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 yeidled 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 idble before it is
+    #     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.
     #
@@ -237,7 +293,7 @@ module Aws::CloudTrail
     #     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 yeidled 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`.
@@ -560,6 +616,7 @@ module Aws::CloudTrail
     #   resp.trail_list[0].cloud_watch_logs_role_arn #=> String
     #   resp.trail_list[0].kms_key_id #=> String
     #   resp.trail_list[0].has_custom_event_selectors #=> Boolean
+    #   resp.trail_list[0].has_insight_selectors #=> Boolean
     #   resp.trail_list[0].is_organization_trail #=> Boolean
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeTrails AWS API Documentation
@@ -632,6 +689,8 @@ module Aws::CloudTrail
     #   resp.event_selectors[0].data_resources[0].type #=> String
     #   resp.event_selectors[0].data_resources[0].values #=> Array
     #   resp.event_selectors[0].data_resources[0].values[0] #=> String
+    #   resp.event_selectors[0].exclude_management_event_sources #=> Array
+    #   resp.event_selectors[0].exclude_management_event_sources[0] #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventSelectors AWS API Documentation
     #
@@ -642,6 +701,66 @@ module Aws::CloudTrail
       req.send_request(options)
     end
 
+    # Describes the settings for the Insights event selectors that you
+    # configured for your trail. `GetInsightSelectors` shows if CloudTrail
+    # Insights event logging is enabled on the trail, and if it is, which
+    # insight types are enabled. If you run `GetInsightSelectors` on a trail
+    # that does not have Insights events enabled, the operation throws the
+    # exception `InsightNotEnabledException`
+    #
+    # For more information, see [Logging CloudTrail Insights Events for
+    # Trails ][1] in the *AWS CloudTrail User Guide*.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html
+    #
+    # @option params [required, String] :trail_name
+    #   Specifies the name of the trail or trail ARN. If you specify a trail
+    #   name, the string must meet the following requirements:
+    #
+    #   * Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.),
+    #     underscores (\_), or dashes (-)
+    #
+    #   * Start with a letter or number, and end with a letter or number
+    #
+    #   * Be between 3 and 128 characters
+    #
+    #   * Have no adjacent periods, underscores or dashes. Names like
+    #     `my-_namespace` and `my--namespace` are not valid.
+    #
+    #   * Not be in IP address format (for example, 192.168.5.4)
+    #
+    #   If you specify a trail ARN, it must be in the format:
+    #
+    #   `arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail`
+    #
+    # @return [Types::GetInsightSelectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetInsightSelectorsResponse#trail_arn #trail_arn} => String
+    #   * {Types::GetInsightSelectorsResponse#insight_selectors #insight_selectors} => Array&lt;Types::InsightSelector&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_insight_selectors({
+    #     trail_name: "String", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.trail_arn #=> String
+    #   resp.insight_selectors #=> Array
+    #   resp.insight_selectors[0].insight_type #=> String, one of "ApiCallRateInsight"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetInsightSelectors AWS API Documentation
+    #
+    # @overload get_insight_selectors(params = {})
+    # @param [Hash] params ({})
+    def get_insight_selectors(params = {}, options = {})
+      req = build_request(:get_insight_selectors, params)
+      req.send_request(options)
+    end
+
     # Returns settings information for a specified trail.
     #
     # @option params [required, String] :name
@@ -674,6 +793,7 @@ module Aws::CloudTrail
     #   resp.trail.cloud_watch_logs_role_arn #=> String
     #   resp.trail.kms_key_id #=> String
     #   resp.trail.has_custom_event_selectors #=> Boolean
+    #   resp.trail.has_insight_selectors #=> Boolean
     #   resp.trail.is_organization_trail #=> Boolean
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrail AWS API Documentation
@@ -785,6 +905,8 @@ module Aws::CloudTrail
     #   * {Types::ListPublicKeysResponse#public_key_list #public_key_list} => Array&lt;Types::PublicKey&gt;
     #   * {Types::ListPublicKeysResponse#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.list_public_keys({
@@ -827,6 +949,8 @@ module Aws::CloudTrail
     #   * {Types::ListTagsResponse#resource_tag_list #resource_tag_list} => Array&lt;Types::ResourceTag&gt;
     #   * {Types::ListTagsResponse#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.list_tags({
@@ -855,12 +979,19 @@ module Aws::CloudTrail
     # Lists trails that are in the current account.
     #
     # @option params [String] :next_token
+    #   The token to use to get the next page of results after a previous API
+    #   call. This token must be passed in with the same parameters that were
+    #   specified in the the original call. For example, if the original call
+    #   specified an AttributeKey of 'Username' with a value of 'root',
+    #   the call with NextToken should include those same parameters.
     #
     # @return [Types::ListTrailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ListTrailsResponse#trails #trails} => Array&lt;Types::TrailInfo&gt;
     #   * {Types::ListTrailsResponse#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.list_trails({
@@ -884,9 +1015,10 @@ module Aws::CloudTrail
       req.send_request(options)
     end
 
-    # Looks up [management events][1] captured by CloudTrail. You can look
-    # up events that occurred in a region within the last 90 days. Lookup
-    # supports the following attributes:
+    # Looks up [management events][1] or [CloudTrail Insights events][2]
+    # that are captured by CloudTrail. You can look up events that occurred
+    # in a region within the last 90 days. Lookup supports the following
+    # attributes for management events:
     #
     # * AWS access key
     #
@@ -904,20 +1036,25 @@ module Aws::CloudTrail
     #
     # * User name
     #
+    # Lookup supports the following attributes for Insights events:
+    #
+    # * Event ID
+    #
+    # * Event name
+    #
+    # * Event source
+    #
     # All attributes are optional. The default number of results returned is
     # 50, with a maximum of 50 possible. The response includes a token that
     # you can use to get the next page of results.
     #
-    # The rate of lookup requests is limited to one per second per account.
+    # The rate of lookup requests is limited to two per second per account.
     # If this limit is exceeded, a throttling error occurs.
     #
-    #  Events that occurred during the selected time range will not be
-    # available for lookup if CloudTrail logging was not enabled when the
-    # events occurred.
-    #
     #
     #
     # [1]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events
+    # [2]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-insights-events
     #
     # @option params [Array<Types::LookupAttribute>] :lookup_attributes
     #   Contains a list of lookup attributes. Currently the list can contain
@@ -933,6 +1070,12 @@ module Aws::CloudTrail
     #   are returned. If the specified end time is before the specified start
     #   time, an error is returned.
     #
+    # @option params [String] :event_category
+    #   Specifies the event category. If you do not specify an event category,
+    #   events of the category are not returned in the response. For example,
+    #   if you do not specify `insight` as the value of `EventCategory`, no
+    #   Insights events are returned.
+    #
     # @option params [Integer] :max_results
     #   The number of events to return. Possible values are 1 through 50. The
     #   default is 50.
@@ -949,6 +1092,8 @@ module Aws::CloudTrail
     #   * {Types::LookupEventsResponse#events #events} => Array&lt;Types::Event&gt;
     #   * {Types::LookupEventsResponse#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.lookup_events({
@@ -960,6 +1105,7 @@ module Aws::CloudTrail
     #     ],
     #     start_time: Time.now,
     #     end_time: Time.now,
+    #     event_category: "insight", # accepts insight
     #     max_results: 1,
     #     next_token: "NextToken",
     #   })
@@ -1073,6 +1219,7 @@ module Aws::CloudTrail
     #             values: ["String"],
     #           },
     #         ],
+    #         exclude_management_event_sources: ["String"],
     #       },
     #     ],
     #   })
@@ -1087,6 +1234,8 @@ module Aws::CloudTrail
     #   resp.event_selectors[0].data_resources[0].type #=> String
     #   resp.event_selectors[0].data_resources[0].values #=> Array
     #   resp.event_selectors[0].data_resources[0].values[0] #=> String
+    #   resp.event_selectors[0].exclude_management_event_sources #=> Array
+    #   resp.event_selectors[0].exclude_management_event_sources[0] #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutEventSelectors AWS API Documentation
     #
@@ -1097,6 +1246,52 @@ module Aws::CloudTrail
       req.send_request(options)
     end
 
+    # Lets you enable Insights event logging by specifying the Insights
+    # selectors that you want to enable on an existing trail. You also use
+    # `PutInsightSelectors` to turn off Insights event logging, by passing
+    # an empty list of insight types. In this release, only
+    # `ApiCallRateInsight` is supported as an Insights selector.
+    #
+    # @option params [required, String] :trail_name
+    #   The name of the CloudTrail trail for which you want to change or add
+    #   Insights selectors.
+    #
+    # @option params [required, Array<Types::InsightSelector>] :insight_selectors
+    #   A JSON string that contains the insight types you want to log on a
+    #   trail. In this release, only `ApiCallRateInsight` is supported as an
+    #   insight type.
+    #
+    # @return [Types::PutInsightSelectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::PutInsightSelectorsResponse#trail_arn #trail_arn} => String
+    #   * {Types::PutInsightSelectorsResponse#insight_selectors #insight_selectors} => Array&lt;Types::InsightSelector&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_insight_selectors({
+    #     trail_name: "String", # required
+    #     insight_selectors: [ # required
+    #       {
+    #         insight_type: "ApiCallRateInsight", # accepts ApiCallRateInsight
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.trail_arn #=> String
+    #   resp.insight_selectors #=> Array
+    #   resp.insight_selectors[0].insight_type #=> String, one of "ApiCallRateInsight"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutInsightSelectors AWS API Documentation
+    #
+    # @overload put_insight_selectors(params = {})
+    # @param [Hash] params ({})
+    def put_insight_selectors(params = {}, options = {})
+      req = build_request(:put_insight_selectors, params)
+      req.send_request(options)
+    end
+
     # Removes the specified tags from a trail.
     #
     # @option params [required, String] :resource_id
@@ -1381,7 +1576,7 @@ module Aws::CloudTrail
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudtrail'
-      context[:gem_version] = '1.19.0'
+      context[:gem_version] = '1.24.1'
       Seahorse::Client::Request.new(handlers, context)
     end