aws-sdk-storagegateway 1.105.0 → 1.107.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc313a01a40ff763bff38e7cfc9a7511e0cde24d6889b9d05462ad72393b9068
-  data.tar.gz: aa91df19b7b4cd3238d182e5700146364070df584b000ebb861ffd12d37b1a52
+  metadata.gz: 294f3e4b1718b23d2c7ceb0426664444f3ce175980796cc009cb195b6e1ad524
+  data.tar.gz: 5ae2ac579b0fc1802377f3d7ccce594a4671ab324ae9eaf9f9c30e07ea87204f
 SHA512:
-  metadata.gz: c38510d1462cf285ddeeb15051e160b070f7ae43223dfd4bc6232b418ec7dd7564b58a0e58a00ec7c785c492182f0b445c8c0c128611da64bc178ca9a7926c99
-  data.tar.gz: a9a4006ce68887d65dce98ac81f7bf477a085f004e79cfe217f969d79ed1fd448d64a70bd8c19f0c05436d08dea47878661466f1ff153d0eb0aaa00f26ba7130
+  metadata.gz: 91c81bae5ab67ff37f5e1f62c9299d675d5013e166aaf4c53a3a08feb3e0964a1210071df1eae8204cd9b3b7a904b470734c6e1bcff60dee03cc26fc9a4104af
+  data.tar.gz: bf0730a0bc68f65949ccf326309e1535609fa8e2f8eda60d8bd9b97258647069c64eb44b2185606d8b84f3816d7f8452e30c24f7d1d7db0815f614f620faea16

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.107.0 (2025-04-08)
+------------------
+
+* Feature - Added new ActiveDirectoryStatus value, ListCacheReports paginator, and support for longer pagination tokens.
+
+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.107.0

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

@@ -4063,7 +4063,7 @@ module Aws::StorageGateway
     #
     #   resp.gateway_arn #=> String
     #   resp.domain_name #=> String
-    #   resp.active_directory_status #=> String, one of "ACCESS_DENIED", "DETACHED", "JOINED", "JOINING", "NETWORK_ERROR", "TIMEOUT", "UNKNOWN_ERROR"
+    #   resp.active_directory_status #=> String, one of "ACCESS_DENIED", "DETACHED", "JOINED", "JOINING", "NETWORK_ERROR", "TIMEOUT", "UNKNOWN_ERROR", "INSUFFICIENT_PERMISSIONS"
     #   resp.smb_guest_password_set #=> Boolean
     #   resp.smb_security_strategy #=> String, one of "ClientSpecified", "MandatorySigning", "MandatoryEncryption", "MandatoryEncryptionNoAes128"
     #   resp.file_shares_visible #=> Boolean
@@ -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.
     #
@@ -5011,7 +5072,7 @@ module Aws::StorageGateway
     # @example Response structure
     #
     #   resp.gateway_arn #=> String
-    #   resp.active_directory_status #=> String, one of "ACCESS_DENIED", "DETACHED", "JOINED", "JOINING", "NETWORK_ERROR", "TIMEOUT", "UNKNOWN_ERROR"
+    #   resp.active_directory_status #=> String, one of "ACCESS_DENIED", "DETACHED", "JOINED", "JOINING", "NETWORK_ERROR", "TIMEOUT", "UNKNOWN_ERROR", "INSUFFICIENT_PERMISSIONS"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/JoinDomain AWS API Documentation
     #
@@ -5079,6 +5140,8 @@ module Aws::StorageGateway
     #   * {Types::ListCacheReportsOutput#cache_report_list #cache_report_list} => Array<Types::CacheReportInfo>
     #   * {Types::ListCacheReportsOutput#marker #marker} => 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_cache_reports({
@@ -6421,7 +6484,8 @@ module Aws::StorageGateway
     #   S3.
     #
     # @option params [required, String] :location_arn
-    #   The ARN of the Amazon S3 bucket where the cache report will be saved.
+    #   The ARN of the Amazon S3 bucket where you want to save the cache
+    #   report.
     #
     #   <note markdown="1"> We do not recommend saving the cache report to the same Amazon S3
     #   bucket for which you are generating the report.
@@ -6431,8 +6495,8 @@ module Aws::StorageGateway
     #    </note>
     #
     # @option params [required, String] :bucket_region
-    #   The Amazon Web Services Region of the Amazon S3 bucket associated with
-    #   the file share for which you want to generate the cache report.
+    #   The Amazon Web Services Region of the Amazon S3 bucket where you want
+    #   to save the cache report.
     #
     # @option params [String] :vpc_endpoint_dns_name
     #   The DNS name of the VPC endpoint associated with the Amazon S3 where
