DescribeFastSnapshotRestoresCommand

Suggest an Edit

Describes the state of fast snapshot restores for your snapshots.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DescribeFastSnapshotRestoresCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeFastSnapshotRestoresCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeFastSnapshotRestoresRequest
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE",
      Values: [ // ValueStringList
        "STRING_VALUE",
      ],
    },
  ],
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
  DryRun: true || false,
};
const command = new DescribeFastSnapshotRestoresCommand(input);
const response = await client.send(command);
// { // DescribeFastSnapshotRestoresResult
//   FastSnapshotRestores: [ // DescribeFastSnapshotRestoreSuccessSet
//     { // DescribeFastSnapshotRestoreSuccessItem
//       SnapshotId: "STRING_VALUE",
//       AvailabilityZone: "STRING_VALUE",
//       State: "enabling" || "optimizing" || "enabled" || "disabling" || "disabled",
//       StateTransitionReason: "STRING_VALUE",
//       OwnerId: "STRING_VALUE",
//       OwnerAlias: "STRING_VALUE",
//       EnablingTime: new Date("TIMESTAMP"),
//       OptimizingTime: new Date("TIMESTAMP"),
//       EnabledTime: new Date("TIMESTAMP"),
//       DisablingTime: new Date("TIMESTAMP"),
//       DisabledTime: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeFastSnapshotRestoresCommand Input

See DescribeFastSnapshotRestoresCommandInput for more details

Parameter
Type
Description
DryRun
boolean | undefined

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Filters
Filter[] | undefined

The filters. The possible values are:

  • availability-zone: The Availability Zone of the snapshot.

  • owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.

  • snapshot-id: The ID of the snapshot.

  • state: The state of fast snapshot restores for the snapshot (enabling | optimizing | enabled | disabling | disabled).

MaxResults
number | undefined

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination .

NextToken
string | undefined

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

DescribeFastSnapshotRestoresCommand Output

See DescribeFastSnapshotRestoresCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
FastSnapshotRestores
DescribeFastSnapshotRestoreSuccessItem[] | undefined

Information about the state of fast snapshot restores.

NextToken
string | undefined

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.