StorageGateway / Client / disassociate_file_system

disassociate_file_system#

StorageGateway.Client.disassociate_file_system(**kwargs)#

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 FSx File Gateway type.

See also: AWS API Documentation

Request Syntax

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

  • FileSystemAssociationARN (string) –

    [REQUIRED]

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

  • ForceDelete (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'FileSystemAssociationARN': 'string'
}

Response Structure

  • (dict) –

    • FileSystemAssociationARN (string) –

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

Exceptions

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException

  • StorageGateway.Client.exceptions.InternalServerError