StorageGateway / Client / describe_file_system_associations

describe_file_system_associations

StorageGateway.Client.describe_file_system_associations(**kwargs)

Gets the file system association information. This operation is only supported for FSx File Gateways.

See also: AWS API Documentation

Request Syntax

response = client.describe_file_system_associations(
    FileSystemAssociationARNList=[
        'string',
    ]
)

Parameters:

FileSystemAssociationARNList (list) –

[REQUIRED]

An array containing the Amazon Resource Name (ARN) of each file system association to be described.

• (string) –

Return type:

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

• (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 Amazon Web Services 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) –

      • FileSystemAssociationStatusDetails (list) –

        An array containing the FileSystemAssociationStatusDetail data type, which provides detailed information on file system association status.

        • (dict) –

          Detailed information on file system association status.

          • ErrorCode (string) –

            The error code for a given file system association status.

Exceptions

• StorageGateway.Client.exceptions.InvalidGatewayRequestException

• StorageGateway.Client.exceptions.InternalServerError