2024/09/12 - AWS Storage Gateway - 6 updated api methods
Changes The S3 File Gateway now supports DSSE-KMS encryption. A new parameter EncryptionType is added to these APIs: CreateSmbFileShare, CreateNfsFileShare, UpdateSmbFileShare, UpdateNfsFileShare, DescribeSmbFileShares, DescribeNfsFileShares. Also, in favor of EncryptionType, KmsEncrypted is deprecated.
{'EncryptionType': 'SseS3 | SseKms | DsseKms'}
Creates a Network File System (NFS) file share on an existing S3 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 S3 File Gateways.
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',
EncryptionType='SseS3'|'SseKms'|'DsseKms',
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',
VPCEndpointDNSName='string',
BucketRegion='string',
AuditDestinationARN='string'
)
string
[REQUIRED]
A unique string value that you supply that is used by S3 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 S3 File Gateway on which you want to create a file share.
string
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.
boolean
Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.
Valid Values: true | false
string
Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.
string
[REQUIRED]
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
string
[REQUIRED]
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
string
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. 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 S3 File Gateway puts objects into. The default value is private.
list
The list of clients that are allowed to access the S3 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.
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.
(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.
dict
Specifies refresh cache information for the file share.
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 or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
string
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
string
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
string
Specifies the Region of the S3 bucket where the NFS file share stores files.
string
The Amazon Resource Name (ARN) of the storage used for audit logs.
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateNFSFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the newly created file share.
{'EncryptionType': 'SseS3 | SseKms | DsseKms'}
Creates a Server Message Block (SMB) file share on an existing S3 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 S3 File Gateways.
See also: AWS API Documentation
Request Syntax
client.create_smb_file_share(
ClientToken='string',
GatewayARN='string',
EncryptionType='SseS3'|'SseKms'|'DsseKms',
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',
VPCEndpointDNSName='string',
BucketRegion='string',
OplocksEnabled=True|False
)
string
[REQUIRED]
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
string
[REQUIRED]
The ARN of the S3 File Gateway on which you want to create a file share.
string
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.
boolean
Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.
Valid Values: true | false
string
Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.
string
[REQUIRED]
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
string
[REQUIRED]
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
string
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. 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 S3 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.
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 Windows ACLs to limit SMB file share access in the Amazon S3 File 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.
(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 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.
(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.
dict
Specifies refresh cache information for the file share.
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 or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
string
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
string
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
string
Specifies the Region of the S3 bucket where the SMB file share stores files.
boolean
Specifies whether opportunistic locking is enabled for the SMB file share.
Valid Values: true | false
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateSMBFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the newly created file share.
{'NFSFileShareInfoList': {'EncryptionType': 'SseS3 | SseKms | DsseKms'}}
Gets a description for one or more Network File System (NFS) file shares from an S3 File Gateway. This operation is only supported for S3 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',
'EncryptionType': 'SseS3'|'SseKms'|'DsseKms',
'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',
'VPCEndpointDNSName': 'string',
'BucketRegion': 'string',
'AuditDestinationARN': '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 an S3 File Gateway discovers them in S3 buckets. This operation is only supported in S3 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 S3 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 Amazon Web Services Region.
EncryptionType (string) --
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.
KMSEncrypted (boolean) --
Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.
Valid Values: true | false
KMSKey (string) --
Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.
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 an S3 File Gateway assumes when it accesses the underlying storage.
LocationARN (string) --
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
DefaultStorageClass (string) --
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. 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 an S3 File Gateway puts objects into. The default value is private.
ClientList (list) --
The list of clients that are allowed to access the S3 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.
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.
CacheAttributes (dict) --
Refresh cache information for the file share.
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 or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
NotificationPolicy (string) --
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
VPCEndpointDNSName (string) --
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
BucketRegion (string) --
Specifies the Region of the S3 bucket where the NFS file share stores files.
AuditDestinationARN (string) --
The Amazon Resource Name (ARN) of the storage used for audit logs.
{'SMBFileShareInfoList': {'EncryptionType': 'SseS3 | SseKms | DsseKms'}}
Gets a description for one or more Server Message Block (SMB) file shares from a S3 File Gateway. This operation is only supported for S3 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',
'EncryptionType': 'SseS3'|'SseKms'|'DsseKms',
'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',
'VPCEndpointDNSName': 'string',
'BucketRegion': 'string',
'OplocksEnabled': True|False
},
]
}
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 S3 File Gateway discovers them in S3 buckets. This operation is only supported for S3 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 Amazon Web Services Region.
EncryptionType (string) --
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.
KMSEncrypted (boolean) --
Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.
Valid Values: true | false
KMSKey (string) --
Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.
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 an S3 File Gateway assumes when it accesses the underlying storage.
LocationARN (string) --
A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).
DefaultStorageClass (string) --
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. 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 an S3 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.
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 Windows ACLs to limit SMB file share access in the Amazon S3 File 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 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.
CacheAttributes (dict) --
Refresh cache information for the file share.
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 or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
NotificationPolicy (string) --
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
VPCEndpointDNSName (string) --
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
BucketRegion (string) --
Specifies the Region of the S3 bucket where the SMB file share stores files.
OplocksEnabled (boolean) --
Specifies whether opportunistic locking is enabled for the SMB file share.
Valid Values: true | false
{'EncryptionType': 'SseS3 | SseKms | DsseKms'}
Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.
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',
EncryptionType='SseS3'|'SseKms'|'DsseKms',
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',
AuditDestinationARN='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the file share to be updated.
string
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.
boolean
Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.
Valid Values: true | false
string
Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.
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 S3 File Gateway. The default value is S3_STANDARD. 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 S3 File Gateway puts objects into. The default value is private.
list
The list of clients that are allowed to access the S3 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.
Valid Values: true | false
string
The name of the file share. Optional.
dict
Specifies refresh cache information for the file share.
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 or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
string
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
string
The Amazon Resource Name (ARN) of the storage used for audit logs.
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateNFSFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the updated file share.
{'EncryptionType': 'SseS3 | SseKms | DsseKms'}
Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.
See also: AWS API Documentation
Request Syntax
client.update_smb_file_share(
FileShareARN='string',
EncryptionType='SseS3'|'SseKms'|'DsseKms',
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',
OplocksEnabled=True|False
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
string
A value that specifies the type of server-side encryption that the file share will use for the data that it stores in Amazon S3.
boolean
Optional. Set to true to use Amazon S3 server-side encryption with your own KMS key (SSE-KMS), or false to use a key managed by Amazon S3 (SSE-S3). To use dual-layer encryption (DSSE-KMS), set the EncryptionType parameter instead.
Valid Values: true | false
string
Optional. 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 must be set if KMSEncrypted is true, or if EncryptionType is SseKms or DsseKms.
string
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. 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 S3 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.
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 Windows ACLs to limit SMB file share access in the Amazon S3 File 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 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.
dict
Specifies refresh cache information for the file share.
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 or Amazon FSx file system. The TTL duration is in seconds.
Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
string
The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
boolean
Specifies whether opportunistic locking is enabled for the SMB file share.
Valid Values: true | false
dict
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateSMBFileShareOutput
FileShareARN (string) --
The Amazon Resource Name (ARN) of the updated SMB file share.