aws-sdk-storagegateway 1.105.0 → 1.106.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc313a01a40ff763bff38e7cfc9a7511e0cde24d6889b9d05462ad72393b9068
-  data.tar.gz: aa91df19b7b4cd3238d182e5700146364070df584b000ebb861ffd12d37b1a52
+  metadata.gz: 23969e1ab5f1fbbc9ba764a39c665dc968b9eae98a57da4a32b3f24a71181a1a
+  data.tar.gz: b48277ef7bea6583d9baa8db9adb75568dd80a34337b15614303ff421cb2e9f4
 SHA512:
-  metadata.gz: c38510d1462cf285ddeeb15051e160b070f7ae43223dfd4bc6232b418ec7dd7564b58a0e58a00ec7c785c492182f0b445c8c0c128611da64bc178ca9a7926c99
-  data.tar.gz: a9a4006ce68887d65dce98ac81f7bf477a085f004e79cfe217f969d79ed1fd448d64a70bd8c19f0c05436d08dea47878661466f1ff153d0eb0aaa00f26ba7130
+  metadata.gz: 7de06e238242145fb9715a811a9da5027b17887b5d29ef4a47ed60dfe92662999cbc8921da5514b49777388fc0e213d0fae2d0e6da335b610354b7dfabc3f885
+  data.tar.gz: cb506ccd53b20d9c18f12e4fb58d24f17d5c1adde7ddd28bc0e67d7d1f933c3e8ad71efb6755e7ce6cf603f7bed3871f9c3451007d2f62fab94527a770a6337d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.106.0 (2025-02-27)
+------------------
+
+* Feature - This release adds support to invoke a process that cleans the specified file share's cache of file entries that are failing upload to Amazon S3.
+
 1.105.0 (2025-02-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.105.0
+1.106.0

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

@@ -4941,6 +4941,67 @@ module Aws::StorageGateway
       req.send_request(options)
     end
 
+    # Starts a process that cleans the specified file share's cache of file
+    # entries that are failing upload to Amazon S3. This API operation
+    # reports success if the request is received with valid arguments, and
+    # there are no other cache clean operations currently in-progress for
+    # the specified file share. After a successful request, the cache clean
+    # operation occurs asynchronously and reports progress using CloudWatch
+    # logs and notifications.
+    #
+    # If `ForceRemove` is set to `True`, the cache clean operation will
+    # delete file data from the gateway which might otherwise be
+    # recoverable. We recommend using this operation only after all other
+    # methods to clear files failing upload have been exhausted, and if your
+    # business need outweighs the potential data loss.
+    #
+    # @option params [required, String] :file_share_arn
+    #   The Amazon Resource Name (ARN) of the file share for which you want to
+    #   start the cache clean operation.
+    #
+    # @option params [Boolean] :force_remove
+    #   Specifies whether cache entries with full or partial file data
+    #   currently stored on the gateway will be forcibly removed by the cache
+    #   clean operation.
+    #
+    #   Valid arguments:
+    #
+    #   * `False` - The cache clean operation skips cache entries failing
+    #     upload if they are associated with data currently stored on the
+    #     gateway. This preserves the cached data.
+    #
+    #   * `True` - The cache clean operation removes cache entries failing
+    #     upload even if they are associated with data currently stored on the
+    #     gateway. This deletes the cached data.
+    #
+    #     If `ForceRemove` is set to `True`, the cache clean operation will
+    #     delete file data from the gateway which might otherwise be
+    #     recoverable.
+    #
+    # @return [Types::EvictFilesFailingUploadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::EvictFilesFailingUploadOutput#notification_id #notification_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.evict_files_failing_upload({
+    #     file_share_arn: "FileShareARN", # required
+    #     force_remove: false,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.notification_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/EvictFilesFailingUpload AWS API Documentation
+    #
+    # @overload evict_files_failing_upload(params = {})
+    # @param [Hash] params ({})
+    def evict_files_failing_upload(params = {}, options = {})
+      req = build_request(:evict_files_failing_upload, params)
+      req.send_request(options)
+    end
+
     # Adds a file gateway to an Active Directory domain. This operation is
     # only supported for file gateways that support the SMB file protocol.
     #
@@ -7906,7 +7967,7 @@ module Aws::StorageGateway
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-storagegateway'
-      context[:gem_version] = '1.105.0'
+      context[:gem_version] = '1.106.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -186,6 +186,8 @@ module Aws::StorageGateway
     EndpointNetworkConfiguration = Shapes::StructureShape.new(name: 'EndpointNetworkConfiguration')
     EndpointType = Shapes::StringShape.new(name: 'EndpointType')
     ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
+    EvictFilesFailingUploadInput = Shapes::StructureShape.new(name: 'EvictFilesFailingUploadInput')
+    EvictFilesFailingUploadOutput = Shapes::StructureShape.new(name: 'EvictFilesFailingUploadOutput')
     FileShareARN = Shapes::StringShape.new(name: 'FileShareARN')
     FileShareARNList = Shapes::ListShape.new(name: 'FileShareARNList')
     FileShareClientList = Shapes::ListShape.new(name: 'FileShareClientList')
@@ -1060,6 +1062,13 @@ module Aws::StorageGateway
     EndpointNetworkConfiguration.add_member(:ip_addresses, Shapes::ShapeRef.new(shape: IpAddressList, location_name: "IpAddresses"))
     EndpointNetworkConfiguration.struct_class = Types::EndpointNetworkConfiguration
 
+    EvictFilesFailingUploadInput.add_member(:file_share_arn, Shapes::ShapeRef.new(shape: FileShareARN, required: true, location_name: "FileShareARN"))
+    EvictFilesFailingUploadInput.add_member(:force_remove, Shapes::ShapeRef.new(shape: boolean, location_name: "ForceRemove"))
+    EvictFilesFailingUploadInput.struct_class = Types::EvictFilesFailingUploadInput
+
+    EvictFilesFailingUploadOutput.add_member(:notification_id, Shapes::ShapeRef.new(shape: string, location_name: "NotificationId"))
+    EvictFilesFailingUploadOutput.struct_class = Types::EvictFilesFailingUploadOutput
+
     FileShareARNList.member = Shapes::ShapeRef.new(shape: FileShareARN)
 
     FileShareClientList.member = Shapes::ShapeRef.new(shape: IPV4AddressCIDR)
@@ -2314,6 +2323,16 @@ module Aws::StorageGateway
         o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
       end)
 
