- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UnlockSnapshotCommand
Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance mode after the cooling-off period has expired.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EC2Client, UnlockSnapshotCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, UnlockSnapshotCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // UnlockSnapshotRequest
SnapshotId: "STRING_VALUE", // required
DryRun: true || false,
};
const command = new UnlockSnapshotCommand(input);
const response = await client.send(command);
// { // UnlockSnapshotResult
// SnapshotId: "STRING_VALUE",
// };
UnlockSnapshotCommand Input
See UnlockSnapshotCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
SnapshotIdRequired | string | undefined | The ID of the snapshot to unlock. |
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 |
UnlockSnapshotCommand Output
See UnlockSnapshotCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
SnapshotId | string | undefined | The ID of the snapshot. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| EC2ServiceException | Base exception class for all service exceptions from EC2 service. |