@@ -7906,7 +7970,7 @@ module Aws::StorageGateway
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-storagegateway'
-      context[:gem_version] = '1.105.0'
+      context[:gem_version] = '1.107.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"
@@ -2342,6 +2361,11 @@ module Aws::StorageGateway
         o.output = Shapes::ShapeRef.new(shape: ListCacheReportsOutput)
         o.errors << Shapes::ShapeRef.new(shape: InvalidGatewayRequestException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
+        o[:pager] = Aws::Pager.new(
+          tokens: {
+            "marker" => "marker"
+          }
+        )
       end)
 
       api.add_operation(:list_file_shares, Seahorse::Model::Operation.new.tap do |o|

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
@@ -4580,6 +4627,10 @@ module Aws::StorageGateway
     #
     #   * `JOINING`: Indicates that a `JoinDomain` operation is in progress.
     #
+    #   * `INSUFFICIENT_PERMISSIONS`: Indicates that the `JoinDomain`
+    #     operation failed because the specified user lacks the necessary
+    #     permissions to join the domain.
+    #
     #   * `NETWORK_ERROR`: Indicates that `JoinDomain` operation failed due
     #     to a network or connectivity error.
     #
@@ -6340,8 +6391,8 @@ module Aws::StorageGateway
     #   @return [String]
     #
     # @!attribute [rw] location_arn
-    #   The ARN of the Amazon S3 bucket where the cache report will be
-    #   saved.
+    #   The ARN of the Amazon S3 bucket where you want to save the cache
+    #   report.
     #
     #   <note markdown="1"> We do not recommend saving the cache report to the same Amazon S3
     #   bucket for which you are generating the report.
@@ -6352,8 +6403,8 @@ module Aws::StorageGateway
     #   @return [String]
     #
     # @!attribute [rw] bucket_region
-    #   The Amazon Web Services Region of the Amazon S3 bucket associated
-    #   with the file share for which you want to generate the cache report.
+    #   The Amazon Web Services Region of the Amazon S3 bucket where you
+    #   want to save the cache report.
     #   @return [String]
     #
     # @!attribute [rw] vpc_endpoint_dns_name

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.107.0'
 
 end
 

data/sig/client.rbs

@@ -752,7 +752,7 @@ module Aws
         include ::Seahorse::Client::_ResponseSuccess[Types::DescribeSMBSettingsOutput]
         def gateway_arn: () -> ::String
         def domain_name: () -> ::String
-        def active_directory_status: () -> ("ACCESS_DENIED" | "DETACHED" | "JOINED" | "JOINING" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN_ERROR")
+        def active_directory_status: () -> ("ACCESS_DENIED" | "DETACHED" | "JOINED" | "JOINING" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN_ERROR" | "INSUFFICIENT_PERMISSIONS")
         def smb_guest_password_set: () -> bool
         def smb_security_strategy: () -> ("ClientSpecified" | "MandatorySigning" | "MandatoryEncryption" | "MandatoryEncryptionNoAes128")
         def file_shares_visible: () -> bool
@@ -903,10 +903,21 @@ 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
-        def active_directory_status: () -> ("ACCESS_DENIED" | "DETACHED" | "JOINED" | "JOINING" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN_ERROR")
+        def active_directory_status: () -> ("ACCESS_DENIED" | "DETACHED" | "JOINED" | "JOINING" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN_ERROR" | "INSUFFICIENT_PERMISSIONS")
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/StorageGateway/Client.html#join_domain-instance_method
       def join_domain: (

data/sig/types.rbs

@@ -691,7 +691,7 @@ module Aws::StorageGateway
     class DescribeSMBSettingsOutput
       attr_accessor gateway_arn: ::String
       attr_accessor domain_name: ::String
-      attr_accessor active_directory_status: ("ACCESS_DENIED" | "DETACHED" | "JOINED" | "JOINING" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN_ERROR")
+      attr_accessor active_directory_status: ("ACCESS_DENIED" | "DETACHED" | "JOINED" | "JOINING" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN_ERROR" | "INSUFFICIENT_PERMISSIONS")
       attr_accessor smb_guest_password_set: bool
       attr_accessor smb_security_strategy: ("ClientSpecified" | "MandatorySigning" | "MandatoryEncryption" | "MandatoryEncryptionNoAes128")
       attr_accessor file_shares_visible: bool
@@ -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
@@ -938,7 +949,7 @@ module Aws::StorageGateway
 
     class JoinDomainOutput
       attr_accessor gateway_arn: ::String
-      attr_accessor active_directory_status: ("ACCESS_DENIED" | "DETACHED" | "JOINED" | "JOINING" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN_ERROR")
+      attr_accessor active_directory_status: ("ACCESS_DENIED" | "DETACHED" | "JOINED" | "JOINING" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN_ERROR" | "INSUFFICIENT_PERMISSIONS")
       SENSITIVE: []
     end
 

metadata

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