aws-sdk-cloudtrail 1.74.0 → 1.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91edac860f1d3195c8a03259a925c5a8561024b08857941651f3960933507423
-  data.tar.gz: 23a753272c4869b98496f9462ac9c1d5ada370228dd2ef25559611ab25dca2ad
+  metadata.gz: 49561e7e3b18730dedacd1f75dccc6e1c2acbce86dbd419b5b7f4f3b49354c45
+  data.tar.gz: a40b5508c8547fda8f4566cf77e247586d9da4c5e9d372e6b745529f8a8c2151
 SHA512:
-  metadata.gz: 9f4ce5eab5052adbebb1afa18cc74004962b5811ee1179455767d38b37f051036cddbd7baf7238a5cfd87b582e8158e98f4b6cde6d497ffed642dd0a95c6c4fb
-  data.tar.gz: 73f9b634c44c4656db2b5d9fd388af1eba7e79211aa2d6ae4a8addcb7256839f3e5317784ad78bb0ad3154dce86b0d22b1779cd26873a385a8e66192afcd2a51
+  metadata.gz: c1dd9cba547b50e4490bcbeacec3faadf275a9eec8f4da579a8062f79017d3da1950cc9fc1312455b5a83d9639b69dfecea33c1816e3f62fc1f2aa7f3a851124
+  data.tar.gz: 35d33a2c9b826d26e18be727f5ef0c46bbf960fe2d57e01754aa5fe3cae1ac38f32ecf1e8c7b2abc2fa6399ec310174aa3756eb140e762426d77c8ccf5046120

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.76.0 (2024-01-26)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.75.0 (2024-01-18)
+------------------
+
+* Feature - This release adds a new API ListInsightsMetricData to retrieve metric data from CloudTrail Insights.
+
 1.74.0 (2023-11-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.74.0
+1.76.0

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

@@ -862,11 +862,6 @@ module Aws::CloudTrail
     #
     #   Not required unless you specify `CloudWatchLogsRoleArn`.
     #
-    #   <note markdown="1"> Only the management account can configure a CloudWatch Logs log group
-    #   for an organization trail.
-    #
-    #    </note>
-    #
     # @option params [String] :cloud_watch_logs_role_arn
     #   Specifies the role for the CloudWatch Logs endpoint to assume to write
     #   to a user's log group. You must use a role that exists in your
@@ -1240,11 +1235,12 @@ module Aws::CloudTrail
     end
 
     # Disables Lake query federation on the specified event data store. When
-    # you disable federation, CloudTrail removes the metadata associated
-    # with the federated event data store in the Glue Data Catalog and
-    # removes registration for the federation role ARN and event data store
-    # in Lake Formation. No CloudTrail Lake data is deleted when you disable
-    # federation.
+    # you disable federation, CloudTrail disables the integration with Glue,
+    # Lake Formation, and Amazon Athena. After disabling Lake query
+    # federation, you can no longer query your event data in Amazon Athena.
+    #
+    # No CloudTrail Lake data is deleted when you disable federation and you
+    # can continue to run queries in CloudTrail Lake.
     #
     # @option params [required, String] :event_data_store
     #   The ARN (or ID suffix of the ARN) of the event data store for which
@@ -1282,13 +1278,13 @@ module Aws::CloudTrail
     # metadata stored in the Glue Data Catalog lets the Athena query engine
     # know how to find, read, and process the data that you want to query.
     #
-    # When you enable Lake query federation, CloudTrail creates a federated
+    # When you enable Lake query federation, CloudTrail creates a managed
     # database named `aws:cloudtrail` (if the database doesn't already
-    # exist) and a federated table in the Glue Data Catalog. The event data
-    # store ID is used for the table name. CloudTrail registers the role ARN
-    # and event data store in [Lake Formation][2], the service responsible
-    # for revoking or granting permissions to the federated resources in the
-    # Glue Data Catalog.
+    # exist) and a managed federated table in the Glue Data Catalog. The
+    # event data store ID is used for the table name. CloudTrail registers
+    # the role ARN and event data store in [Lake Formation][2], the service
+    # responsible for allowing fine-grained access control of the federated
+    # resources in the Glue Data Catalog.
     #
     # For more information about Lake query federation, see [Federate an
     # event data store][3].
@@ -1296,7 +1292,7 @@ module Aws::CloudTrail
     #
     #
     # [1]: https://docs.aws.amazon.com/glue/latest/dg/components-overview.html#data-catalog-intro
-    # [2]: https://docs.aws.amazon.com/lake-formation/latest/dg/how-it-works.html
+    # [2]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation-lake-formation.html
     # [3]: https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html
     #
     # @option params [required, String] :event_data_store
@@ -2102,6 +2098,134 @@ module Aws::CloudTrail
       req.send_request(options)
     end
 
+    # Returns Insights metrics data for trails that have enabled Insights.
+    # The request must include the `EventSource`, `EventName`, and
+    # `InsightType` parameters.
+    #
+    # If the `InsightType` is set to `ApiErrorRateInsight`, the request must
+    # also include the `ErrorCode` parameter.
+    #
+    # The following are the available time periods for
+    # `ListInsightsMetricData`. Each cutoff is inclusive.
+    #
+    # * Data points with a period of 60 seconds (1-minute) are available for
+    #   15 days.
+    #
+    # * Data points with a period of 300 seconds (5-minute) are available
+    #   for 63 days.
+    #
+    # * Data points with a period of 3600 seconds (1 hour) are available for
+    #   90 days.
+    #
+    # Access to the `ListInsightsMetricData` API operation is linked to the
+    # `cloudtrail:LookupEvents` action. To use this operation, you must have
+    # permissions to perform the `cloudtrail:LookupEvents` action.
+    #
+    # @option params [required, String] :event_source
+    #   The Amazon Web Services service to which the request was made, such as
+    #   `iam.amazonaws.com` or `s3.amazonaws.com`.
+    #
+    # @option params [required, String] :event_name
+    #   The name of the event, typically the Amazon Web Services API on which
+    #   unusual levels of activity were recorded.
+    #
+    # @option params [required, String] :insight_type
+    #   The type of CloudTrail Insights event, which is either
+    #   `ApiCallRateInsight` or `ApiErrorRateInsight`. The
+    #   `ApiCallRateInsight` Insights type analyzes write-only management API
+    #   calls that are aggregated per minute against a baseline API call
+    #   volume. The `ApiErrorRateInsight` Insights type analyzes management
+    #   API calls that result in error codes.
+    #
+    # @option params [String] :error_code
+    #   Conditionally required if the `InsightType` parameter is set to
+    #   `ApiErrorRateInsight`.
+    #
+    #   If returning metrics for the `ApiErrorRateInsight` Insights type, this
+    #   is the error to retrieve data for. For example, `AccessDenied`.
+    #
+    # @option params [Time,DateTime,Date,Integer,String] :start_time
+    #   Specifies, in UTC, the start time for time-series data. The value
+    #   specified is inclusive; results include data points with the specified
+    #   time stamp.
+    #
+    #   The default is 90 days before the time of request.
+    #
+    # @option params [Time,DateTime,Date,Integer,String] :end_time
+    #   Specifies, in UTC, the end time for time-series data. The value
+    #   specified is exclusive; results include data points up to the
+    #   specified time stamp.
+    #
+    #   The default is the time of request.
+    #
+    # @option params [Integer] :period
+    #   Granularity of data to retrieve, in seconds. Valid values are `60`,
+    #   `300`, and `3600`. If you specify any other value, you will get an
+    #   error. The default is 3600 seconds.
+    #
+    # @option params [String] :data_type
+    #   Type of datapoints to return. Valid values are `NonZeroData` and
+    #   `FillWithZeros`. The default is `NonZeroData`.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of datapoints to return. Valid values are integers
+    #   from 1 to 21600. The default value is 21600.
+    #
+    # @option params [String] :next_token
+    #   Returned if all datapoints can't be returned in a single call. For
+    #   example, due to reaching `MaxResults`.
+    #
+    #   Add this parameter to the request to continue retrieving results
+    #   starting from the last evaluated point.
+    #
+    # @return [Types::ListInsightsMetricDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListInsightsMetricDataResponse#event_source #event_source} => String
+    #   * {Types::ListInsightsMetricDataResponse#event_name #event_name} => String
+    #   * {Types::ListInsightsMetricDataResponse#insight_type #insight_type} => String
+    #   * {Types::ListInsightsMetricDataResponse#error_code #error_code} => String
+    #   * {Types::ListInsightsMetricDataResponse#timestamps #timestamps} => Array&lt;Time&gt;
+    #   * {Types::ListInsightsMetricDataResponse#values #values} => Array&lt;Float&gt;
+    #   * {Types::ListInsightsMetricDataResponse#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_insights_metric_data({
+    #     event_source: "EventSource", # required
+    #     event_name: "EventName", # required
+    #     insight_type: "ApiCallRateInsight", # required, accepts ApiCallRateInsight, ApiErrorRateInsight
+    #     error_code: "ErrorCode",
+    #     start_time: Time.now,
+    #     end_time: Time.now,
+    #     period: 1,
+    #     data_type: "FillWithZeros", # accepts FillWithZeros, NonZeroData
+    #     max_results: 1,
+    #     next_token: "InsightsMetricNextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.event_source #=> String
+    #   resp.event_name #=> String
+    #   resp.insight_type #=> String, one of "ApiCallRateInsight", "ApiErrorRateInsight"
+    #   resp.error_code #=> String
+    #   resp.timestamps #=> Array
+    #   resp.timestamps[0] #=> Time
+    #   resp.values #=> Array
+    #   resp.values[0] #=> Float
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListInsightsMetricData AWS API Documentation
+    #
+    # @overload list_insights_metric_data(params = {})
+    # @param [Hash] params ({})
+    def list_insights_metric_data(params = {}, options = {})
+      req = build_request(:list_insights_metric_data, params)
+      req.send_request(options)
+    end
+
     # Returns all public keys whose private keys were used to sign the
     # digest files within the specified time range. The public key is needed
     # to validate digest files that were signed with its corresponding
@@ -3305,13 +3429,14 @@ module Aws::CloudTrail
     # `TerminationProtection` is enabled.
     #
     # For event data stores for CloudTrail events, `AdvancedEventSelectors`
-    # includes or excludes management, data, or Insights events in your
-    # event data store. For more information about `AdvancedEventSelectors`,
-    # see [AdvancedEventSelectors][1].
+    # includes or excludes management or data events in your event data
+    # store. For more information about `AdvancedEventSelectors`, see
+    # [AdvancedEventSelectors][1].
     #
-    # For event data stores for Config configuration items, Audit Manager
-    # evidence, or non-Amazon Web Services events, `AdvancedEventSelectors`
-    # includes events of that type in your event data store.
+    # For event data stores for CloudTrail Insights events, Config
+    # configuration items, Audit Manager evidence, or non-Amazon Web
+    # Services events, `AdvancedEventSelectors` includes events of that type
+    # in your event data store.
     #
     #
     #
@@ -3609,11 +3734,6 @@ module Aws::CloudTrail
     #
     #   Not required unless you specify `CloudWatchLogsRoleArn`.
     #
-    #   <note markdown="1"> Only the management account can configure a CloudWatch Logs log group
-    #   for an organization trail.
-    #
-    #    </note>
-    #
     # @option params [String] :cloud_watch_logs_role_arn
     #   Specifies the role for the CloudWatch Logs endpoint to assume to write
     #   to a user's log group. You must use a role that exists in your
@@ -3731,7 +3851,7 @@ module Aws::CloudTrail
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudtrail'
-      context[:gem_version] = '1.74.0'
+      context[:gem_version] = '1.76.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -78,8 +78,10 @@ module Aws::CloudTrail
     Destinations = Shapes::ListShape.new(name: 'Destinations')
     DisableFederationRequest = Shapes::StructureShape.new(name: 'DisableFederationRequest')
     DisableFederationResponse = Shapes::StructureShape.new(name: 'DisableFederationResponse')
+    Double = Shapes::FloatShape.new(name: 'Double')
     EnableFederationRequest = Shapes::StructureShape.new(name: 'EnableFederationRequest')
     EnableFederationResponse = Shapes::StructureShape.new(name: 'EnableFederationResponse')
+    ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
     Event = Shapes::StructureShape.new(name: 'Event')
     EventCategory = Shapes::StringShape.new(name: 'EventCategory')
@@ -96,8 +98,10 @@ module Aws::CloudTrail
     EventDataStoreStatus = Shapes::StringShape.new(name: 'EventDataStoreStatus')
     EventDataStoreTerminationProtectedException = Shapes::StructureShape.new(name: 'EventDataStoreTerminationProtectedException')
     EventDataStores = Shapes::ListShape.new(name: 'EventDataStores')
+    EventName = Shapes::StringShape.new(name: 'EventName')
     EventSelector = Shapes::StructureShape.new(name: 'EventSelector')
     EventSelectors = Shapes::ListShape.new(name: 'EventSelectors')
+    EventSource = Shapes::StringShape.new(name: 'EventSource')
     EventsList = Shapes::ListShape.new(name: 'EventsList')
     ExcludeManagementEventSources = Shapes::ListShape.new(name: 'ExcludeManagementEventSources')
     FederationRoleArn = Shapes::StringShape.new(name: 'FederationRoleArn')
@@ -137,6 +141,11 @@ module Aws::CloudTrail
     InsightSelector = Shapes::StructureShape.new(name: 'InsightSelector')
     InsightSelectors = Shapes::ListShape.new(name: 'InsightSelectors')
     InsightType = Shapes::StringShape.new(name: 'InsightType')
+    InsightsMetricDataType = Shapes::StringShape.new(name: 'InsightsMetricDataType')
+    InsightsMetricMaxResults = Shapes::IntegerShape.new(name: 'InsightsMetricMaxResults')
+    InsightsMetricNextToken = Shapes::StringShape.new(name: 'InsightsMetricNextToken')
+    InsightsMetricPeriod = Shapes::IntegerShape.new(name: 'InsightsMetricPeriod')
+    InsightsMetricValues = Shapes::ListShape.new(name: 'InsightsMetricValues')
     InsufficientDependencyServiceAccessPermissionException = Shapes::StructureShape.new(name: 'InsufficientDependencyServiceAccessPermissionException')
     InsufficientEncryptionPolicyException = Shapes::StructureShape.new(name: 'InsufficientEncryptionPolicyException')
     InsufficientS3BucketPolicyException = Shapes::StructureShape.new(name: 'InsufficientS3BucketPolicyException')
@@ -183,6 +192,8 @@ module Aws::CloudTrail
     ListImportsMaxResultsCount = Shapes::IntegerShape.new(name: 'ListImportsMaxResultsCount')
     ListImportsRequest = Shapes::StructureShape.new(name: 'ListImportsRequest')
     ListImportsResponse = Shapes::StructureShape.new(name: 'ListImportsResponse')
+    ListInsightsMetricDataRequest = Shapes::StructureShape.new(name: 'ListInsightsMetricDataRequest')
+    ListInsightsMetricDataResponse = Shapes::StructureShape.new(name: 'ListInsightsMetricDataResponse')
     ListPublicKeysRequest = Shapes::StructureShape.new(name: 'ListPublicKeysRequest')
     ListPublicKeysResponse = Shapes::StructureShape.new(name: 'ListPublicKeysResponse')
     ListQueriesMaxResultsCount = Shapes::IntegerShape.new(name: 'ListQueriesMaxResultsCount')
@@ -285,6 +296,7 @@ module Aws::CloudTrail
     TagsList = Shapes::ListShape.new(name: 'TagsList')
     TerminationProtectionEnabled = Shapes::BooleanShape.new(name: 'TerminationProtectionEnabled')
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
+    Timestamps = Shapes::ListShape.new(name: 'Timestamps')
     Trail = Shapes::StructureShape.new(name: 'Trail')
     TrailAlreadyExistsException = Shapes::StructureShape.new(name: 'TrailAlreadyExistsException')
     TrailInfo = Shapes::StructureShape.new(name: 'TrailInfo')
@@ -731,6 +743,8 @@ module Aws::CloudTrail
 
     InsightSelectors.member = Shapes::ShapeRef.new(shape: InsightSelector)
 
+    InsightsMetricValues.member = Shapes::ShapeRef.new(shape: Double)
+
     InsufficientDependencyServiceAccessPermissionException.struct_class = Types::InsufficientDependencyServiceAccessPermissionException
 
     InsufficientEncryptionPolicyException.struct_class = Types::InsufficientEncryptionPolicyException
@@ -832,6 +846,27 @@ module Aws::CloudTrail
     ListImportsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "NextToken"))
     ListImportsResponse.struct_class = Types::ListImportsResponse
 
+    ListInsightsMetricDataRequest.add_member(:event_source, Shapes::ShapeRef.new(shape: EventSource, required: true, location_name: "EventSource"))
+    ListInsightsMetricDataRequest.add_member(:event_name, Shapes::ShapeRef.new(shape: EventName, required: true, location_name: "EventName"))
+    ListInsightsMetricDataRequest.add_member(:insight_type, Shapes::ShapeRef.new(shape: InsightType, required: true, location_name: "InsightType"))
+    ListInsightsMetricDataRequest.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
+    ListInsightsMetricDataRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: Date, location_name: "StartTime"))
+    ListInsightsMetricDataRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: Date, location_name: "EndTime"))
+    ListInsightsMetricDataRequest.add_member(:period, Shapes::ShapeRef.new(shape: InsightsMetricPeriod, location_name: "Period"))
+    ListInsightsMetricDataRequest.add_member(:data_type, Shapes::ShapeRef.new(shape: InsightsMetricDataType, location_name: "DataType"))
+    ListInsightsMetricDataRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: InsightsMetricMaxResults, location_name: "MaxResults"))
+    ListInsightsMetricDataRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: InsightsMetricNextToken, location_name: "NextToken"))
+    ListInsightsMetricDataRequest.struct_class = Types::ListInsightsMetricDataRequest
+
+    ListInsightsMetricDataResponse.add_member(:event_source, Shapes::ShapeRef.new(shape: EventSource, location_name: "EventSource"))
+    ListInsightsMetricDataResponse.add_member(:event_name, Shapes::ShapeRef.new(shape: EventName, location_name: "EventName"))
+    ListInsightsMetricDataResponse.add_member(:insight_type, Shapes::ShapeRef.new(shape: InsightType, location_name: "InsightType"))
+    ListInsightsMetricDataResponse.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
+    ListInsightsMetricDataResponse.add_member(:timestamps, Shapes::ShapeRef.new(shape: Timestamps, location_name: "Timestamps"))
+    ListInsightsMetricDataResponse.add_member(:values, Shapes::ShapeRef.new(shape: InsightsMetricValues, location_name: "Values"))
+    ListInsightsMetricDataResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: InsightsMetricNextToken, location_name: "NextToken"))
+    ListInsightsMetricDataResponse.struct_class = Types::ListInsightsMetricDataResponse
+
     ListPublicKeysRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: Date, location_name: "StartTime"))
     ListPublicKeysRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: Date, location_name: "EndTime"))
     ListPublicKeysRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
@@ -1105,6 +1140,8 @@ module Aws::CloudTrail
 
     ThrottlingException.struct_class = Types::ThrottlingException
 
+    Timestamps.member = Shapes::ShapeRef.new(shape: Date)
+
     Trail.add_member(:name, Shapes::ShapeRef.new(shape: String, location_name: "Name"))
     Trail.add_member(:s3_bucket_name, Shapes::ShapeRef.new(shape: String, location_name: "S3BucketName"))
     Trail.add_member(:s3_key_prefix, Shapes::ShapeRef.new(shape: String, location_name: "S3KeyPrefix"))
@@ -1720,6 +1757,23 @@ module Aws::CloudTrail
         )
       end)
 
+      api.add_operation(:list_insights_metric_data, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListInsightsMetricData"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListInsightsMetricDataRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListInsightsMetricDataResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: OperationNotPermittedException)
+        o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_public_keys, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListPublicKeys"
         o.http_method = "POST"

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

@@ -390,6 +390,20 @@ module Aws::CloudTrail
       end
     end
 
+    class ListInsightsMetricData
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::CloudTrail::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class ListPublicKeys
       def self.build(context)
         unless context.config.regional_endpoint

data/lib/aws-sdk-cloudtrail/plugins/endpoints.rb

@@ -14,6 +14,7 @@ module Aws::CloudTrail
       option(
         :endpoint_provider,
         doc_type: 'Aws::CloudTrail::EndpointProvider',
+        rbs_type: 'untyped',
         docstring: 'The endpoint provider used to resolve endpoints. Any '\
                    'object that responds to `#resolve_endpoint(parameters)` '\
                    'where `parameters` is a Struct similar to '\
@@ -111,6 +112,8 @@ module Aws::CloudTrail
             Aws::CloudTrail::Endpoints::ListImportFailures.build(context)
           when :list_imports
             Aws::CloudTrail::Endpoints::ListImports.build(context)
+          when :list_insights_metric_data
+            Aws::CloudTrail::Endpoints::ListInsightsMetricData.build(context)
           when :list_public_keys
             Aws::CloudTrail::Endpoints::ListPublicKeys.build(context)
           when :list_queries