ListFileSystemAssociations
Gets a list of FileSystemAssociationSummary objects. Each object contains a
summary of a file system association. This operation is only supported for FSx File
Gateways.
Request Syntax
{
"GatewayARN": "string",
"Limit": number,
"Marker": "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.
- GatewayARN
-
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: No
- Limit
-
The maximum number of file system associations to return in the response. If present,
Limitmust be an integer with a value greater than zero. Optional.Type: Integer
Valid Range: Minimum value of 1.
Required: No
- Marker
-
Opaque pagination token returned from a previous
ListFileSystemAssociationsoperation. If present,Markerspecifies where to continue the list from after a previous call toListFileSystemAssociations. Optional.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
Response Syntax
{
"FileSystemAssociationSummaryList": [
{
"FileSystemAssociationARN": "string",
"FileSystemAssociationId": "string",
"FileSystemAssociationStatus": "string",
"GatewayARN": "string"
}
],
"Marker": "string",
"NextMarker": "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.
- FileSystemAssociationSummaryList
-
An array of information about the Amazon FSx gateway's file system associations.
Type: Array of FileSystemAssociationSummary objects
- Marker
-
If the request includes
Marker, the response returns that value in this field.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
- NextMarker
-
If a value is present, there are more file system associations to return. In a subsequent request, use
NextMarkeras the value forMarkerto retrieve the next set of file system associations.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
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:
