AWS Storage Gateway

Updates a file system association. This operation is only supported in the Amazon FSx file gateway type.

See also: AWS API Documentation

Request Syntax

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

type FileSystemAssociationARN:

string

param FileSystemAssociationARN:

[REQUIRED]

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

type UserName:

string

param UserName:

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:

The password of the user credential.

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.

• 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: 300 to 2,592,000 seconds (5 minutes to 30 days)

rtype:

dict

returns:

Response Syntax

{
    'FileSystemAssociationARN': 'string'
}

Response Structure

• (dict) --

  • FileSystemAssociationARN (string) --

    The ARN of the updated file system association.

Gets a list of FileSystemAssociationSummary objects. Each object contains a summary of a file system association. This operation is only supported for Amazon FSx file gateways.

See also: AWS API Documentation

Request Syntax

client.list_file_system_associations(
    GatewayARN='string',
    Limit=123,
    Marker='string'
)

type GatewayARN:

string

param GatewayARN:

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

type Limit:

integer

param Limit:

The maximum number of file system associations to return in the response. If present, Limit must be an integer with a value greater than zero. Optional.

type Marker:

string

param Marker:

Opaque pagination token returned from a previous ListFileSystemAssociations operation. If present, Marker specifies where to continue the list from after a previous call to ListFileSystemAssociations. Optional.

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'NextMarker': 'string',
    'FileSystemAssociationSummaryList': [
        {
            'FileSystemAssociationId': 'string',
            'FileSystemAssociationARN': 'string',
            'FileSystemAssociationStatus': 'string',
            'GatewayARN': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • Marker (string) --

    If the request includes Marker, the response returns that value in this field.

  • NextMarker (string) --

    If a value is present, there are more file system associations to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file system associations.

  • FileSystemAssociationSummaryList (list) --

    An array of information about the Amazon FSx gateway's file system associations.

    • (dict) --

      Gets the summary returned by ListFileSystemAssociation, which is a summary of a created file system association.

      • FileSystemAssociationId (string) --

        The ID of the file system association.

      • FileSystemAssociationARN (string) --

        The Amazon Resource Name (ARN) of the file system association.

      • FileSystemAssociationStatus (string) --

        The status of the file share. Valid Values: AVAILABLE | CREATING | DELETING | FORCE_DELETING | MISCONFIGURED | UPDATING | UNAVAILABLE

      • GatewayARN (string) --

        The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

Gets the file system association information. This operation is only supported for Amazon 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
            }
        },
    ]
}

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 | MISCONFIGURED | UPDATING | UNAVAILABLE

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

        • 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: 300 to 2,592,000 seconds (5 minutes to 30 days)

Disassociates an Amazon FSx file system from the specified gateway. After the disassociation process finishes, the gateway can no longer access the Amazon FSx file system. This operation is only supported in the Amazon FSx file gateway type.

See also: AWS API Documentation

Request Syntax

client.disassociate_file_system(
    FileSystemAssociationARN='string',
    ForceDelete=True|False
)

type FileSystemAssociationARN:

string

param FileSystemAssociationARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the file system association to be deleted.

type ForceDelete:

boolean

param ForceDelete:

If this value is set to true, the operation disassociates an Amazon FSx file system immediately. It ends all data uploads to the file system, and the file system association enters the FORCE_DELETING status. If this value is set to false, the Amazon FSx file system does not disassociate until all data is uploaded.

rtype:

dict

returns:

Response Syntax

{
    'FileSystemAssociationARN': 'string'
}

Response Structure

• (dict) --

  • FileSystemAssociationARN (string) --

    The Amazon Resource Name (ARN) of the deleted file system association.

Associate an Amazon FSx file system with the Amazon 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 Amazon 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
    }
)

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

type LocationARN:

string

param LocationARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the Amazon 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.

• 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: 300 to 2,592,000 seconds (5 minutes to 30 days)

rtype:

dict

returns:

Response Syntax

{
    'FileSystemAssociationARN': 'string'
}

Response Structure

• (dict) --

  • FileSystemAssociationARN (string) --

    The ARN of the newly created file system association.