GetSnapshotBlockPublicAccessStateCommand

Suggest an Edit

Gets the current state of block public access for snapshots setting for the account and Region.

For more information, see Block public access for snapshots  in the Amazon EBS User Guide.

Example Syntax

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

import { EC2Client, GetSnapshotBlockPublicAccessStateCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, GetSnapshotBlockPublicAccessStateCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // GetSnapshotBlockPublicAccessStateRequest
  DryRun: true || false,
};
const command = new GetSnapshotBlockPublicAccessStateCommand(input);
const response = await client.send(command);
// { // GetSnapshotBlockPublicAccessStateResult
//   State: "block-all-sharing" || "block-new-sharing" || "unblocked",
//   ManagedBy: "account" || "declarative-policy",
// };

GetSnapshotBlockPublicAccessStateCommand Input

See GetSnapshotBlockPublicAccessStateCommandInput 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.

GetSnapshotBlockPublicAccessStateCommand Output

See GetSnapshotBlockPublicAccessStateCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ManagedBy
ManagedBy | undefined

The entity that manages the state for block public access for snapshots. Possible values include:

  • account - The state is managed by the account.

  • declarative-policy - The state is managed by a declarative policy and can't be modified by the account.

State
SnapshotBlockPublicAccessState | undefined

The current state of block public access for snapshots. Possible values include:

  • block-all-sharing - All public sharing of snapshots is blocked. Users in the account can't request new public sharing. Additionally, snapshots that were already publicly shared are treated as private and are not publicly available.

  • block-new-sharing - Only new public sharing of snapshots is blocked. Users in the account can't request new public sharing. However, snapshots that were already publicly shared, remain publicly available.

  • unblocked - Public sharing is not blocked. Users can publicly share snapshots.

Throws

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