DescribeBackups
Returns the description of a specific Amazon FSx backup, if a
BackupIds value is provided for that backup. Otherwise, it returns all
backups owned by your AWS account in the AWS Region of the
endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults
parameter to limit the number of backups in a response. If more backups 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 the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups.
DescribeBackups is called first without a NextToken value.
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 value.
When using this operation, keep the following in mind:
-
The operation might return fewer than the
MaxResultsvalue of backup descriptions while still including aNextTokenvalue. -
The order of the backups returned in the response of one
DescribeBackupscall and the order of the backups returned across the responses of a multi-call iteration is unspecified.
Request Syntax
{
"BackupIds": [ "string" ],
"Filters": [
{
"Name": "string",
"Values": [ "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.
- BackupIds
-
The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a
BackupNotFounderror occurs.Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Minimum length of 12. Maximum length of 128.
Pattern:
^(backup-[0-9a-f]{8,})$Required: No
- Filters
-
The filters structure. The supported names are
file-system-id,backup-type,file-system-type, andvolume-id.Type: Array of Filter objects
Array Members: Maximum number of 10 items.
Required: No
- MaxResults
-
Maximum number of backups to return in the response. 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
-
An opaque pagination token returned from a previous
DescribeBackupsoperation. If a token is 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
{
"Backups": [
{
"BackupId": "string",
"CreationTime": number,
"DirectoryInformation": {
"ActiveDirectoryId": "string",
"DomainName": "string",
"ResourceARN": "string"
},
"FailureDetails": {
"Message": "string"
},
"FileSystem": {
"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",
"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",
"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"
}
},
"KmsKeyId": "string",
"Lifecycle": "string",
"OwnerId": "string",
"ProgressPercent": number,
"ResourceARN": "string",
"ResourceType": "string",
"SourceBackupId": "string",
"SourceBackupRegion": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Type": "string",
"Volume": {
"AdministrativeActions": [
{
"AdministrativeActionType": "string",
"FailureDetails": {
"Message": "string"
},
"ProgressPercent": number,
"RemainingTransferBytes": number,
"RequestTime": number,
"Status": "string",
"TargetFileSystemValues": {
"AdministrativeActions": [
"AdministrativeAction"
],
"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",
"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",
"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"
}
},
"TargetSnapshotValues": {
"AdministrativeActions": [
"AdministrativeAction"
],
"CreationTime": number,
"Lifecycle": "string",
"LifecycleTransitionReason": {
"Message": "string"
},
"Name": "string",
"ResourceARN": "string",
"SnapshotId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VolumeId": "string"
},
"TargetVolumeValues": "Volume",
"TotalTransferBytes": number
}
],
"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"
}
}
],
"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.
- Backups
-
An array of backups.
Type: Array of Backup objects
Array Members: Maximum number of 50 items.
- NextToken
-
A
NextTokenvalue is present if there are more backups than returned in the response. You can use theNextTokenvalue in the subsequent request to fetch the backups.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.
- BackupNotFound
-
No Amazon FSx backups were found based upon the supplied parameters.
HTTP Status Code: 400
- 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
- VolumeNotFound
-
No Amazon FSx volumes were found based upon the supplied parameters.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
