aws-sdk-storagegateway 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1253af7d41d98b900ddf7a3568241db2edcd5762
-  data.tar.gz: 9ee34f6b47c29faa04184bd5e2caaf5265ad035c
+  metadata.gz: 66dbb2bbfc322b79addf246c098f96926e4b2fdd
+  data.tar.gz: 7b34670d0560b5c37c80576f35a0cb4658ba916c
 SHA512:
-  metadata.gz: 35552458dec75973e9cf27422102655e2f2463b89a4eb610f75a715315ca8d484995a6f8ab4787fa4d3cb8dc9f6b7353639eb902c4b0860359bce34da55c0470
-  data.tar.gz: 81eba7e7ea840dc61b329ed78f12cdee72aa9b8df8f5285219d89ed61bab1d6739e0e78b353bc460dd2a917dafeca6bb87be219f00b99cbf06a9c2e15b71fec4
+  metadata.gz: 3595e20b3dd4f9627c83bc010e729ebd90acc7d637a09c72fc4c2e1bf22d8d52bd27fd70e241384562080826ee36257f9bb03a7ce1cf84b2a44f03dd9c95d2ec
+  data.tar.gz: 3b7ceacc7a346fbf4a19a39da66f06c4cecba5cdfe1d7cd349611335e0cca0486609c70bf71216bd24107ee2109904a5bc606e835204bfeea4bf889fd9ee6787

data/lib/aws-sdk-storagegateway.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-storagegateway/customizations'
 # @service
 module Aws::StorageGateway
 
-  GEM_VERSION = '1.5.0'
+  GEM_VERSION = '1.6.0'
 
 end

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

@@ -689,10 +689,25 @@ module Aws::StorageGateway
     #   operation to return a list of gateways for your account and region.
     #
     # @option params [required, Integer] :volume_size_in_bytes
+    #   The size of the volume in bytes.
     #
     # @option params [String] :snapshot_id
+    #   The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as
+    #   the new cached volume. Specify this field if you want to create the
+    #   iSCSI storage volume from a snapshot otherwise do not include this
+    #   field. To list snapshots for your account use [DescribeSnapshots][1]
+    #   in the *Amazon Elastic Compute Cloud API Reference*.
+    #
+    #
+    #
+    #   [1]: http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
     #
     # @option params [required, String] :target_name
+    #   The name of the iSCSI target used by initiators to connect to the
+    #   target and as a suffix for the target ARN. For example, specifying
+    #   `TargetName` as *myvolume* results in the target ARN of
+    #   arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume.
+    #   The target name must be unique across all volumes of a gateway.
     #
     # @option params [String] :source_volume_arn
     #   The ARN for an existing volume. Specifying this ARN makes the new
@@ -701,8 +716,17 @@ module Aws::StorageGateway
     #   be equal to or larger than the size of the existing volume, in bytes.
     #
     # @option params [required, String] :network_interface_id
+    #   The network interface of the gateway on which to expose the iSCSI
+    #   target. Only IPv4 addresses are accepted. Use
+    #   DescribeGatewayInformation to get a list of the network interfaces
+    #   available on a gateway.
+    #
+    #   Valid Values: A valid IP address.
     #
     # @option params [required, String] :client_token
+    #   A unique identifier that you use to retry a request. If you retry a
+    #   request, use the same `ClientToken` you specified in the initial
+    #   request.
     #
     # @option params [Boolean] :kms_encrypted
     #   True to use Amazon S3 server side encryption with your own AWS KMS
@@ -766,10 +790,10 @@ module Aws::StorageGateway
       req.send_request(options)
     end
 
-    # Creates a file share on an existing file gateway. In Storage Gateway,
-    # a file share is a file system mount point backed by Amazon S3 cloud
-    # storage. Storage Gateway exposes file shares using a Network File
-    # System (NFS) interface. This operation is only supported in the file
+    # Creates a Network File System (NFS) file share on an existing file
+    # gateway. In Storage Gateway, a file share is a file system mount point
+    # backed by Amazon S3 cloud storage. Storage Gateway exposes file shares
+    # using a NFS interface. This operation is only supported in the file
     # gateway type.
     #
     # File gateway requires AWS Security Token Service (AWS STS) to be
@@ -888,6 +912,123 @@ module Aws::StorageGateway
       req.send_request(options)
     end
 
+    # Creates a Server Message Block (SMB) file share on an existing file
+    # gateway. In Storage Gateway, a file share is a file system mount point
+    # backed by Amazon S3 cloud storage. Storage Gateway expose file shares
+    # using a SMB interface. This operation is only supported in the file
+    # gateway type.
+    #
+    # File gateway requires AWS Security Token Service (AWS STS) to be
+    # activated to enable you create a file share. Make sure AWS STS is
+    # activated in the region you are creating your file gateway in. If AWS
+    # STS is not activated in the region, activate it. For information about
+    # how to activate AWS STS, see Activating and Deactivating AWS STS in an
+    # AWS Region in the AWS Identity and Access Management User Guide.
+    #
+    #  File gateway does not support creating hard or symbolic links on a
+    # file share.
+    #
+    # @option params [required, String] :client_token
+    #   A unique string value that you supply that is used by file gateway to
+    #   ensure idempotent file share creation.
+    #
+    # @option params [required, String] :gateway_arn
+    #   The Amazon Resource Name (ARN) of the file gateway on which you want
+    #   to create a file share.
+    #
+    # @option params [Boolean] :kms_encrypted
+    #   True to use Amazon S3 server side encryption with your own AWS KMS
+    #   key, or false to use a key managed by Amazon S3. Optional.
+    #
+    # @option params [String] :kms_key
+    #   The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side
+    #   encryption. This value can only be set when KMSEncrypted is true.
+    #   Optional.
+    #
+    # @option params [required, String] :role
+    #   The ARN of the AWS Identity and Access Management (IAM) role that a
+    #   file gateway assumes when it accesses the underlying storage.
+    #
+    # @option params [required, String] :location_arn
+    #   The ARN of the backed storage used for storing file data.
+    #
+    # @option params [String] :default_storage_class
+    #   The default storage class for objects put into an Amazon S3 bucket by
+    #   file gateway. Possible values are S3\_STANDARD, S3\_STANDARD\_IA or
+    #   S3\_ONEZONE\_IA. If this field is not populated, the default value
+    #   S3\_STANDARD is used. Optional.
+    #
+    # @option params [String] :object_acl
+    #   Sets the access control list permission for objects in the Amazon S3
+    #   bucket that a file gateway puts objects into. The default value is
+    #   "private".
+    #
+    # @option params [Boolean] :read_only
+    #   Sets the write status of a file share. This value is true if the write
+    #   status is read-only, and otherwise false.
+    #
+    # @option params [Boolean] :guess_mime_type_enabled
+    #   Enables guessing of the MIME type for uploaded objects based on file
+    #   extensions. Set this value to true to enable MIME type guessing, and
+    #   otherwise to false. The default value is true.
+    #
+    # @option params [Boolean] :requester_pays
+    #   Sets who pays the cost of the request and the data download from the
+    #   Amazon S3 bucket. Set this value to true if you want the requester to
+    #   pay instead of the bucket owner, and otherwise to false.
+    #
+    # @option params [Array<String>] :valid_user_list
+    #   A list of users in the Active Directory that are allowed to access the
+    #   file share. Can only be set if Authentication is set to
+    #   "ActiveDirectory".
+    #
+    # @option params [Array<String>] :invalid_user_list
+    #   A list of users in the Active Directory that are not allowed to access
+    #   the file share. Can only be set if Authentication is set to
+    #   "ActiveDirectory".
+    #
+    # @option params [String] :authentication
+    #   The authentication method that users use to access the file share.
+    #
+    #   Valid values: "ActiveDirectory" or "GuestAccess". The default is
+    #   "ActiveDirectory".
+    #
+    # @return [Types::CreateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateSMBFileShareOutput#file_share_arn #file_share_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_smb_file_share({
+    #     client_token: "ClientToken", # required
+    #     gateway_arn: "GatewayARN", # required
+    #     kms_encrypted: false,
+    #     kms_key: "KMSKey",
+    #     role: "Role", # required
+    #     location_arn: "LocationARN", # required
+    #     default_storage_class: "StorageClass",
+    #     object_acl: "private", # accepts private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control, aws-exec-read
+    #     read_only: false,
+    #     guess_mime_type_enabled: false,
+    #     requester_pays: false,
+    #     valid_user_list: ["FileShareUser"],
+    #     invalid_user_list: ["FileShareUser"],
+    #     authentication: "Authentication",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.file_share_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/CreateSMBFileShare AWS API Documentation
+    #
+    # @overload create_smb_file_share(params = {})
+    # @param [Hash] params ({})
+    def create_smb_file_share(params = {}, options = {})
+      req = build_request(:create_smb_file_share, params)
+      req.send_request(options)
+    end
+
     # Initiates a snapshot of a volume.
     #
     # AWS Storage Gateway provides the ability to back up point-in-time
@@ -2171,8 +2312,9 @@ module Aws::StorageGateway
       req.send_request(options)
     end
 
-    # Gets a description for one or more file shares from a file gateway.
-    # This operation is only supported in the file gateway type.
+    # Gets a description for one or more Network File System (NFS) file
+    # shares from a file gateway. This operation is only supported in the
+    # file gateway type.
     #
     # @option params [required, Array<String>] :file_share_arn_list
     #   An array containing the Amazon Resource Name (ARN) of each file share
@@ -2222,6 +2364,91 @@ module Aws::StorageGateway
       req.send_request(options)
     end
 
+    # Gets a description for one or more Server Message Block (SMB) file
+    # shares from a file gateway. This operation is only supported in the
+    # file gateway type.
+    #
+    # @option params [required, Array<String>] :file_share_arn_list
+    #   An array containing the Amazon Resource Name (ARN) of each file share
+    #   to be described.
+    #
+    # @return [Types::DescribeSMBFileSharesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeSMBFileSharesOutput#smb_file_share_info_list #smb_file_share_info_list} => Array&lt;Types::SMBFileShareInfo&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_smb_file_shares({
+    #     file_share_arn_list: ["FileShareARN"], # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.smb_file_share_info_list #=> Array
+    #   resp.smb_file_share_info_list[0].file_share_arn #=> String
+    #   resp.smb_file_share_info_list[0].file_share_id #=> String
+    #   resp.smb_file_share_info_list[0].file_share_status #=> String
+    #   resp.smb_file_share_info_list[0].gateway_arn #=> String
+    #   resp.smb_file_share_info_list[0].kms_encrypted #=> Boolean
+    #   resp.smb_file_share_info_list[0].kms_key #=> String
+    #   resp.smb_file_share_info_list[0].path #=> String
+    #   resp.smb_file_share_info_list[0].role #=> String
+    #   resp.smb_file_share_info_list[0].location_arn #=> String
+    #   resp.smb_file_share_info_list[0].default_storage_class #=> String
+    #   resp.smb_file_share_info_list[0].object_acl #=> String, one of "private", "public-read", "public-read-write", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control", "aws-exec-read"
+    #   resp.smb_file_share_info_list[0].read_only #=> Boolean
+    #   resp.smb_file_share_info_list[0].guess_mime_type_enabled #=> Boolean
+    #   resp.smb_file_share_info_list[0].requester_pays #=> Boolean
+    #   resp.smb_file_share_info_list[0].valid_user_list #=> Array
+    #   resp.smb_file_share_info_list[0].valid_user_list[0] #=> String
+    #   resp.smb_file_share_info_list[0].invalid_user_list #=> Array
+    #   resp.smb_file_share_info_list[0].invalid_user_list[0] #=> String
+    #   resp.smb_file_share_info_list[0].authentication #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBFileShares AWS API Documentation
+    #
+    # @overload describe_smb_file_shares(params = {})
+    # @param [Hash] params ({})
+    def describe_smb_file_shares(params = {}, options = {})
+      req = build_request(:describe_smb_file_shares, params)
+      req.send_request(options)
+    end
+
+    # Gets a description of a Server Message Block (SMB) file share settings
+    # from a file gateway. This operation is only supported in the file
+    # gateway type.
+    #
+    # @option params [required, String] :gateway_arn
+    #   The Amazon Resource Name (ARN) of the gateway. Use the ListGateways
+    #   operation to return a list of gateways for your account and region.
+    #
+    # @return [Types::DescribeSMBSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeSMBSettingsOutput#gateway_arn #gateway_arn} => String
+    #   * {Types::DescribeSMBSettingsOutput#domain_name #domain_name} => String
+    #   * {Types::DescribeSMBSettingsOutput#smb_guest_password_set #smb_guest_password_set} => Boolean
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_smb_settings({
+    #     gateway_arn: "GatewayARN", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.gateway_arn #=> String
+    #   resp.domain_name #=> String
+    #   resp.smb_guest_password_set #=> Boolean
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/DescribeSMBSettings AWS API Documentation
+    #
+    # @overload describe_smb_settings(params = {})
+    # @param [Hash] params ({})
+    def describe_smb_settings(params = {}, options = {})
+      req = build_request(:describe_smb_settings, params)
+      req.send_request(options)
+    end
+
     # Describes the snapshot schedule for the specified gateway volume. The
     # snapshot schedule information includes intervals at which snapshots
     # are automatically initiated on the volume. This operation is only
@@ -2963,6 +3190,51 @@ module Aws::StorageGateway
       req.send_request(options)
     end
 
+    # Adds a file gateway to an Active Directory domain. This operation is
+    # only supported in the file gateway type that supports the SMB file
+    # protocol.
+    #
+    # @option params [required, String] :gateway_arn
+    #   The unique Amazon Resource Name of the file gateway you want to add to
+    #   the Active Directory domain.
+    #
+    # @option params [required, String] :domain_name
+    #   The name of the domain that you want the gateway to join.
+    #
+    # @option params [required, String] :user_name
+    #   Sets the user name of user who has permission to add the gateway to
+    #   the Active Directory domain.
+    #
+    # @option params [required, String] :password
+    #   Sets the password of the user who has permission to add the gateway to
+    #   the Active Directory domain.
+    #
+    # @return [Types::JoinDomainOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::JoinDomainOutput#gateway_arn #gateway_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.join_domain({
+    #     gateway_arn: "GatewayARN", # required
+    #     domain_name: "DomainName", # required
+    #     user_name: "DomainUserName", # required
+    #     password: "DomainUserPassword", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.gateway_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/JoinDomain AWS API Documentation
+    #
+    # @overload join_domain(params = {})
+    # @param [Hash] params ({})
+    def join_domain(params = {}, options = {})
+      req = build_request(:join_domain, params)
+      req.send_request(options)
+    end
+
     # Gets a list of the file shares for a specific file gateway, or the
     # list of file shares that belong to the calling user account. This
     # operation is only supported in the file gateway type.
@@ -3000,6 +3272,7 @@ module Aws::StorageGateway
     #   resp.marker #=> String
     #   resp.next_marker #=> String
     #   resp.file_share_info_list #=> Array
+    #   resp.file_share_info_list[0].file_share_type #=> String, one of "NFS", "SMB"
     #   resp.file_share_info_list[0].file_share_arn #=> String
     #   resp.file_share_info_list[0].file_share_id #=> String
     #   resp.file_share_info_list[0].file_share_status #=> String
@@ -3857,6 +4130,41 @@ module Aws::StorageGateway
       req.send_request(options)
     end
 
+    # Sets the password for the guest user “smbguest”. "smbguest" is the
+    # user when the Authentication method for the file share is
+    # “GuestAccess”.
+    #
+    # @option params [required, String] :gateway_arn
+    #   The Amazon Resource Name (ARN) of the file gateway the SMB file share
+    #   is associated with.
+    #
+    # @option params [required, String] :password
+    #   The password you want to set for your SMB Server.
+    #
+    # @return [Types::SetSMBGuestPasswordOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::SetSMBGuestPasswordOutput#gateway_arn #gateway_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.set_smb_guest_password({
+    #     gateway_arn: "GatewayARN", # required
+    #     password: "SMBGuestPassword", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.gateway_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/SetSMBGuestPassword AWS API Documentation
+    #
+    # @overload set_smb_guest_password(params = {})
+    # @param [Hash] params ({})
+    def set_smb_guest_password(params = {}, options = {})
+      req = build_request(:set_smb_guest_password, params)
+      req.send_request(options)
+    end
+
     # Shuts down a gateway. To specify which gateway to shut down, use the
     # Amazon Resource Name (ARN) of the gateway in the body of your request.
     #
@@ -4322,8 +4630,8 @@ module Aws::StorageGateway
       req.send_request(options)
     end
 
-    # Updates a file share. This operation is only supported in the file
-    # gateway type.
+    # Updates a Network File System (NFS) file share. This operation is only
+    # supported in the file gateway type.
     #
     # <note markdown="1"> To leave a file share field unchanged, set the corresponding input
     # field to null.
@@ -4438,6 +4746,105 @@ module Aws::StorageGateway
       req.send_request(options)
     end
 
+    # Updates a Server Message Block (SMB) file share. This operation is
+    # only supported in the file gateway type.
+    #
+    # <note markdown="1"> To leave a file share field unchanged, set the corresponding input
+    # field to null. This operation is only supported in the file gateway
+    # type.
+    #
+    #  </note>
+    #
+    # File gateway requires AWS Security Token Service (AWS STS) to be
+    # activated to enable you create a file share. Make sure AWS STS is
+    # activated in the region you are creating your file gateway in. If AWS
+    # STS is not activated in the region, activate it. For information about
+    # how to activate AWS STS, see Activating and Deactivating AWS STS in an
+    # AWS Region in the AWS Identity and Access Management User Guide.
+    #
+    #  File gateway does not support creating hard or symbolic links on a
+    # file share.
+    #
+    # @option params [required, String] :file_share_arn
+    #   The Amazon Resource Name (ARN) of the SMB file share you want to
+    #   update.
+    #
+    # @option params [Boolean] :kms_encrypted
+    #   True to use Amazon S3 server side encryption with your own AWS KMS
+    #   key, or false to use a key managed by Amazon S3. Optional.
+    #
+    # @option params [String] :kms_key
+    #   The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side
+    #   encryption. This value can only be set when KMSEncrypted is true.
+    #   Optional.
+    #
+    # @option params [String] :default_storage_class
+    #   The default storage class for objects put into an Amazon S3 bucket by
+    #   file gateway. Possible values are S3\_STANDARD, S3\_STANDARD\_IA or
+    #   S3\_ONEZONE\_IA. If this field is not populated, the default value
+    #   S3\_STANDARD is used. Optional.
+    #
+    # @option params [String] :object_acl
+    #   Sets the access control list permission for objects in the Amazon S3
+    #   bucket that a file gateway puts objects into. The default value is
+    #   "private".
+    #
+    # @option params [Boolean] :read_only
+    #   Sets the write status of a file share. This value is true if the write
+    #   status is read-only, and otherwise false.
+    #
+    # @option params [Boolean] :guess_mime_type_enabled
+    #   Enables guessing of the MIME type for uploaded objects based on file
+    #   extensions. Set this value to true to enable MIME type guessing, and
+    #   otherwise to false. The default value is true.
+    #
+    # @option params [Boolean] :requester_pays
+    #   Sets who pays the cost of the request and the data download from the
+    #   Amazon S3 bucket. Set this value to true if you want the requester to
+    #   pay instead of the bucket owner, and otherwise to false.
+    #
+    # @option params [Array<String>] :valid_user_list
+    #   A list of users in the Active Directory that are allowed to access the
+    #   file share. Can only be set if Authentication is set to
+    #   "ActiveDirectory".
+    #
+    # @option params [Array<String>] :invalid_user_list
+    #   A list of users in the Active Directory that are not allowed to access
+    #   the file share. Can only be set if Authentication is set to
+    #   "ActiveDirectory".
+    #
+    # @return [Types::UpdateSMBFileShareOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateSMBFileShareOutput#file_share_arn #file_share_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_smb_file_share({
+    #     file_share_arn: "FileShareARN", # required
+    #     kms_encrypted: false,
+    #     kms_key: "KMSKey",
+    #     default_storage_class: "StorageClass",
+    #     object_acl: "private", # accepts private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control, aws-exec-read
+    #     read_only: false,
+    #     guess_mime_type_enabled: false,
+    #     requester_pays: false,
+    #     valid_user_list: ["FileShareUser"],
+    #     invalid_user_list: ["FileShareUser"],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.file_share_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBFileShare AWS API Documentation
+    #
+    # @overload update_smb_file_share(params = {})
+    # @param [Hash] params ({})
+    def update_smb_file_share(params = {}, options = {})
+      req = build_request(:update_smb_file_share, params)
+      req.send_request(options)
+    end
+
     # Updates a snapshot schedule configured for a gateway volume. This
     # operation is only supported in the cached volume and stored volume
     # gateway types.
@@ -4577,7 +4984,7 @@ module Aws::StorageGateway
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-storagegateway'
-      context[:gem_version] = '1.5.0'
+      context[:gem_version] = '1.6.0'
       Seahorse::Client::Request.new(handlers, context)
     end