Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateFileSystemAssociation

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

Request Syntax


{
   "AuditDestinationARN": "string",
   "CacheAttributes": { 
      "CacheStaleTimeoutInSeconds": number
   },
   "FileSystemAssociationARN": "string",
   "Password": "string",
   "UserName": "string"
}

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.

AuditDestinationARN

The Amazon Resource Name (ARN) of the storage used for the audit logs.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

CacheAttributes

The refresh cache information for the file share or FSx file systems.

Type: CacheAttributes object

Required: No

FileSystemAssociationARN

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

Type: String

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

Required: Yes

Password

The password of the user credential.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^[ -~]+$

Required: No

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: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\w[\w\.\- ]*$

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 ARN of the updated 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.

error: A StorageGatewayError that provides more information about the cause of the error.
message: A human-readable message describing the error that occurred.

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.

error: A StorageGatewayError that provides more detail about the cause of the error.
message: A human-readable message describing the error that occurred.

HTTP Status Code: 400