aws-sdk-cloudtrail 1.98.0 → 1.99.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bd15afc1bd39dd3f47982851ddc12288a3878a059cfaf93e2a985848cebc5f6
-  data.tar.gz: 7fced6ba53896eff778a92d3cc468e64347b1b69652db3b42f026a110c8a28a3
+  metadata.gz: bc9aca08534f9deeb55d0fff7207fc0345ceba43d6a84e4dce182ccc9e338a52
+  data.tar.gz: 96030cece64be6f5cedf96ae2396bae711dbdaf1a56cda5968c866cd41fd536c
 SHA512:
-  metadata.gz: 8ef5a0a87d10afbe15eed7d4f3badae43ef5f8c2a0844ae024839d4373f2cce17ba6dc7148a153ea843d512ded918060665e1c7055d0260e8768ec2a88fd1877
-  data.tar.gz: fbcb7694bf84e718e44ac2313656d0b17c8e59977ca045d4a26fc67633f3a1d726da8d9701bd08d7be75ce285d2257870f11150235d6ec660dcdebbbd5f401cd
+  metadata.gz: 4117bd65d9851ee26e2f61861f88d89cac59a72fe7ca927d278efab0948aeea85fd309c2a7fb87dee94ce5827bbf3429cea0758556c6ea943410bc7e5fca17da
+  data.tar.gz: f73baf4f324b377286fbf6a72dd68c97fdd44d7d76fb5656bc7113548eec1bdcaab08f1f99f45c5650d960790053121bb5686d64d143acfe9b2d27a095b31436

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.99.0 (2025-01-24)
+------------------
+
+* Feature - This release introduces the SearchSampleQueries API that allows users to search for CloudTrail Lake sample queries.
+
 1.98.0 (2025-01-15)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.98.0
+1.99.0

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

@@ -2029,8 +2029,8 @@ module Aws::CloudTrail
     # get Insights event selectors for a trail. You cannot specify these
     # parameters together.
     #
-    # For more information, see [Logging CloudTrail Insights events][1] in
-    # the *CloudTrail User Guide*.
+    # For more information, see [Working with CloudTrail Insights][1] in the
+    # *CloudTrail User Guide*.
     #
     #
     #
@@ -3059,10 +3059,11 @@ module Aws::CloudTrail
     # If you want your trail to log Insights events, be sure the event
     # selector or advanced event selector enables logging of the Insights
     # event types you want configured for your trail. For more information
-    # about logging Insights events, see [Logging Insights events][1] in the
-    # *CloudTrail User Guide*. By default, trails created without specific
-    # event selectors are configured to log all read and write management
-    # events, and no data events or network activity events.
+    # about logging Insights events, see [Working with CloudTrail
+    # Insights][1] in the *CloudTrail User Guide*. By default, trails
+    # created without specific event selectors are configured to log all
+    # read and write management events, and no data events or network
+    # activity events.
     #
     # When an event occurs in your account, CloudTrail evaluates the event
     # selectors or advanced event selectors in all trails. For each trail,
@@ -3273,8 +3274,8 @@ module Aws::CloudTrail
     # management events. You can call `GetEventDataStore` on an event data
     # store to check whether the event data store logs management events.
     #
-    # For more information, see [Logging CloudTrail Insights events][1] in
-    # the *CloudTrail User Guide*.
+    # For more information, see [Working with CloudTrail Insights][1] in the
+    # *CloudTrail User Guide*.
     #
     #
     #
@@ -3557,6 +3558,53 @@ module Aws::CloudTrail
       req.send_request(options)
     end
 
+    # Searches sample queries and returns a list of sample queries that are
+    # sorted by relevance. To search for sample queries, provide a natural
+    # language `SearchPhrase` in English.
+    #
+    # @option params [required, String] :search_phrase
+    #   The natural language phrase to use for the semantic search. The phrase
+    #   must be in English. The length constraint is in characters, not words.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return on a single page. The default
+    #   value is 10.
+    #
+    # @option params [String] :next_token
+    #   A token you can use to get the next page of results. The length
+    #   constraint is in characters, not words.
+    #
+    # @return [Types::SearchSampleQueriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::SearchSampleQueriesResponse#search_results #search_results} => Array<Types::SearchSampleQueriesSearchResult>
+    #   * {Types::SearchSampleQueriesResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.search_sample_queries({
+    #     search_phrase: "SearchSampleQueriesSearchPhrase", # required
+    #     max_results: 1,
+    #     next_token: "PaginationToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.search_results #=> Array
+    #   resp.search_results[0].name #=> String
+    #   resp.search_results[0].description #=> String
+    #   resp.search_results[0].sql #=> String
+    #   resp.search_results[0].relevance #=> Float
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/SearchSampleQueries AWS API Documentation
+    #
+    # @overload search_sample_queries(params = {})
+    # @param [Hash] params ({})
+    def search_sample_queries(params = {}, options = {})
+      req = build_request(:search_sample_queries, params)
+      req.send_request(options)
+    end
+
     # Starts a refresh of the specified dashboard.
     #
     # Each time a dashboard is refreshed, CloudTrail runs queries to
@@ -4536,7 +4584,7 @@ module Aws::CloudTrail
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-cloudtrail'
-      context[:gem_version] = '1.98.0'
+      context[:gem_version] = '1.99.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -306,6 +306,16 @@ module Aws::CloudTrail
     RetentionPeriod = Shapes::IntegerShape.new(name: 'RetentionPeriod')
     S3BucketDoesNotExistException = Shapes::StructureShape.new(name: 'S3BucketDoesNotExistException')
     S3ImportSource = Shapes::StructureShape.new(name: 'S3ImportSource')
+    SampleQueryDescription = Shapes::StringShape.new(name: 'SampleQueryDescription')
+    SampleQueryName = Shapes::StringShape.new(name: 'SampleQueryName')
+    SampleQueryRelevance = Shapes::FloatShape.new(name: 'SampleQueryRelevance')
+    SampleQuerySQL = Shapes::StringShape.new(name: 'SampleQuerySQL')
+    SearchSampleQueriesMaxResults = Shapes::IntegerShape.new(name: 'SearchSampleQueriesMaxResults')
+    SearchSampleQueriesRequest = Shapes::StructureShape.new(name: 'SearchSampleQueriesRequest')
+    SearchSampleQueriesResponse = Shapes::StructureShape.new(name: 'SearchSampleQueriesResponse')
+    SearchSampleQueriesSearchPhrase = Shapes::StringShape.new(name: 'SearchSampleQueriesSearchPhrase')
+    SearchSampleQueriesSearchResult = Shapes::StructureShape.new(name: 'SearchSampleQueriesSearchResult')
+    SearchSampleQueriesSearchResults = Shapes::ListShape.new(name: 'SearchSampleQueriesSearchResults')
     SelectorField = Shapes::StringShape.new(name: 'SelectorField')
     SelectorName = Shapes::StringShape.new(name: 'SelectorName')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
@@ -1213,6 +1223,23 @@ module Aws::CloudTrail
     S3ImportSource.add_member(:s3_bucket_access_role_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "S3BucketAccessRoleArn"))
     S3ImportSource.struct_class = Types::S3ImportSource
 
+    SearchSampleQueriesRequest.add_member(:search_phrase, Shapes::ShapeRef.new(shape: SearchSampleQueriesSearchPhrase, required: true, location_name: "SearchPhrase"))
+    SearchSampleQueriesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: SearchSampleQueriesMaxResults, location_name: "MaxResults"))
+    SearchSampleQueriesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "NextToken"))
+    SearchSampleQueriesRequest.struct_class = Types::SearchSampleQueriesRequest
+
+    SearchSampleQueriesResponse.add_member(:search_results, Shapes::ShapeRef.new(shape: SearchSampleQueriesSearchResults, location_name: "SearchResults"))
+    SearchSampleQueriesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "NextToken"))
+    SearchSampleQueriesResponse.struct_class = Types::SearchSampleQueriesResponse
+
+    SearchSampleQueriesSearchResult.add_member(:name, Shapes::ShapeRef.new(shape: SampleQueryName, location_name: "Name"))
+    SearchSampleQueriesSearchResult.add_member(:description, Shapes::ShapeRef.new(shape: SampleQueryDescription, location_name: "Description"))
+    SearchSampleQueriesSearchResult.add_member(:sql, Shapes::ShapeRef.new(shape: SampleQuerySQL, location_name: "SQL"))
+    SearchSampleQueriesSearchResult.add_member(:relevance, Shapes::ShapeRef.new(shape: SampleQueryRelevance, location_name: "Relevance"))
+    SearchSampleQueriesSearchResult.struct_class = Types::SearchSampleQueriesSearchResult
+
+    SearchSampleQueriesSearchResults.member = Shapes::ShapeRef.new(shape: SearchSampleQueriesSearchResult)
+
     ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
 
     SourceConfig.add_member(:apply_to_all_regions, Shapes::ShapeRef.new(shape: Boolean, location_name: "ApplyToAllRegions"))
@@ -2254,6 +2281,17 @@ module Aws::CloudTrail
         o.errors << Shapes::ShapeRef.new(shape: OrganizationNotInAllFeaturesModeException)
       end)
 
+      api.add_operation(:search_sample_queries, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "SearchSampleQueries"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: SearchSampleQueriesRequest)
+        o.output = Shapes::ShapeRef.new(shape: SearchSampleQueriesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
+        o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperationException)
+        o.errors << Shapes::ShapeRef.new(shape: OperationNotPermittedException)
+      end)
+
       api.add_operation(:start_dashboard_refresh, Seahorse::Model::Operation.new.tap do |o|
         o.name = "StartDashboardRefresh"
         o.http_method = "POST"

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

@@ -96,7 +96,7 @@ module Aws::CloudTrail
     # a trail.
     #
     # For information about configurable advanced event selector fields, see
-    # [AdvancedEventSelector][4] in the *CloudTrailUser Guide*.
+    # [AdvancedEventSelector][4] in the *CloudTrail API Reference*.
     #
     #
     #
@@ -133,7 +133,14 @@ module Aws::CloudTrail
     #   filtering is not supported.
     #
     #   For more information, see [AdvancedFieldSelector][1] in the
-    #   *CloudTrailUser Guide*.
+    #   *CloudTrail API Reference*.
+    #
+    #   <note markdown="1"> Selectors don't support the use of wildcards like `*` . To match
+    #   multiple values with a single condition, you may use `StartsWith`,
+    #   `EndsWith`, `NotStartsWith`, or `NotEndsWith` to explicitly match
+    #   the beginning or end of the event field.
+    #
+    #    </note>
     #
     #
     #
@@ -4657,6 +4664,80 @@ module Aws::CloudTrail
       include Aws::Structure
     end
 
+    # @!attribute [rw] search_phrase
+    #   The natural language phrase to use for the semantic search. The
+    #   phrase must be in English. The length constraint is in characters,
+    #   not words.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return on a single page. The
+    #   default value is 10.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   A token you can use to get the next page of results. The length
+    #   constraint is in characters, not words.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/SearchSampleQueriesRequest AWS API Documentation
+    #
+    class SearchSampleQueriesRequest < Struct.new(
+      :search_phrase,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] search_results
+    #   A list of objects containing the search results ordered from most
+    #   relevant to least relevant.
+    #   @return [Array<Types::SearchSampleQueriesSearchResult>]
+    #
+    # @!attribute [rw] next_token
+    #   A token you can use to get the next page of results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/SearchSampleQueriesResponse AWS API Documentation
+    #
+    class SearchSampleQueriesResponse < Struct.new(
+      :search_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A search result returned by the `SearchSampleQueries` operation.
+    #
+    # @!attribute [rw] name
+    #   The name of a sample query.
+    #   @return [String]
+    #
+    # @!attribute [rw] description
+    #   A longer description of a sample query.
+    #   @return [String]
+    #
+    # @!attribute [rw] sql
+    #   The SQL code of the sample query.
+    #   @return [String]
+    #
+    # @!attribute [rw] relevance
+    #   A value between 0 and 1 indicating the similarity between the search
+    #   phrase and result.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/SearchSampleQueriesSearchResult AWS API Documentation
+    #
+    class SearchSampleQueriesSearchResult < Struct.new(
+      :name,
+      :description,
+      :sql,
+      :relevance)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # This exception is thrown when the quota is exceeded. For information
     # about CloudTrail quotas, see [Service quotas][1] in the *Amazon Web
     # Services General Reference*.

data/lib/aws-sdk-cloudtrail.rb

@@ -54,7 +54,7 @@ module Aws::CloudTrail
   autoload :EndpointProvider, 'aws-sdk-cloudtrail/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-cloudtrail/endpoints'
 
-  GEM_VERSION = '1.98.0'
+  GEM_VERSION = '1.99.0'
 
 end
 

data/sig/client.rbs

@@ -835,6 +835,19 @@ module Aws
                                     ) -> _RestoreEventDataStoreResponseSuccess
                                   | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RestoreEventDataStoreResponseSuccess
 
+      interface _SearchSampleQueriesResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::SearchSampleQueriesResponse]
+        def search_results: () -> ::Array[Types::SearchSampleQueriesSearchResult]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CloudTrail/Client.html#search_sample_queries-instance_method
+      def search_sample_queries: (
+                                   search_phrase: ::String,
+                                   ?max_results: ::Integer,
+                                   ?next_token: ::String
+                                 ) -> _SearchSampleQueriesResponseSuccess
+                               | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchSampleQueriesResponseSuccess
+
       interface _StartDashboardRefreshResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::StartDashboardRefreshResponse]
         def refresh_id: () -> ::String

data/sig/types.rbs

@@ -1095,6 +1095,27 @@ module Aws::CloudTrail
       SENSITIVE: []
     end
 
+    class SearchSampleQueriesRequest
+      attr_accessor search_phrase: ::String
+      attr_accessor max_results: ::Integer
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class SearchSampleQueriesResponse
+      attr_accessor search_results: ::Array[Types::SearchSampleQueriesSearchResult]
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class SearchSampleQueriesSearchResult
+      attr_accessor name: ::String
+      attr_accessor description: ::String
+      attr_accessor sql: ::String
+      attr_accessor relevance: ::Float
+      SENSITIVE: []
+    end
+
     class ServiceQuotaExceededException < Aws::EmptyStructure
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudtrail
 version: !ruby/object:Gem::Version
-  version: 1.98.0
+  version: 1.99.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core