aws-sdk-resourceexplorer2 1.26.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b5c81949ad27bf651df07903d279dc8d817cac3e953fe57080aeeeee781b703
-  data.tar.gz: 4fc098933aaaae09f7570043ba6ce6022983f997e5dcf7e3fdd33c000903c5dc
+  metadata.gz: 01a2a484bd964b27b69e4773f6a0109409097efb641e5e605abf20944c5b5a83
+  data.tar.gz: 414bce62b32b94fd112ac51cb8d45336ac6c2ed73abf25afb2b92f98f093653f
 SHA512:
-  metadata.gz: 5ca22e172c244cadaadf52f9d07f1916b10aff4a38f0ae689e2cb124b9df3c722e16217b425781572d802fecbbb1ab02ec544818d136054520da0bae03b6e2ef
-  data.tar.gz: 8ad41f44a671e62d8f844b0e9bf653a54eec8a81999613670d3423e6bb66bcb50f049942f297cd39ea115a53d0530d7cc3555017315b899e5af463144bf4d71c
+  metadata.gz: d3f29d8d7c25b26475d76189f3a5ad6d98fbdfb6c613e177b06f266ab5b8c9e0ee89110400e78a4811e9452a7a6eb09869261ebe8e1d8790f2add1a3481d7966
+  data.tar.gz: d2b856d180996a0a4639d8bfd4adceab9be7b30a26f050ba91f2746f07329e88b23a51cf856e579699ce6797fac247e4c4c8174b425dc4296f0ca7d1bd82f3c1

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.27.0 (2024-09-23)
+------------------
+
+* Feature - AWS Resource Explorer released ListResources feature which allows customers to list all indexed AWS resources within a view.
+
 1.26.0 (2024-09-20)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.26.0
+1.27.0

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

@@ -872,9 +872,8 @@ module Aws::ResourceExplorer2
 
     # Retrieves the status of your account's Amazon Web Services service
     # access, and validates the service linked role required to access the
-    # multi-account search feature. Only the management account or a
-    # delegated administrator with service access enabled can invoke this
-    # API call.
+    # multi-account search feature. Only the management account can invoke
+    # this API call.
     #
     # @return [Types::GetAccountLevelServiceConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1132,6 +1131,90 @@ module Aws::ResourceExplorer2
       req.send_request(options)
     end
 
+    # Returns a list of resources and their details that match the specified
+    # criteria. This query must use a view. If you don’t explicitly specify
+    # a view, then Resource Explorer uses the default view for the Amazon
+    # Web Services Region in which you call this operation.
+    #
+    # @option params [Types::SearchFilter] :filters
+    #   A search filter defines which resources can be part of a search query
+    #   result set.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results that you want included on each page of
+    #   the response. If you do not include this parameter, it defaults to a
+    #   value appropriate to the operation. If additional items exist beyond
+    #   those included in the current response, the `NextToken` response
+    #   element is present and has a value (is not null). Include that value
+    #   as the `NextToken` request parameter in the next call to the operation
+    #   to get the next part of the results.
+    #
+    #   <note markdown="1"> An API operation can return fewer results than the maximum even when
+    #   there are more results available. You should check `NextToken` after
+    #   every operation to ensure that you receive all of the results.
+    #
+    #    </note>
+    #
+    # @option params [String] :next_token
+    #   The parameter for receiving additional results if you receive a
+    #   `NextToken` response in a previous request. A `NextToken` response
+    #   indicates that more output is available. Set this parameter to the
+    #   value of the previous call's `NextToken` response to indicate where
+    #   the output should continue from. The pagination tokens expire after 24
+    #   hours.
+    #
+    # @option params [String] :view_arn
+    #   Specifies the Amazon resource name (ARN) of the view to use for the
+    #   query. If you don't specify a value for this parameter, then the
+    #   operation automatically uses the default view for the Amazon Web
+    #   Services Region in which you called this operation. If the Region
+    #   either doesn't have a default view or if you don't have permission
+    #   to use the default view, then the operation fails with a 401
+    #   Unauthorized exception.
+    #
+    # @return [Types::ListResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListResourcesOutput#next_token #next_token} => String
+    #   * {Types::ListResourcesOutput#resources #resources} => Array&lt;Types::Resource&gt;
+    #   * {Types::ListResourcesOutput#view_arn #view_arn} => 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_resources({
+    #     filters: {
+    #       filter_string: "SearchFilterFilterStringString", # required
+    #     },
+    #     max_results: 1,
+    #     next_token: "ListResourcesInputNextTokenString",
+    #     view_arn: "ListResourcesInputViewArnString",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.resources #=> Array
+    #   resp.resources[0].arn #=> String
+    #   resp.resources[0].last_reported_at #=> Time
+    #   resp.resources[0].owning_account_id #=> String
+    #   resp.resources[0].properties #=> Array
+    #   resp.resources[0].properties[0].last_reported_at #=> Time
+    #   resp.resources[0].properties[0].name #=> String
+    #   resp.resources[0].region #=> String
+    #   resp.resources[0].resource_type #=> String
+    #   resp.resources[0].service #=> String
+    #   resp.view_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListResources AWS API Documentation
+    #
+    # @overload list_resources(params = {})
+    # @param [Hash] params ({})
+    def list_resources(params = {}, options = {})
+      req = build_request(:list_resources, params)
+      req.send_request(options)
+    end
+
     # Retrieves a list of all resource types currently supported by Amazon
     # Web Services Resource Explorer.
     #
@@ -1677,7 +1760,7 @@ module Aws::ResourceExplorer2
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-resourceexplorer2'
-      context[:gem_version] = '1.26.0'
+      context[:gem_version] = '1.27.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 module Aws::ResourceExplorer2
   # @api private
   module ClientApi
@@ -62,6 +63,13 @@ module Aws::ResourceExplorer2
     ListIndexesInputNextTokenString = Shapes::StringShape.new(name: 'ListIndexesInputNextTokenString')
     ListIndexesInputRegionsList = Shapes::ListShape.new(name: 'ListIndexesInputRegionsList')
     ListIndexesOutput = Shapes::StructureShape.new(name: 'ListIndexesOutput')
+    ListResourcesInput = Shapes::StructureShape.new(name: 'ListResourcesInput')
+    ListResourcesInputMaxResultsInteger = Shapes::IntegerShape.new(name: 'ListResourcesInputMaxResultsInteger')
+    ListResourcesInputNextTokenString = Shapes::StringShape.new(name: 'ListResourcesInputNextTokenString')
+    ListResourcesInputViewArnString = Shapes::StringShape.new(name: 'ListResourcesInputViewArnString')
+    ListResourcesOutput = Shapes::StructureShape.new(name: 'ListResourcesOutput')
+    ListResourcesOutputNextTokenString = Shapes::StringShape.new(name: 'ListResourcesOutputNextTokenString')
+    ListResourcesOutputViewArnString = Shapes::StringShape.new(name: 'ListResourcesOutputViewArnString')
     ListSupportedResourceTypesInput = Shapes::StructureShape.new(name: 'ListSupportedResourceTypesInput')
     ListSupportedResourceTypesInputMaxResultsInteger = Shapes::IntegerShape.new(name: 'ListSupportedResourceTypesInputMaxResultsInteger')
     ListSupportedResourceTypesOutput = Shapes::StructureShape.new(name: 'ListSupportedResourceTypesOutput')
@@ -239,6 +247,17 @@ module Aws::ResourceExplorer2
     ListIndexesOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
     ListIndexesOutput.struct_class = Types::ListIndexesOutput
 
+    ListResourcesInput.add_member(:filters, Shapes::ShapeRef.new(shape: SearchFilter, location_name: "Filters"))
+    ListResourcesInput.add_member(:max_results, Shapes::ShapeRef.new(shape: ListResourcesInputMaxResultsInteger, location_name: "MaxResults"))
+    ListResourcesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: ListResourcesInputNextTokenString, location_name: "NextToken"))
+    ListResourcesInput.add_member(:view_arn, Shapes::ShapeRef.new(shape: ListResourcesInputViewArnString, location_name: "ViewArn"))
+    ListResourcesInput.struct_class = Types::ListResourcesInput
+
+    ListResourcesOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: ListResourcesOutputNextTokenString, location_name: "NextToken"))
+    ListResourcesOutput.add_member(:resources, Shapes::ShapeRef.new(shape: ResourceList, location_name: "Resources"))
+    ListResourcesOutput.add_member(:view_arn, Shapes::ShapeRef.new(shape: ListResourcesOutputViewArnString, location_name: "ViewArn"))
+    ListResourcesOutput.struct_class = Types::ListResourcesOutput
+
     ListSupportedResourceTypesInput.add_member(:max_results, Shapes::ShapeRef.new(shape: ListSupportedResourceTypesInputMaxResultsInteger, location_name: "MaxResults"))
     ListSupportedResourceTypesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
     ListSupportedResourceTypesInput.struct_class = Types::ListSupportedResourceTypesInput
@@ -397,9 +416,11 @@ module Aws::ResourceExplorer2
 
       api.metadata = {
         "apiVersion" => "2022-07-28",
+        "auth" => ["aws.auth#sigv4"],
         "endpointPrefix" => "resource-explorer-2",
         "jsonVersion" => "1.1",
         "protocol" => "rest-json",
+        "protocols" => ["rest-json"],
         "serviceFullName" => "AWS Resource Explorer",
         "serviceId" => "Resource Explorer 2",
         "signatureVersion" => "v4",
@@ -589,6 +610,26 @@ module Aws::ResourceExplorer2
         )
       end)
 
+      api.add_operation(:list_resources, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListResources"
+        o.http_method = "POST"
+        o.http_request_uri = "/ListResources"
+        o.input = Shapes::ShapeRef.new(shape: ListResourcesInput)
+        o.output = Shapes::ShapeRef.new(shape: ListResourcesOutput)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_supported_resource_types, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListSupportedResourceTypes"
         o.http_method = "POST"

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

@@ -155,6 +155,17 @@ module Aws::ResourceExplorer2
       end
     end
 
+    class ListResources
+      def self.build(context)
+        Aws::ResourceExplorer2::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s,
+        )
+      end
+    end
+
     class ListSupportedResourceTypes
       def self.build(context)
         Aws::ResourceExplorer2::EndpointParameters.new(

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

@@ -96,6 +96,8 @@ The endpoint provider used to resolve endpoints. Any object that responds to
             Aws::ResourceExplorer2::Endpoints::ListIndexes.build(context)
           when :list_indexes_for_members
             Aws::ResourceExplorer2::Endpoints::ListIndexesForMembers.build(context)
+          when :list_resources
+            Aws::ResourceExplorer2::Endpoints::ListResources.build(context)
           when :list_supported_resource_types
             Aws::ResourceExplorer2::Endpoints::ListSupportedResourceTypes.build(context)
           when :list_tags_for_resource

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

@@ -732,6 +732,86 @@ module Aws::ResourceExplorer2
       include Aws::Structure
     end
 
+    # @!attribute [rw] filters
+    #   A search filter defines which resources can be part of a search
+    #   query result set.
+    #   @return [Types::SearchFilter]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results that you want included on each page of
+    #   the response. If you do not include this parameter, it defaults to a
+    #   value appropriate to the operation. If additional items exist beyond
+    #   those included in the current response, the `NextToken` response
+    #   element is present and has a value (is not null). Include that value
+    #   as the `NextToken` request parameter in the next call to the
+    #   operation to get the next part of the results.
+    #
+    #   <note markdown="1"> An API operation can return fewer results than the maximum even when
+    #   there are more results available. You should check `NextToken` after
+    #   every operation to ensure that you receive all of the results.
+    #
+    #    </note>
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   The parameter for receiving additional results if you receive a
+    #   `NextToken` response in a previous request. A `NextToken` response
+    #   indicates that more output is available. Set this parameter to the
+    #   value of the previous call's `NextToken` response to indicate where
+    #   the output should continue from. The pagination tokens expire after
+    #   24 hours.
+    #   @return [String]
+    #
+    # @!attribute [rw] view_arn
+    #   Specifies the Amazon resource name (ARN) of the view to use for the
+    #   query. If you don't specify a value for this parameter, then the
+    #   operation automatically uses the default view for the Amazon Web
+    #   Services Region in which you called this operation. If the Region
+    #   either doesn't have a default view or if you don't have permission
+    #   to use the default view, then the operation fails with a 401
+    #   Unauthorized exception.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListResourcesInput AWS API Documentation
+    #
+    class ListResourcesInput < Struct.new(
+      :filters,
+      :max_results,
+      :next_token,
+      :view_arn)
+      SENSITIVE = [:filters]
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   If present, indicates that more output is available than is included
+    #   in the current response. Use this value in the `NextToken` request
+    #   parameter in a subsequent call to the operation to get the next part
+    #   of the output. You should repeat this until the `NextToken` response
+    #   element comes back as `null`. The pagination tokens expire after 24
+    #   hours.
+    #   @return [String]
+    #
+    # @!attribute [rw] resources
+    #   The list of structures that describe the resources that match the
+    #   query.
+    #   @return [Array<Types::Resource>]
+    #
+    # @!attribute [rw] view_arn
+    #   The Amazon resource name (ARN) of the view that this operation used
+    #   to perform the search.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/ListResourcesOutput AWS API Documentation
+    #
+    class ListResourcesOutput < Struct.new(
+      :next_token,
+      :resources,
+      :view_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] max_results
     #   The maximum number of results that you want included on each page of
     #   the response. If you do not include this parameter, it defaults to a
@@ -981,8 +1061,8 @@ module Aws::ResourceExplorer2
     #   @return [String]
     #
     # @!attribute [rw] service
-    #   The Amazon Web Service that owns the resource and is responsible for
-    #   creating and updating it.
+    #   The Amazon Web Servicesservice that owns the resource and is
+    #   responsible for creating and updating it.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/Resource AWS API Documentation
@@ -1235,9 +1315,9 @@ module Aws::ResourceExplorer2
     #   @return [String]
     #
     # @!attribute [rw] service
-    #   The Amazon Web Service that is associated with the resource type.
-    #   This is the primary service that lets you create and interact with
-    #   resources of this type.
+    #   The Amazon Web Servicesservice that is associated with the resource
+    #   type. This is the primary service that lets you create and interact
+    #   with resources of this type.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resource-explorer-2-2022-07-28/SupportedResourceType AWS API Documentation
@@ -1556,3 +1636,4 @@ module Aws::ResourceExplorer2
 
   end
 end
+

data/lib/aws-sdk-resourceexplorer2.rb

@@ -11,17 +11,6 @@
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
-require_relative 'aws-sdk-resourceexplorer2/types'
-require_relative 'aws-sdk-resourceexplorer2/client_api'
-require_relative 'aws-sdk-resourceexplorer2/plugins/endpoints.rb'
-require_relative 'aws-sdk-resourceexplorer2/client'
-require_relative 'aws-sdk-resourceexplorer2/errors'
-require_relative 'aws-sdk-resourceexplorer2/resource'
-require_relative 'aws-sdk-resourceexplorer2/endpoint_parameters'
-require_relative 'aws-sdk-resourceexplorer2/endpoint_provider'
-require_relative 'aws-sdk-resourceexplorer2/endpoints'
-require_relative 'aws-sdk-resourceexplorer2/customizations'
-
 # This module provides support for AWS Resource Explorer. This module is available in the
 # `aws-sdk-resourceexplorer2` gem.
 #
@@ -51,7 +40,20 @@ require_relative 'aws-sdk-resourceexplorer2/customizations'
 #
 # @!group service
 module Aws::ResourceExplorer2
+  autoload :Types, 'aws-sdk-resourceexplorer2/types'
+  autoload :ClientApi, 'aws-sdk-resourceexplorer2/client_api'
+  module Plugins
+    autoload :Endpoints, 'aws-sdk-resourceexplorer2/plugins/endpoints.rb'
+  end
+  autoload :Client, 'aws-sdk-resourceexplorer2/client'
+  autoload :Errors, 'aws-sdk-resourceexplorer2/errors'
+  autoload :Resource, 'aws-sdk-resourceexplorer2/resource'
+  autoload :EndpointParameters, 'aws-sdk-resourceexplorer2/endpoint_parameters'
+  autoload :EndpointProvider, 'aws-sdk-resourceexplorer2/endpoint_provider'
+  autoload :Endpoints, 'aws-sdk-resourceexplorer2/endpoints'
 
-  GEM_VERSION = '1.26.0'
+  GEM_VERSION = '1.27.0'
 
 end
+
+require_relative 'aws-sdk-resourceexplorer2/customizations'

data/sig/client.rbs

@@ -225,6 +225,23 @@ module Aws
                                     ) -> _ListIndexesForMembersResponseSuccess
                                   | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListIndexesForMembersResponseSuccess
 
+      interface _ListResourcesResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListResourcesOutput]
+        def next_token: () -> ::String
+        def resources: () -> ::Array[Types::Resource]
+        def view_arn: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ResourceExplorer2/Client.html#list_resources-instance_method
+      def list_resources: (
+                            ?filters: {
+                              filter_string: ::String
+                            },
+                            ?max_results: ::Integer,
+                            ?next_token: ::String,
+                            ?view_arn: ::String
+                          ) -> _ListResourcesResponseSuccess
+                        | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListResourcesResponseSuccess
+
       interface _ListSupportedResourceTypesResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListSupportedResourceTypesOutput]
         def next_token: () -> ::String

data/sig/types.rbs

@@ -172,6 +172,21 @@ module Aws::ResourceExplorer2
       SENSITIVE: []
     end
 
+    class ListResourcesInput
+      attr_accessor filters: Types::SearchFilter
+      attr_accessor max_results: ::Integer
+      attr_accessor next_token: ::String
+      attr_accessor view_arn: ::String
+      SENSITIVE: [:filters]
+    end
+
+    class ListResourcesOutput
+      attr_accessor next_token: ::String
+      attr_accessor resources: ::Array[Types::Resource]
+      attr_accessor view_arn: ::String
+      SENSITIVE: []
+    end
+
     class ListSupportedResourceTypesInput
       attr_accessor max_results: ::Integer
       attr_accessor next_token: ::String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-resourceexplorer2
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.27.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.5'
 description: Official AWS Ruby gem for AWS Resource Explorer. This gem is part of
   the AWS SDK for Ruby.
 email: