2021/07/07
- AWS Storage Gateway -
9 updated api methods
Changes
Adding support for oplocks for SMB file shares, S3 Access Point and S3 Private Link for all file shares and IP address support for file system associations
AssociateFileSystem (updated)
Link ¶
Changes (request)
{'EndpointNetworkConfiguration': {'IpAddresses': ['string']}}
Associate an Amazon FSx file system with the FSx File Gateway. After the association process is complete, the file shares on the Amazon FSx file system are available for access through the gateway. This operation only supports the FSx File Gateway type.
See also: AWS API Documentation
Request Syntax
client.associate_file_system(
UserName='string',
Password='string',
ClientToken='string',
GatewayARN='string',
LocationARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
AuditDestinationARN='string',
CacheAttributes={
'CacheStaleTimeoutInSeconds': 123
},
EndpointNetworkConfiguration={
'IpAddresses': [
'string',
]
}
)
- type UserName
string
- param UserName
[REQUIRED]
The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
- type Password
string
- param Password
[REQUIRED]
The password of the user credential.
- type ClientToken
string
- param ClientToken
[REQUIRED]
A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.
- type GatewayARN
string
- param GatewayARN
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Region.
- type LocationARN
string
- param LocationARN
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.
- type Tags
list
- param Tags
A list of up to 50 tags that can be assigned to the file system association. 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.
- type AuditDestinationARN
string
- param AuditDestinationARN
The Amazon Resource Name (ARN) of the storage used for the audit logs.
- type CacheAttributes
dict
- param CacheAttributes
The refresh cache information for the file share or FSx file systems.
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)
- type EndpointNetworkConfiguration
dict
- param EndpointNetworkConfiguration
Specifies the network configuration information for the gateway associated with the Amazon FSx file system.
Note
If multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.
- rtype
dict
- returns
Response Syntax
{
'FileSystemAssociationARN': 'string'
}
Response Structure
CreateNFSFileShare (updated)
Link ¶
Changes (request)
{'BucketRegion': 'string', 'VPCEndpointDNSName': 'string'}
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.
Warning
S3 File gateway requires Security Token Service (STS) to be activated to enable you to create a file share. Make sure STS is activated in the Region you are creating your S3 File Gateway in. If STS is not activated in the Region, activate it. For information about how to activate STS, see Activating and deactivating STS in an Region in the Identity and Access Management User Guide .
S3 File Gateways do 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',
VPCEndpointDNSName='string',
BucketRegion='string'
)
- type ClientToken
string
- param ClientToken
[REQUIRED]
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
- type NFSFileShareDefaults
dict
- param NFSFileShareDefaults
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 .
- type GatewayARN
string
- param GatewayARN
[REQUIRED]
The Amazon Resource Name (ARN) of the S3 File Gateway on which you want to create a file share.
- type KMSEncrypted
boolean
- param KMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
- type KMSKey
string
- param KMSKey
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.
- type Role
string
- param Role
[REQUIRED]
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
- type LocationARN
string
- param LocationARN
[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 "/".
Note
You can specify a bucket attached to an access point using a complete ARN that includes the bucket region as shown:
arn:aws:s3:region:account-id:accesspoint/access-point-name
If you specify a bucket attached to an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide .
- type DefaultStorageClass
string
- param DefaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
- type ObjectACL
string
- param ObjectACL
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 .
- type ClientList
list
- param ClientList
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.
- type Squash
string
- param Squash
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.
- type ReadOnly
boolean
- param ReadOnly
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
- type GuessMIMETypeEnabled
boolean
- param 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, otherwise set to false . The default value is true .
Valid Values: true | false
- type RequesterPays
boolean
- param RequesterPays
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
- type Tags
list
- param Tags
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.
- type FileShareName
string
- param FileShareName
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN .
- type CacheAttributes
dict
- param CacheAttributes
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)
- type NotificationPolicy
string
- param NotificationPolicy
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.
Note
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
- type VPCEndpointDNSName
string
- param VPCEndpointDNSName
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
Note
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
- type BucketRegion
string
- param BucketRegion
Specifies the Region of the S3 bucket where the NFS file share stores files.
Note
This parameter is required for NFS file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
- rtype
dict
- returns
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateNFSFileShareOutput
CreateSMBFileShare (updated)
Link ¶
Changes (request)
{'BucketRegion': 'string',
'OplocksEnabled': 'boolean',
'VPCEndpointDNSName': 'string'}
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.
Warning
S3 File Gateways require Security Token Service (STS) to be activated to enable you to create a file share. Make sure that STS is activated in the Region you are creating your S3 File Gateway in. If STS is not activated in this Region, activate it. For information about how to activate STS, see Activating and deactivating STS in an Region in the 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',
VPCEndpointDNSName='string',
BucketRegion='string',
OplocksEnabled=True|False
)
- type ClientToken
string
- param ClientToken
[REQUIRED]
A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
- type GatewayARN
string
- param GatewayARN
[REQUIRED]
The ARN of the S3 File Gateway on which you want to create a file share.
- type KMSEncrypted
boolean
- param KMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
- type KMSKey
string
- param KMSKey
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.
- type Role
string
- param Role
[REQUIRED]
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
- type LocationARN
string
- param LocationARN
[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 "/".
Note
You can specify a bucket attached to an access point using a complete ARN that includes the bucket region as shown:
arn:aws:s3:region:account-id:accesspoint/access-point-name
If you specify a bucket attached to an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide .
- type DefaultStorageClass
string
- param DefaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
- type ObjectACL
string
- param ObjectACL
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 .
- type ReadOnly
boolean
- param ReadOnly
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
- type GuessMIMETypeEnabled
boolean
- param 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, otherwise set to false . The default value is true .
Valid Values: true | false
- type RequesterPays
boolean
- param RequesterPays
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
- type SMBACLEnabled
boolean
- param SMBACLEnabled
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 Storage Gateway User Guide .
Valid Values: true | false
- type AccessBasedEnumeration
boolean
- param AccessBasedEnumeration
The files and folders on this share will only be visible to users with read access.
- type AdminUserList
list
- param AdminUserList
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.
- type ValidUserList
list
- param 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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
- type InvalidUserList
list
- param 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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
- type AuditDestinationARN
string
- param AuditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
- type Authentication
string
- param Authentication
The authentication method that users use to access the file share. The default is ActiveDirectory .
Valid Values: ActiveDirectory | GuestAccess
- type CaseSensitivity
string
- param CaseSensitivity
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 .
- type Tags
list
- param Tags
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.
- type FileShareName
string
- param FileShareName
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN .
- type CacheAttributes
dict
- param CacheAttributes
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)
- type NotificationPolicy
string
- param NotificationPolicy
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.
Note
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
- type VPCEndpointDNSName
string
- param VPCEndpointDNSName
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
Note
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
- type BucketRegion
string
- param BucketRegion
Specifies the Region of the S3 bucket where the SMB file share stores files.
Note
This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
- type OplocksEnabled
boolean
- param OplocksEnabled
Specifies whether opportunistic locking is enabled for the SMB file share.
Note
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
- rtype
dict
- returns
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateSMBFileShareOutput
DescribeFileSystemAssociations (updated)
Link ¶
Changes (response)
{'FileSystemAssociationInfoList': {'EndpointNetworkConfiguration': {'IpAddresses': ['string']}}}
Gets the file system association information. This operation is only supported for FSx File Gateways.
See also: AWS API Documentation
Request Syntax
client.describe_file_system_associations(
FileSystemAssociationARNList=[
'string',
]
)
- type FileSystemAssociationARNList
list
- param FileSystemAssociationARNList
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file system association to be described.
- rtype
dict
- returns
Response Syntax
{
'FileSystemAssociationInfoList': [
{
'FileSystemAssociationARN': 'string',
'LocationARN': 'string',
'FileSystemAssociationStatus': 'string',
'AuditDestinationARN': 'string',
'GatewayARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CacheAttributes': {
'CacheStaleTimeoutInSeconds': 123
},
'EndpointNetworkConfiguration': {
'IpAddresses': [
'string',
]
}
},
]
}
Response Structure
DescribeGatewayInformation (updated)
Link ¶
Changes (response)
{'GatewayCapacity': 'Small | Medium | Large',
'SupportedGatewayCapacities': ['Small | Medium | Large']}
Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
See also: AWS API Documentation
Request Syntax
client.describe_gateway_information(
GatewayARN='string'
)
- type GatewayARN
string
- param GatewayARN
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Region.
- rtype
dict
- returns
Response Syntax
{
'GatewayARN': 'string',
'GatewayId': 'string',
'GatewayName': 'string',
'GatewayTimezone': 'string',
'GatewayState': 'string',
'GatewayNetworkInterfaces': [
{
'Ipv4Address': 'string',
'MacAddress': 'string',
'Ipv6Address': 'string'
},
],
'GatewayType': 'string',
'NextUpdateAvailabilityDate': 'string',
'LastSoftwareUpdate': 'string',
'Ec2InstanceId': 'string',
'Ec2InstanceRegion': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VPCEndpoint': 'string',
'CloudWatchLogGroupARN': 'string',
'HostEnvironment': 'VMWARE'|'HYPER-V'|'EC2'|'KVM'|'OTHER',
'EndpointType': 'string',
'SoftwareUpdatesEndDate': 'string',
'DeprecationDate': 'string',
'GatewayCapacity': 'Small'|'Medium'|'Large',
'SupportedGatewayCapacities': [
'Small'|'Medium'|'Large',
]
}
Response Structure
DescribeNFSFileShares (updated)
Link ¶
Changes (response)
{'NFSFileShareInfoList': {'BucketRegion': 'string',
'VPCEndpointDNSName': 'string'}}
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',
]
)
- type FileShareARNList
list
- param FileShareARNList
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
- rtype
dict
- returns
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',
'VPCEndpointDNSName': 'string',
'BucketRegion': 'string'
},
]
}
Response Structure
DescribeSMBFileShares (updated)
Link ¶
Changes (response)
{'SMBFileShareInfoList': {'BucketRegion': 'string',
'OplocksEnabled': 'boolean',
'VPCEndpointDNSName': 'string'}}
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',
]
)
- type FileShareARNList
list
- param FileShareARNList
[REQUIRED]
An array containing the Amazon Resource Name (ARN) of each file share to be described.
- rtype
dict
- returns
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',
'VPCEndpointDNSName': 'string',
'BucketRegion': 'string',
'OplocksEnabled': True|False
},
]
}
Response Structure
UpdateGatewayInformation (updated)
Link ¶
Changes (request)
{'GatewayCapacity': 'Small | Medium | Large'}
Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.
Note
For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
See also: AWS API Documentation
Request Syntax
client.update_gateway_information(
GatewayARN='string',
GatewayName='string',
GatewayTimezone='string',
CloudWatchLogGroupARN='string',
GatewayCapacity='Small'|'Medium'|'Large'
)
- type GatewayARN
string
- param GatewayARN
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Region.
- type GatewayName
string
- param GatewayName
The name you configured for your gateway.
- type GatewayTimezone
string
- param GatewayTimezone
A value that indicates the time zone of the gateway.
- type CloudWatchLogGroupARN
string
- param CloudWatchLogGroupARN
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.
For more information, see What is Amazon CloudWatch Logs?
- type GatewayCapacity
string
- param GatewayCapacity
Specifies the size of the gateway's metadata cache.
- rtype
dict
- returns
Response Syntax
{
'GatewayARN': 'string',
'GatewayName': 'string'
}
Response Structure
UpdateSMBFileShare (updated)
Link ¶
Changes (request)
{'OplocksEnabled': 'boolean'}
Updates a Server Message Block (SMB) file share. This operation is only supported for S3 File Gateways.
Note
To leave a file share field unchanged, set the corresponding input field to null.
Warning
File gateways require Security Token Service (STS) to be activated to enable you to create a file share. Make sure that STS is activated in the Region you are creating your file gateway in. If STS is not activated in this Region, activate it. For information about how to activate STS, see Activating and deactivating STS in an Region in the 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',
OplocksEnabled=True|False
)
- type FileShareARN
string
- param FileShareARN
[REQUIRED]
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
- type KMSEncrypted
boolean
- param KMSEncrypted
Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false
- type KMSKey
string
- param KMSKey
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.
- type DefaultStorageClass
string
- param DefaultStorageClass
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING . Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
- type ObjectACL
string
- param ObjectACL
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 .
- type ReadOnly
boolean
- param ReadOnly
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
- type GuessMIMETypeEnabled
boolean
- param 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, otherwise set to false . The default value is true .
Valid Values: true | false
- type RequesterPays
boolean
- param RequesterPays
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
- type SMBACLEnabled
boolean
- param SMBACLEnabled
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 Storage Gateway User Guide .
Valid Values: true | false
- type AccessBasedEnumeration
boolean
- param AccessBasedEnumeration
The files and folders on this share will only be visible to users with read access.
- type AdminUserList
list
- param AdminUserList
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 .
- type ValidUserList
list
- param 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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
- type InvalidUserList
list
- param 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. Acceptable formats include: DOMAIN\User1 , user1 , @group1 , and @DOMAIN\group1 . Can only be set if Authentication is set to ActiveDirectory .
- type AuditDestinationARN
string
- param AuditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
- type CaseSensitivity
string
- param CaseSensitivity
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 .
- type FileShareName
string
- param FileShareName
The name of the file share. Optional.
Note
FileShareName must be set if an S3 prefix name is set in LocationARN .
- type CacheAttributes
dict
- param CacheAttributes
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)
- type NotificationPolicy
string
- param NotificationPolicy
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.
Note
SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.
{\"Upload\": {\"SettlingTimeInSeconds\": 60}}
The following example sets NotificationPolicy off.
{}
- type OplocksEnabled
boolean
- param OplocksEnabled
Specifies whether opportunistic locking is enabled for the SMB file share.
Note
Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.
Valid Values: true | false
- rtype
dict
- returns
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateSMBFileShareOutput