AWS API Changes

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.

IpAddresses (list) --

A list of gateway IP addresses on which the associated Amazon FSx file system is available.

Note

If multiple file systems are associated with this gateway, this field is required.
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'FileSystemAssociationARN': 'string'
}

Response Structure

(dict) --
- FileSystemAssociationARN (string) --
  
  The ARN of the newly created file system association.

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.

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 "/".

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.

(string) --

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.

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.

(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.

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.

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.

type BucketRegion:

string

param BucketRegion:

Specifies the Region of the S3 bucket where the NFS file share stores files.

rtype:

dict

returns:

Response Syntax

{
    'FileShareARN': 'string'
}

Response Structure

(dict) --

CreateNFSFileShareOutput
- FileShareARN (string) --
  
  The Amazon Resource Name (ARN) of the newly created file share.

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.

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:

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 "/".

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:

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.

(string) --

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.

(string) --

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.

(string) --

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.

(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.

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 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.

type BucketRegion:

string

param BucketRegion:

Specifies the Region of the S3 bucket where the SMB file share stores files.

type OplocksEnabled:

boolean

param OplocksEnabled:

Specifies whether opportunistic locking is enabled for the SMB file share.

Valid Values: true | false

rtype:

dict

returns:

Response Syntax

{
    'FileShareARN': 'string'
}

Response Structure

(dict) --

CreateSMBFileShareOutput
- FileShareARN (string) --
  
  The Amazon Resource Name (ARN) of the newly created file share.

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.

(string) --

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

(dict) --
- FileSystemAssociationInfoList (list) --
  
  An array containing the FileSystemAssociationInfo data type of each file system association to be described.
  - (dict) --
    
    Describes the object returned by DescribeFileSystemAssociations that describes a created file system association.
    - FileSystemAssociationARN (string) --
      
      The Amazon Resource Name (ARN) of the file system association.
    - LocationARN (string) --
      
      The ARN of the backend Amazon FSx file system used for storing file data. For information, see FileSystem in the Amazon FSx API Reference.
    - FileSystemAssociationStatus (string) --
      
      The status of the file system association. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | UPDATING | ERROR
    - AuditDestinationARN (string) --
      
      The Amazon Resource Name (ARN) of the storage used for the audit logs.
    - GatewayARN (string) --
      
      The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Region.
    - 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.
      - (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.
    - CacheAttributes (dict) --
      
      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)
    - EndpointNetworkConfiguration (dict) --
      
      Specifies 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.
      - IpAddresses (list) --
        
        A list of gateway IP addresses on which the associated Amazon FSx file system is available.
        
        Note
        
        If multiple file systems are associated with this gateway, this field is required.
        
        (string) --

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

(dict) --

A JSON object containing the following fields:
- GatewayARN (string) --
  
  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Region.
- GatewayId (string) --
  
  The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
- GatewayName (string) --
  
  The name you configured for your gateway.
- GatewayTimezone (string) --
  
  A value that indicates the time zone configured for the gateway.
- GatewayState (string) --
  
  A value that indicates the operating state of the gateway.
- GatewayNetworkInterfaces (list) --
  
  A NetworkInterface array that contains descriptions of the gateway network interfaces.
  - (dict) --
    
    Describes a gateway's network interface.
    - Ipv4Address (string) --
      
      The Internet Protocol version 4 (IPv4) address of the interface.
    - MacAddress (string) --
      
      The Media Access Control (MAC) address of the interface.
      
      Note
      
      This is currently unsupported and will not be returned in output.
    - Ipv6Address (string) --
      
      The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.
- GatewayType (string) --
  
  The type of the gateway.
- NextUpdateAvailabilityDate (string) --
  
  The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
- LastSoftwareUpdate (string) --
  
  The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.
- Ec2InstanceId (string) --
  
  The ID of the Amazon EC2 instance that was used to launch the gateway.
- Ec2InstanceRegion (string) --
  
  The Region where the Amazon EC2 instance is located.
- Tags (list) --
  
  A list of up to 50 tags assigned to the gateway, 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.
- VPCEndpoint (string) --
  
  The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.
- CloudWatchLogGroupARN (string) --
  
  The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.
- HostEnvironment (string) --
  
  The type of hypervisor environment used by the host.
- EndpointType (string) --
  
  The type of endpoint for your gateway.
  
  Valid Values: STANDARD | FIPS
- SoftwareUpdatesEndDate (string) --
  
  Date after which this gateway will not receive software updates for new features.
- DeprecationDate (string) --
  
  Date after which this gateway will not receive software updates for new features and bug fixes.
- GatewayCapacity (string) --
  
  Specifies the size of the gateway's metadata cache.
- SupportedGatewayCapacities (list) --
  
  A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
  - (string) --

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.

(string) --

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

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

(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 Region.
    - KMSEncrypted (boolean) --
      
      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
    - KMSKey (string) --
      
      The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
    - Path (string) --
      
      The file share path used by the NFS client to identify the mount point.
    - Role (string) --
      
      The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.
    - LocationARN (string) --
      
      The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".
    - DefaultStorageClass (string) --
      
      The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.
      
      Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
    - ObjectACL (string) --
      
      A value that sets the access control list (ACL) permission for objects in the S3 bucket that 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.
      
      Note
      
      RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
      
      Valid Values: true | false
    - Tags (list) --
      
      A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
      - (dict) --
        
        A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
        
        Key (string) --
        
        Tag key. The key can't start with aws:.
        
        Value (string) --
        
        Value of the tag key.
    - FileShareName (string) --
      
      The name of the file share. Optional.
      
      Note
      
      FileShareName must be set if an S3 prefix name is set in LocationARN.
    - CacheAttributes (dict) --
      
      Refresh cache information 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.
      
      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.
      
      {}
    - VPCEndpointDNSName (string) --
      
      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.
    - BucketRegion (string) --
      
      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.

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.

(string) --

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

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

(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 Region.
    - KMSEncrypted (boolean) --
      
      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
    - KMSKey (string) --
      
      The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.
    - Path (string) --
      
      The file share path used by the SMB client to identify the mount point.
    - Role (string) --
      
      The ARN of the IAM role that an S3 File Gateway assumes when it accesses the underlying storage.
    - LocationARN (string) --
      
      The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a "/".
    - DefaultStorageClass (string) --
      
      The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.
      
      Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA
    - ObjectACL (string) --
      
      A value that sets the access control list (ACL) permission for objects in the S3 bucket that 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.
      
      Note
      
      RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
      
      Valid Values: true | false
    - SMBACLEnabled (boolean) --
      
      If this value is set to true, it indicates that access control list (ACL) is enabled on the SMB file share. If it is set to false, it indicates that file and directory permissions are mapped to the POSIX permission.
      
      For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.
    - AccessBasedEnumeration (boolean) --
      
      Indicates whether AccessBasedEnumeration is enabled.
    - AdminUserList (list) --
      
      A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.
      - (string) --
    - ValidUserList (list) --
      
      A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.
      - (string) --
    - InvalidUserList (list) --
      
      A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.
      - (string) --
    - AuditDestinationARN (string) --
      
      The Amazon Resource Name (ARN) of the storage used for audit logs.
    - Authentication (string) --
      
      The authentication method of the file share. The default is ActiveDirectory.
      
      Valid Values: ActiveDirectory | GuestAccess
    - CaseSensitivity (string) --
      
      The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
    - Tags (list) --
      
      A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.
      - (dict) --
        
        A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.
        
        Key (string) --
        
        Tag key. The key can't start with aws:.
        
        Value (string) --
        
        Value of the tag key.
    - FileShareName (string) --
      
      The name of the file share. Optional.
      
      Note
      
      FileShareName must be set if an S3 prefix name is set in LocationARN.
    - CacheAttributes (dict) --
      
      Refresh cache information 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.
      
      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.
      
      {}
    - VPCEndpointDNSName (string) --
      
      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.
    - BucketRegion (string) --
      
      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.
    - OplocksEnabled (boolean) --
      
      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

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.

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

(dict) --

A JSON object containing the Amazon Resource Name (ARN) of the gateway that was updated.
- GatewayARN (string) --
  
  The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Region.
- GatewayName (string) --
  
  The name you configured for your gateway.

UpdateSMBFileShare (updated)

Link ¶
Changes (request)

{'OplocksEnabled': 'boolean'}

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',
    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:

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:

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.

(string) --

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.

(string) --

type InvalidUserList:

list

param InvalidUserList:

(string) --

type AuditDestinationARN:

string

param AuditDestinationARN:

The Amazon Resource Name (ARN) of the storage used for audit logs.

type CaseSensitivity:

string

param CaseSensitivity:

type FileShareName:

string

param FileShareName:

The name of the file share. Optional.

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 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.

Valid Values: true | false

rtype:

dict

returns:

Response Syntax

{
    'FileShareARN': 'string'
}

Response Structure

(dict) --

UpdateSMBFileShareOutput
- FileShareARN (string) --
  
  The Amazon Resource Name (ARN) of the updated SMB file share.