DescribeSnapshots
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a
SnapshotIds value is provided. Otherwise, this operation returns all
snapshots owned by your AWS account in the AWS Region of
the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults
parameter to limit the number of snapshots 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 NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots.
DescribeSnapshots 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 snapshot descriptions while still including aNextTokenvalue. -
The order of snapshots returned in the response of one
DescribeSnapshotscall and the order of backups returned across the responses of a multi-call iteration is unspecified.
Request Syntax
{
"Filters": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"IncludeShared": boolean,
"MaxResults": number,
"NextToken": "string",
"SnapshotIds": [ "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.
- Filters
-
The filters structure. The supported names are
file-system-idorvolume-id.Type: Array of SnapshotFilter objects
Array Members: Maximum number of 2 items.
Required: No
-
Set to
false(default) if you want to only see the snapshots owned by your AWS account. Set totrueif you want to see the snapshots in your account and the ones shared with you from another account.Type: Boolean
Required: No
- MaxResults
-
The maximum number of resources to return in the response. This value must be an integer greater than zero.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 2147483647.
Required: No
- NextToken
-
(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextTokenvalue 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
- SnapshotIds
-
The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a
SnapshotNotFounderror occurs.Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Minimum length of 11. Maximum length of 28.
Pattern:
^((fs)?volsnap-[0-9a-f]{8,})$Required: No
Response Syntax
{
"NextToken": "string",
"Snapshots": [
{
"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": "Snapshot",
"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,
"Lifecycle": "string",
"LifecycleTransitionReason": {
"Message": "string"
},
"Name": "string",
"ResourceARN": "string",
"SnapshotId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VolumeId": "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.
- NextToken
-
(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous
NextTokenvalue 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}=)?$ - Snapshots
-
An array of snapshots.
Type: Array of Snapshot objects
Array Members: Maximum number of 50 items.
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
- InternalServerError
-
A generic error indicating a server-side failure.
HTTP Status Code: 500
- SnapshotNotFound
-
No Amazon FSx snapshots were found based on 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:
