Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeFileSystemAssociations

Gets the file system association information. This operation is only supported for FSx File Gateways.

Request Syntax


{
   "FileSystemAssociationARNList": [ "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.

FileSystemAssociationARNList

An array containing the Amazon Resource Name (ARN) of each file system association to be described.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

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

Required: Yes

Response Syntax


{
   "FileSystemAssociationInfoList": [ 
      { 
         "AuditDestinationARN": "string",
         "CacheAttributes": { 
            "CacheStaleTimeoutInSeconds": number
         },
         "EndpointNetworkConfiguration": { 
            "IpAddresses": [ "string" ]
         },
         "FileSystemAssociationARN": "string",
         "FileSystemAssociationStatus": "string",
         "FileSystemAssociationStatusDetails": [ 
            { 
               "ErrorCode": "string"
            }
         ],
         "GatewayARN": "string",
         "LocationARN": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "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.

FileSystemAssociationInfoList

An array containing the FileSystemAssociationInfo data type of each file system association to be described.

Type: Array of FileSystemAssociationInfo objects

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

Examples

Example

This example illustrates one usage of DescribeFileSystemAssociations.


__Sample Request__
{
  "FileSystemAssociationARNList": ["arn:aws:storagegateway:us-east-1:111122223333:fs-association/fsa-1122AABBCCDDEEFFG"]
}

Example

This example illustrates one usage of DescribeFileSystemAssociations.


__Sample Response__
{
  "FileSystemAssociationInfoList":
  [
    
     "FileSystemAssociationARN": "arn:aws:storagegateway:us-east-1:111122223333:fs-association/fsa-1122AABBCCDDEEFFG",
     "FileSystemAssociationStatus": " AVAILABLE", 
     "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-7A8D6313",
     "LocationARN": "arn:aws:fsx:us-east-1:111122223333:file-system/fs-0bb4bf5cedebd814f",
     "Tags":
      []
    }
  ]
}