StorageGateway / Client / update_file_system_association

update_file_system_association#

StorageGateway.Client.update_file_system_association(**kwargs)#

Updates a file system association. This operation is only supported in the FSx File Gateways.

See also: AWS API Documentation

Request Syntax

response = client.update_file_system_association(
    FileSystemAssociationARN='string',
    UserName='string',
    Password='string',
    AuditDestinationARN='string',
    CacheAttributes={
        'CacheStaleTimeoutInSeconds': 123
    }
)
Parameters:

  • FileSystemAssociationARN (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the file system association that you want to update.

  • UserName (string) – 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.

  • Password (string) – The password of the user credential.

  • AuditDestinationARN (string) – The Amazon Resource Name (ARN) of the storage used for the audit logs.

  • 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)

Return type:

dict

Returns:

Response Syntax

{
    'FileSystemAssociationARN': 'string'
}

Response Structure

  • (dict) –

    • FileSystemAssociationARN (string) –

      The ARN of the updated file system association.

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError