2020/10/29 - AWS Storage Gateway - 1 new 7 updated api methods
Changes Adding support for access based enumeration on SMB file shares, file share visibility on SMB file shares, and file upload notifications for all file shares
Controls whether the shares on a gateway are visible in a net view or browse list.
See also: AWS API Documentation
Request Syntax
client.update_smb_file_share_visibility(
GatewayARN='string',
FileSharesVisible=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
boolean
[REQUIRED]
The shares on this gateway appear when listing shares.
dict
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
{'NotificationPolicy': 'string'}
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 an NFS interface. This operation is only supported for file gateways.
Warning
File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the 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 gateway does not support creating hard or symbolic links on a file share.
See also: AWS API Documentation
Request Syntax
client.create_nfs_file_share(
ClientToken='string',
NFSFileShareDefaults={
'FileMode': 'string',
'DirectoryMode': 'string',
'GroupId': 123,
'OwnerId': 123
},
GatewayARN='string',
KMSEncrypted=True|False,
KMSKey='string',
Role='string',
LocationARN='string',
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ClientList=[
'string',
],
Squash='string',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FileShareName='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
NotificationPolicy='string'
)
string
[REQUIRED]
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
dict
File share default values. Optional.
FileMode (string) --
The Unix file mode in the form "nnnn". For example, 0666 represents the default file mode inside the file share. The default value is 0666 .
DirectoryMode (string) --
The Unix directory mode in the form "nnnn". For example, 0666 represents the default access mode for all directories inside the file share. The default value is 0777 .
GroupId (integer) --
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody .
OwnerId (integer) --
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody .
string
[REQUIRED]
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
boolean
Set to 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.
Valid Values: true | false
string
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
string
[REQUIRED]
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
string
[REQUIRED]
The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".
string
The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
string
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private .
list
The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
(string) --
string
A value that maps a user to anonymous user.
Valid values are the following:
RootSquash : Only root is mapped to anonymous user.
NoSquash : No one is mapped to anonymous user.
AllSquash : Everyone is mapped to anonymous user.
boolean
A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
boolean
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, otherwise set to false . The default value is true .
Valid Values: true | false
boolean
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
list
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
(dict) --
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Key (string) -- [REQUIRED]
Tag key. The key can't start with aws:.
Value (string) -- [REQUIRED]
Value of the tag key.
string
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN .
dict
Refresh cache information.
CacheStaleTimeoutInSeconds (integer) --
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. The TTL duration is in seconds.
Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
string
The notification policy of the file share.
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateNFSFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the newly created file share.
{'AccessBasedEnumeration': 'boolean', 'NotificationPolicy': 'string'}
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 exposes file shares using an SMB interface. This operation is only supported for file gateways.
Warning
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.
See also: AWS API Documentation
Request Syntax
client.create_smb_file_share(
ClientToken='string',
GatewayARN='string',
KMSEncrypted=True|False,
KMSKey='string',
Role='string',
LocationARN='string',
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
SMBACLEnabled=True|False,
AccessBasedEnumeration=True|False,
AdminUserList=[
'string',
],
ValidUserList=[
'string',
],
InvalidUserList=[
'string',
],
AuditDestinationARN='string',
Authentication='string',
CaseSensitivity='ClientSpecified'|'CaseSensitive',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FileShareName='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
NotificationPolicy='string'
)
string
[REQUIRED]
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
string
[REQUIRED]
The ARN of the file gateway on which you want to create a file share.
boolean
Set to 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.
Valid Values: true | false
string
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
string
[REQUIRED]
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
string
[REQUIRED]
The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".
string
The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
string
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private .
boolean
A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
boolean
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, otherwise set to false . The default value is true .
Valid Values: true | false
boolean
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
boolean
Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the AWS Storage Gateway User Guide .
Valid Values: true | false
boolean
The files and folders on this share will only be visible to users with read access.
list
A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 .
Warning
Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
(string) --
list
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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
(string) --
list
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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
(string) --
string
The Amazon Resource Name (ARN) of the storage used for the audit logs.
string
The authentication method that users use to access the file share. The default is ActiveDirectory .
Valid Values: ActiveDirectory | GuestAccess
string
The case of an object name in an Amazon S3 bucket. For ClientSpecified , the client determines the case sensitivity. For CaseSensitive , the gateway determines the case sensitivity. The default value is ClientSpecified .
list
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
(dict) --
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Key (string) -- [REQUIRED]
Tag key. The key can't start with aws:.
Value (string) -- [REQUIRED]
Value of the tag key.
string
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN .
dict
Refresh cache information.
CacheStaleTimeoutInSeconds (integer) --
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. The TTL duration is in seconds.
Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
string
The notification policy of the file share.
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateSMBFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the newly created file share.
{'NFSFileShareInfoList': {'NotificationPolicy': 'string'}}
Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.
See also: AWS API Documentation
Request Syntax
client.describe_nfs_file_shares(
FileShareARNList=[
'string',
]
)
list
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
(string) --
The Amazon Resource Name (ARN) of the file share.
dict
Response Syntax
{
'NFSFileShareInfoList': [
{
'NFSFileShareDefaults': {
'FileMode': 'string',
'DirectoryMode': 'string',
'GroupId': 123,
'OwnerId': 123
},
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string',
'KMSEncrypted': True|False,
'KMSKey': 'string',
'Path': 'string',
'Role': 'string',
'LocationARN': 'string',
'DefaultStorageClass': 'string',
'ObjectACL': 'private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
'ClientList': [
'string',
],
'Squash': 'string',
'ReadOnly': True|False,
'GuessMIMETypeEnabled': True|False,
'RequesterPays': True|False,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'FileShareName': 'string',
'CacheAttributes': {
'CacheStaleTimeoutInSeconds': 123
},
'NotificationPolicy': 'string'
},
]
}
Response Structure
(dict) --
DescribeNFSFileSharesOutput
NFSFileShareInfoList (list) --
An array containing a description for each requested file share.
(dict) --
The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.
NFSFileShareDefaults (dict) --
Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for file gateways.
FileMode (string) --
The Unix file mode in the form "nnnn". For example, 0666 represents the default file mode inside the file share. The default value is 0666 .
DirectoryMode (string) --
The Unix directory mode in the form "nnnn". For example, 0666 represents the default access mode for all directories inside the file share. The default value is 0777 .
GroupId (integer) --
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody .
OwnerId (integer) --
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody .
FileShareARN (string) --
The Amazon Resource Name (ARN) of the file share.
FileShareId (string) --
The ID of the file share.
FileShareStatus (string) --
The status of the file share.
Valid Values: CREATING | UPDATING | AVAILABLE | DELETING
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
KMSEncrypted (boolean) --
Set to 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.
Valid Values: true | false
KMSKey (string) --
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
Path (string) --
The file share path used by the NFS client to identify the mount point.
Role (string) --
The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.
LocationARN (string) --
The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".
DefaultStorageClass (string) --
The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
ObjectACL (string) --
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private .
ClientList (list) --
The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
(string) --
Squash (string) --
The user mapped to anonymous user. Valid options are the following:
RootSquash : Only root is mapped to anonymous user.
NoSquash : No one is mapped to anonymous user.
AllSquash : Everyone is mapped to anonymous user.
ReadOnly (boolean) --
A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
GuessMIMETypeEnabled (boolean) --
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, otherwise set to false . The default value is true .
Valid Values: true | false
RequesterPays (boolean) --
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
Tags (list) --
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
(dict) --
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Key (string) --
Tag key. The key can't start with aws:.
Value (string) --
Value of the tag key.
FileShareName (string) --
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN .
CacheAttributes (dict) --
Refresh cache information.
CacheStaleTimeoutInSeconds (integer) --
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. The TTL duration is in seconds.
Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
NotificationPolicy (string) --
The notification policy of the file share.
{'SMBFileShareInfoList': {'AccessBasedEnumeration': 'boolean',
'NotificationPolicy': 'string'}}
Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.
See also: AWS API Documentation
Request Syntax
client.describe_smb_file_shares(
FileShareARNList=[
'string',
]
)
list
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
(string) --
The Amazon Resource Name (ARN) of the file share.
dict
Response Syntax
{
'SMBFileShareInfoList': [
{
'FileShareARN': 'string',
'FileShareId': 'string',
'FileShareStatus': 'string',
'GatewayARN': 'string',
'KMSEncrypted': True|False,
'KMSKey': 'string',
'Path': 'string',
'Role': 'string',
'LocationARN': 'string',
'DefaultStorageClass': 'string',
'ObjectACL': 'private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
'ReadOnly': True|False,
'GuessMIMETypeEnabled': True|False,
'RequesterPays': True|False,
'SMBACLEnabled': True|False,
'AccessBasedEnumeration': True|False,
'AdminUserList': [
'string',
],
'ValidUserList': [
'string',
],
'InvalidUserList': [
'string',
],
'AuditDestinationARN': 'string',
'Authentication': 'string',
'CaseSensitivity': 'ClientSpecified'|'CaseSensitive',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'FileShareName': 'string',
'CacheAttributes': {
'CacheStaleTimeoutInSeconds': 123
},
'NotificationPolicy': 'string'
},
]
}
Response Structure
(dict) --
DescribeSMBFileSharesOutput
SMBFileShareInfoList (list) --
An array containing a description for each requested file share.
(dict) --
The Windows file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported for file gateways.
FileShareARN (string) --
The Amazon Resource Name (ARN) of the file share.
FileShareId (string) --
The ID of the file share.
FileShareStatus (string) --
The status of the file share.
Valid Values: CREATING | UPDATING | AVAILABLE | DELETING
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
KMSEncrypted (boolean) --
Set to 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.
Valid Values: true | false
KMSKey (string) --
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
Path (string) --
The file share path used by the SMB client to identify the mount point.
Role (string) --
The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.
LocationARN (string) --
The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".
DefaultStorageClass (string) --
The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
ObjectACL (string) --
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private .
ReadOnly (boolean) --
A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
GuessMIMETypeEnabled (boolean) --
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, otherwise set to false . The default value is true .
Valid Values: true | false
RequesterPays (boolean) --
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
SMBACLEnabled (boolean) --
If this value is set to true , it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false , it indicates that file and directory permissions are mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the AWS Storage Gateway User Guide .
AccessBasedEnumeration (boolean) --
Indicates whether AccessBasedEnumeration is enabled.
AdminUserList (list) --
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
(string) --
ValidUserList (list) --
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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
(string) --
InvalidUserList (list) --
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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
(string) --
AuditDestinationARN (string) --
The Amazon Resource Name (ARN) of the storage used for the audit logs.
Authentication (string) --
The authentication method of the file share. The default is ActiveDirectory .
Valid Values: ActiveDirectory | GuestAccess
CaseSensitivity (string) --
The case of an object name in an Amazon S3 bucket. For ClientSpecified , the client determines the case sensitivity. For CaseSensitive , the gateway determines the case sensitivity. The default value is ClientSpecified .
Tags (list) --
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
(dict) --
A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
Key (string) --
Tag key. The key can't start with aws:.
Value (string) --
Value of the tag key.
FileShareName (string) --
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN .
CacheAttributes (dict) --
Refresh cache information.
CacheStaleTimeoutInSeconds (integer) --
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. The TTL duration is in seconds.
Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
NotificationPolicy (string) --
The notification policy of the file share.
{'FileSharesVisible': 'boolean'}
Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.
See also: AWS API Documentation
Request Syntax
client.describe_smb_settings(
GatewayARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
dict
Response Syntax
{
'GatewayARN': 'string',
'DomainName': 'string',
'ActiveDirectoryStatus': 'ACCESS_DENIED'|'DETACHED'|'JOINED'|'JOINING'|'NETWORK_ERROR'|'TIMEOUT'|'UNKNOWN_ERROR',
'SMBGuestPasswordSet': True|False,
'SMBSecurityStrategy': 'ClientSpecified'|'MandatorySigning'|'MandatoryEncryption',
'FileSharesVisible': True|False
}
Response Structure
(dict) --
GatewayARN (string) --
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
DomainName (string) --
The name of the domain that the gateway is joined to.
ActiveDirectoryStatus (string) --
Indicates the status of a gateway that is a member of the Active Directory domain.
ACCESS_DENIED : Indicates that the JoinDomain operation failed due to an authentication error.
DETACHED : Indicates that gateway is not joined to a domain.
JOINED : Indicates that the gateway has successfully joined a domain.
JOINING : Indicates that a JoinDomain operation is in progress.
NETWORK_ERROR : Indicates that JoinDomain operation failed due to a network or connectivity error.
TIMEOUT : Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.
UNKNOWN_ERROR : Indicates that the JoinDomain operation failed due to another type of error.
SMBGuestPasswordSet (boolean) --
This value is true if a password for the guest user smbguest is set, otherwise false .
Valid Values: true | false
SMBSecurityStrategy (string) --
The type of security strategy that was specified for file gateway.
ClientSpecified : If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment.
MandatorySigning : If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
MandatoryEncryption : If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.
FileSharesVisible (boolean) --
The shares on this gateway appear when listing shares.
{'NotificationPolicy': 'string'}
Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.
Note
To leave a file share field unchanged, set the corresponding input field to null.
Updates the following file share settings:
Default storage class for your S3 bucket
Metadata defaults for your S3 bucket
Allowed NFS clients for your file share
Squash settings
Write status of your file share
See also: AWS API Documentation
Request Syntax
client.update_nfs_file_share(
FileShareARN='string',
KMSEncrypted=True|False,
KMSKey='string',
NFSFileShareDefaults={
'FileMode': 'string',
'DirectoryMode': 'string',
'GroupId': 123,
'OwnerId': 123
},
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ClientList=[
'string',
],
Squash='string',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
FileShareName='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
NotificationPolicy='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the file share to be updated.
boolean
Set to 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.
Valid Values: true | false
string
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
dict
The default values for the file share. Optional.
FileMode (string) --
The Unix file mode in the form "nnnn". For example, 0666 represents the default file mode inside the file share. The default value is 0666 .
DirectoryMode (string) --
The Unix directory mode in the form "nnnn". For example, 0666 represents the default access mode for all directories inside the file share. The default value is 0777 .
GroupId (integer) --
The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody .
OwnerId (integer) --
The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody .
string
The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
string
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private .
list
The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.
(string) --
string
The user mapped to anonymous user.
Valid values are the following:
RootSquash : Only root is mapped to anonymous user.
NoSquash : No one is mapped to anonymous user.
AllSquash : Everyone is mapped to anonymous user.
boolean
A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false .
Valid Values: true | false
boolean
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, otherwise set to false . The default value is true .
Valid Values: true | false
boolean
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
string
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN .
dict
Refresh cache information.
CacheStaleTimeoutInSeconds (integer) --
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. The TTL duration is in seconds.
Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
string
The notification policy of the file share.
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateNFSFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the updated file share.
{'AccessBasedEnumeration': 'boolean', 'NotificationPolicy': 'string'}
Updates a Server Message Block (SMB) file share. This operation is only supported for file gateways.
Note
To leave a file share field unchanged, set the corresponding input field to null.
Warning
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.
See also: AWS API Documentation
Request Syntax
client.update_smb_file_share(
FileShareARN='string',
KMSEncrypted=True|False,
KMSKey='string',
DefaultStorageClass='string',
ObjectACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'bucket-owner-read'|'bucket-owner-full-control'|'aws-exec-read',
ReadOnly=True|False,
GuessMIMETypeEnabled=True|False,
RequesterPays=True|False,
SMBACLEnabled=True|False,
AccessBasedEnumeration=True|False,
AdminUserList=[
'string',
],
ValidUserList=[
'string',
],
InvalidUserList=[
'string',
],
AuditDestinationARN='string',
CaseSensitivity='ClientSpecified'|'CaseSensitive',
FileShareName='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
NotificationPolicy='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
boolean
Set to 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.
Valid Values: true | false
string
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true . Optional.
string
The default storage class for objects put into an Amazon S3 bucket by the file gateway. The default value is S3_INTELLIGENT_TIERING . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
string
A value that sets the access control list (ACL) permission for objects in the S3 bucket that a file gateway puts objects into. The default value is private .
boolean
A value that sets the write status of a file share. Set this value to true to set write status to read-only, otherwise set to false .
Valid Values: true | false
boolean
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, otherwise set to false . The default value is true .
Valid Values: true | false
boolean
A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true , the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
Note
RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
Valid Values: true | false
boolean
Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.
For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the AWS Storage Gateway User Guide .
Valid Values: true | false
boolean
The files and folders on this share will only be visible to users with read access.
list
A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
(string) --
list
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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
(string) --
list
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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
(string) --
string
The Amazon Resource Name (ARN) of the storage used for the audit logs.
string
The case of an object name in an Amazon S3 bucket. For ClientSpecified , the client determines the case sensitivity. For CaseSensitive , the gateway determines the case sensitivity. The default value is ClientSpecified .
string
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN .
dict
Refresh cache information.
CacheStaleTimeoutInSeconds (integer) --
Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. The TTL duration is in seconds.
Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)
string
The notification policy of the file share.
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateSMBFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the updated SMB file share.