Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Associate an Amazon FSx file system with the 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 FSx File Gateway type.

post/#X-Amz-Target=StorageGateway_20130630.AssociateFileSystem

Headers

X-Amz-Target'StorageGateway_20130630.AssociateFileSystem' required

Request body

UserNamestring 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.

Passwordstring password required

The password of the user credential.

ClientTokenstring required

A unique string value that you supply that is used by the FSx File Gateway to ensure idempotent file system association creation.

GatewayARNstring required

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

LocationARNstring required

The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway.

AuditDestinationARNstring

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

Response

Success

FileSystemAssociationARNstring

The ARN of the newly created file system association.