DisassociateFileSystem - AWS Storage Gateway Service

DisassociateFileSystem

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.

Request Syntax

{ "FileSystemAssociationARN": "string", "ForceDelete": boolean }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

FileSystemAssociationARN

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: Yes

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.

Type: Boolean

Required: No

Response Syntax

{ "FileSystemAssociationARN": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FileSystemAssociationARN

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

Type: String

Length Constraints: Minimum length of 50. Maximum length of 500.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: