DescribeFileSystems
Returns the description of specific Amazon FSx file systems, if a
FileSystemIds value is provided for that file system. Otherwise, it
returns descriptions of all file systems owned by your AWS account in the
AWS Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the
MaxResults parameter to limit the number of descriptions in a response.
If more file system descriptions remain, Amazon FSx returns a
NextToken value in the response. In this case, send a later request
with the NextToken request parameter set to the value of
NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system
descriptions. DescribeFileSystems is called first without a
NextTokenvalue. Then the operation continues to be called with the
NextToken parameter set to the value of the last NextToken
value until a response has no NextToken.
When using this operation, keep the following in mind:
-
The implementation might return fewer than
MaxResultsfile system descriptions while still including aNextTokenvalue. -
The order of file systems returned in the response of one
DescribeFileSystemscall and the order of file systems returned across the responses of a multicall iteration is unspecified.
Request Syntax
{
"FileSystemIds": [ "string" ],
"MaxResults": number,
"NextToken": "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.
- FileSystemIds
-
IDs of the file systems whose descriptions you want to retrieve (String).
Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Minimum length of 11. Maximum length of 21.
Pattern:
^(fs-[0-9a-f]{8,})$Required: No
- MaxResults
-
Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the
MaxResultsparameter specified in the request and the service's internal maximum number of items per page.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 2147483647.
Required: No
- NextToken
-
Opaque pagination token returned from a previous
DescribeFileSystemsoperation (String). If a token present, the operation continues the list from where the returning call left off.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$Required: No
Response Syntax
{
"FileSystems": [
{
"AdministrativeActions": [
{
"AdministrativeActionType": "string",
"FailureDetails": {
"Message": "string"
},
"ProgressPercent": number,
"RemainingTransferBytes": number,
"RequestTime": number,
"Status": "string",
"TargetFileSystemValues": "FileSystem",
"TargetSnapshotValues": {
"AdministrativeActions": [
"AdministrativeAction"
],
"CreationTime": number,
"Lifecycle": "string",
"LifecycleTransitionReason": {
"Message": "string"
},
"Name": "string",
"ResourceARN": "string",
"SnapshotId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VolumeId": "string"
},
"TargetVolumeValues": {
"AdministrativeActions": [
"AdministrativeAction"
],
"CreationTime": number,
"FileSystemId": "string",
"Lifecycle": "string",
"LifecycleTransitionReason": {
"Message": "string"
},
"Name": "string",
"OntapConfiguration": {
"AggregateConfiguration": {
"Aggregates": [ "string" ],
"TotalConstituents": number
},
"CopyTagsToBackups": boolean,
"FlexCacheEndpointType": "string",
"JunctionPath": "string",
"OntapVolumeType": "string",
"SecurityStyle": "string",
"SizeInBytes": number,
"SizeInMegabytes": number,
"SnaplockConfiguration": {
"AuditLogVolume": boolean,
"AutocommitPeriod": {
"Type": "string",
"Value": number
},
"PrivilegedDelete": "string",
"RetentionPeriod": {
"DefaultRetention": {
"Type": "string",
"Value": number
},
"MaximumRetention": {
"Type": "string",
"Value": number
},
"MinimumRetention": {
"Type": "string",
"Value": number
}
},
"SnaplockType": "string",
"VolumeAppendModeEnabled": boolean
},
"SnapshotPolicy": "string",
"StorageEfficiencyEnabled": boolean,
"StorageVirtualMachineId": "string",
"StorageVirtualMachineRoot": boolean,
"TieringPolicy": {
"CoolingPeriod": number,
"Name": "string"
},
"UUID": "string",
"VolumeStyle": "string"
},
"OpenZFSConfiguration": {
"CopyStrategy": "string",
"CopyTagsToSnapshots": boolean,
"DataCompressionType": "string",
"DeleteClonedVolumes": boolean,
"DeleteIntermediateData": boolean,
"DeleteIntermediateSnaphots": boolean,
"DestinationSnapshot": "string",
"NfsExports": [
{
"ClientConfigurations": [
{
"Clients": "string",
"Options": [ "string" ]
}
]
}
],
"OriginSnapshot": {
"CopyStrategy": "string",
"SnapshotARN": "string"
},
"ParentVolumeId": "string",
"ReadOnly": boolean,
"RecordSizeKiB": number,
"RestoreToSnapshot": "string",
"SourceSnapshotARN": "string",
"StorageCapacityQuotaGiB": number,
"StorageCapacityReservationGiB": number,
"UserAndGroupQuotas": [
{
"Id": number,
"StorageCapacityQuotaGiB": number,
"Type": "string"
}
],
"VolumePath": "string"
},
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VolumeId": "string",
"VolumeType": "string"
},
"TotalTransferBytes": number
}
],
"CreationTime": number,
"DNSName": "string",
"FailureDetails": {
"Message": "string"
},
"FileSystemId": "string",
"FileSystemType": "string",
"FileSystemTypeVersion": "string",
"KmsKeyId": "string",
"Lifecycle": "string",
"LustreConfiguration": {
"AutomaticBackupRetentionDays": number,
"CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string",
"DataCompressionType": "string",
"DataRepositoryConfiguration": {
"AutoImportPolicy": "string",
"ExportPath": "string",
"FailureDetails": {
"Message": "string"
},
"ImportedFileChunkSize": number,
"ImportPath": "string",
"Lifecycle": "string"
},
"DeploymentType": "string",
"DriveCacheType": "string",
"EfaEnabled": boolean,
"LogConfiguration": {
"Destination": "string",
"Level": "string"
},
"MetadataConfiguration": {
"Iops": number,
"Mode": "string"
},
"MountName": "string",
"PerUnitStorageThroughput": number,
"RootSquashConfiguration": {
"NoSquashNids": [ "string" ],
"RootSquash": "string"
},
"WeeklyMaintenanceStartTime": "string"
},
"NetworkInterfaceIds": [ "string" ],
"OntapConfiguration": {
"AutomaticBackupRetentionDays": number,
"DailyAutomaticBackupStartTime": "string",
"DeploymentType": "string",
"DiskIopsConfiguration": {
"Iops": number,
"Mode": "string"
},
"EndpointIpAddressRange": "string",
"Endpoints": {
"Intercluster": {
"DNSName": "string",
"IpAddresses": [ "string" ]
},
"Management": {
"DNSName": "string",
"IpAddresses": [ "string" ]
}
},
"FsxAdminPassword": "string",
"HAPairs": number,
"PreferredSubnetId": "string",
"RouteTableIds": [ "string" ],
"ThroughputCapacity": number,
"ThroughputCapacityPerHAPair": number,
"WeeklyMaintenanceStartTime": "string"
},
"OpenZFSConfiguration": {
"AutomaticBackupRetentionDays": number,
"CopyTagsToBackups": boolean,
"CopyTagsToVolumes": boolean,
"DailyAutomaticBackupStartTime": "string",
"DeploymentType": "string",
"DiskIopsConfiguration": {
"Iops": number,
"Mode": "string"
},
"EndpointIpAddress": "string",
"EndpointIpAddressRange": "string",
"PreferredSubnetId": "string",
"ReadCacheConfiguration": {
"SizeGiB": number,
"SizingMode": "string"
},
"RootVolumeId": "string",
"RouteTableIds": [ "string" ],
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
},
"OwnerId": "string",
"ResourceARN": "string",
"StorageCapacity": number,
"StorageType": "string",
"SubnetIds": [ "string" ],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VpcId": "string",
"WindowsConfiguration": {
"ActiveDirectoryId": "string",
"Aliases": [
{
"Lifecycle": "string",
"Name": "string"
}
],
"AuditLogConfiguration": {
"AuditLogDestination": "string",
"FileAccessAuditLogLevel": "string",
"FileShareAccessAuditLogLevel": "string"
},
"AutomaticBackupRetentionDays": number,
"CopyTagsToBackups": boolean,
"DailyAutomaticBackupStartTime": "string",
"DeploymentType": "string",
"DiskIopsConfiguration": {
"Iops": number,
"Mode": "string"
},
"MaintenanceOperationsInProgress": [ "string" ],
"PreferredFileServerIp": "string",
"PreferredSubnetId": "string",
"RemoteAdministrationEndpoint": "string",
"SelfManagedActiveDirectoryConfiguration": {
"DnsIps": [ "string" ],
"DomainName": "string",
"FileSystemAdministratorsGroup": "string",
"OrganizationalUnitDistinguishedName": "string",
"UserName": "string"
},
"ThroughputCapacity": number,
"WeeklyMaintenanceStartTime": "string"
}
}
],
"NextToken": "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.
- FileSystems
-
An array of file system descriptions.
Type: Array of FileSystem objects
Array Members: Maximum number of 50 items.
- NextToken
-
Present if there are more file systems than returned in the response (String). You can use the
NextTokenvalue in the later request to fetch the descriptions.Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequest
-
A generic error indicating a failure with a client request.
HTTP Status Code: 400
- FileSystemNotFound
-
No Amazon FSx file systems were found based upon supplied parameters.
HTTP Status Code: 400
- InternalServerError
-
A generic error indicating a server-side failure.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
