Menu
AWS Storage Gateway Service
API Reference (API Version 2013-06-30)

UpdateSMBFileShare

Updates a Server Message Block (SMB) file share.

Note

To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.

Important

File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS 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 gateways don't support creating hard or symbolic links on a file share.

Request Syntax

{ "DefaultStorageClass": "string", "FileShareARN": "string", "GuessMIMETypeEnabled": boolean, "InvalidUserList": [ "string" ], "KMSEncrypted": boolean, "KMSKey": "string", "ObjectACL": "string", "ReadOnly": boolean, "RequesterPays": boolean, "ValidUserList": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DefaultStorageClass

The default storage class for objects put into an Amazon S3 bucket by the 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.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 20.

Required: No

FileShareARN

The Amazon Resource Name (ARN) of the SMB file share that you want to update.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

GuessMIMETypeEnabled

A value that 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.

Type: Boolean

Required: No

InvalidUserList

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

KMSEncrypted

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.

Type: Boolean

Required: No

KMSKey

The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

ObjectACL

A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".

Type: String

Valid Values: private | public-read | public-read-write | authenticated-read | bucket-owner-read | bucket-owner-full-control | aws-exec-read

Required: No

ReadOnly

A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

Type: Boolean

Required: No

RequesterPays

A value that 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.

Type: Boolean

Required: No

ValidUserList

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

Response Syntax

{ "FileShareARN": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FileShareARN

The Amazon Resource Name (ARN) of the updated SMB file share.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

Example

Update a SMB File Share

In the following request, you update a SMB file share using an existing file gateway and use your own AWS KMS key to perform server-side encryption of the contents of the file share.

Sample Request

{ "DefaultStorageClass": "S3_STANDARD", "FileShareArn": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY", "GuessMIMETypeEnabled": "true", "InvalidList": ["user1", "user2"], "KMSEncrypted": "true", "KMSKey": "arn:aws:kms:us-east-1:11111111:key/b72aaa2a-2222-99tt-12345690qwe", "ObjectACL":"bucket-owner-full-control", "ReadOnly": "false", "RequesterPays": "false", "ValidList": ["user3", "user4"] }

Sample Response

{"FileShareARN": "arn:aws:storagegateway:us-east-2:111122223333:share/share-YYYYYYY"}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: