Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetObjectLegalHoldCommand

Gets an object's current Legal Hold status. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

example

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

import { S3Client, GetObjectLegalHoldCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, GetObjectLegalHoldCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const command = new GetObjectLegalHoldCommand(input);
const response = await client.send(command);
see

GetObjectLegalHoldCommandInput for command's input shape.

see

GetObjectLegalHoldCommandOutput for command's response shape.

see

config for S3Client's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: GetObjectLegalHoldCommandInput

Readonly middlewareStack