+      api.add_operation(:evict_files_failing_upload, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "EvictFilesFailingUpload"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: EvictFilesFailingUploadInput)
+        o.output = Shapes::ShapeRef.new(shape: EvictFilesFailingUploadOutput)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidGatewayRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
+      end)
+
       api.add_operation(:join_domain, Seahorse::Model::Operation.new.tap do |o|
         o.name = "JoinDomain"
         o.http_method = "POST"

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

@@ -4203,6 +4203,53 @@ module Aws::StorageGateway
       include Aws::Structure
     end
 
+    # @!attribute [rw] file_share_arn
+    #   The Amazon Resource Name (ARN) of the file share for which you want
+    #   to start the cache clean operation.
+    #   @return [String]
+    #
+    # @!attribute [rw] force_remove
+    #   Specifies whether cache entries with full or partial file data
+    #   currently stored on the gateway will be forcibly removed by the
+    #   cache clean operation.
+    #
+    #   Valid arguments:
+    #
+    #   * `False` - The cache clean operation skips cache entries failing
+    #     upload if they are associated with data currently stored on the
+    #     gateway. This preserves the cached data.
+    #
+    #   * `True` - The cache clean operation removes cache entries failing
+    #     upload even if they are associated with data currently stored on
+    #     the gateway. This deletes the cached data.
+    #
+    #     If `ForceRemove` is set to `True`, the cache clean operation will
+    #     delete file data from the gateway which might otherwise be
+    #     recoverable.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/EvictFilesFailingUploadInput AWS API Documentation
+    #
+    class EvictFilesFailingUploadInput < Struct.new(
+      :file_share_arn,
+      :force_remove)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] notification_id
+    #   The randomly generated ID of the CloudWatch notification associated
+    #   with the cache clean operation. This ID is in UUID format.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/EvictFilesFailingUploadOutput AWS API Documentation
+    #
+    class EvictFilesFailingUploadOutput < Struct.new(
+      :notification_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Describes a file share. Only supported S3 File Gateway.
     #
     # @!attribute [rw] file_share_type

data/lib/aws-sdk-storagegateway.rb

@@ -54,7 +54,7 @@ module Aws::StorageGateway
   autoload :EndpointProvider, 'aws-sdk-storagegateway/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-storagegateway/endpoints'
 
-  GEM_VERSION = '1.105.0'
+  GEM_VERSION = '1.106.0'
 
 end
 

data/sig/client.rbs

@@ -903,6 +903,17 @@ module Aws
                                     ) -> _DisassociateFileSystemResponseSuccess
                                   | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateFileSystemResponseSuccess
 
+      interface _EvictFilesFailingUploadResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::EvictFilesFailingUploadOutput]
+        def notification_id: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/StorageGateway/Client.html#evict_files_failing_upload-instance_method
+      def evict_files_failing_upload: (
+                                        file_share_arn: ::String,
+                                        ?force_remove: bool
+                                      ) -> _EvictFilesFailingUploadResponseSuccess
+                                    | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _EvictFilesFailingUploadResponseSuccess
+
       interface _JoinDomainResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::JoinDomainOutput]
         def gateway_arn: () -> ::String

data/sig/types.rbs

@@ -863,6 +863,17 @@ module Aws::StorageGateway
       SENSITIVE: []
     end
 
+    class EvictFilesFailingUploadInput
+      attr_accessor file_share_arn: ::String
+      attr_accessor force_remove: bool
+      SENSITIVE: []
+    end
+
+    class EvictFilesFailingUploadOutput
+      attr_accessor notification_id: ::String
+      SENSITIVE: []
+    end
+
     class FileShareInfo
       attr_accessor file_share_type: ("NFS" | "SMB")
       attr_accessor file_share_arn: ::String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-storagegateway
 version: !ruby/object:Gem::Version
-  version: 1.105.0
+  version: 1.106.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 2025-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core