2021/10/13
- AWS Storage Gateway -
1 new 5 updated api methods
Changes
Adding support for Audit Logs on NFS shares and Force Closing Files on SMB shares.
UpdateSMBLocalGroups (new)
Link ¶
Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
See also: AWS API Documentation
Request Syntax
client.update_smb_local_groups(
GatewayARN='string',
SMBLocalGroups={
'GatewayAdmins': [
'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 Amazon Web Services Region.
- type SMBLocalGroups
dict
- param SMBLocalGroups
[REQUIRED]
A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway.
GatewayAdmins (list) --
A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats include: DOMAIN\User1 , user1 , DOMAIN\group1 , and group1 .
Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force-close files that are open and locked.
- rtype
dict
- returns
Response Syntax
{
'GatewayARN': 'string'
}
Response Structure
CreateNFSFileShare (updated)
Link ¶
Changes (request)
{'AuditDestinationARN': '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 (Amazon Web Services STS) to be activated to enable you to create a file share. Make sure Amazon Web Services STS is activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If Amazon Web Services STS is not activated in the Amazon Web Services Region, activate it. For information about how to activate Amazon Web Services STS, see Activating and deactivating Amazon Web Services STS in an Amazon Web Services 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',
AuditDestinationARN='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]
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 (/).
Note
You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.
Bucket ARN:
arn:aws:s3:::my-bucket/prefix/
Access point ARN:
arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/
If you specify 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 .
Access point alias:
test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias
- 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 , or if an access point or access point alias is used.
- 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.
- type AuditDestinationARN
string
- param AuditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
- rtype
dict
- returns
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
CreateNFSFileShareOutput
DescribeFileSystemAssociations (updated)
Link ¶
Changes (response)
{'FileSystemAssociationInfoList': {'FileSystemAssociationStatusDetails': [{'ErrorCode': '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',
]
},
'FileSystemAssociationStatusDetails': [
{
'ErrorCode': 'string'
},
]
},
]
}
Response Structure
DescribeNFSFileShares (updated)
Link ¶
Changes (response)
{'NFSFileShareInfoList': {'AuditDestinationARN': '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',
'AuditDestinationARN': 'string'
},
]
}
Response Structure
DescribeSMBSettings (updated)
Link ¶
Changes (response)
{'SMBLocalGroups': {'GatewayAdmins': ['string']}}
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'
)
- 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 Amazon Web Services Region.
- rtype
dict
- returns
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,
'SMBLocalGroups': {
'GatewayAdmins': [
'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 Amazon Web Services 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 . Only supported for S3 File Gateways.
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. Only supported for S3 File Gateways.
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. Only supported for S3 File Gateways.
SMBLocalGroups (dict) --
A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
GatewayAdmins (list) --
A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats include: DOMAIN\User1 , user1 , DOMAIN\group1 , and group1 .
Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force-close files that are open and locked.
UpdateNFSFileShare (updated)
Link ¶
Changes (request)
{'AuditDestinationARN': 'string'}
Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.
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',
AuditDestinationARN='string'
)
- type FileShareARN
string
- param FileShareARN
[REQUIRED]
The Amazon Resource Name (ARN) of the file share to be updated.
- 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 NFSFileShareDefaults
dict
- param NFSFileShareDefaults
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 .
- 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
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.
- 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 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 , or if an access point or access point alias is used.
- 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 AuditDestinationARN
string
- param AuditDestinationARN
The Amazon Resource Name (ARN) of the storage used for audit logs.
- rtype
dict
- returns
Response Syntax
{
'FileShareARN': 'string'
}
Response Structure
(dict) --
UpdateNFSFileShareOutput