- 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.
GetObjectLegalHoldCommand
This operation is not supported for directory buckets.
Gets an object's current legal hold status. For more information, see Locking Objects .
This functionality is not supported for Amazon S3 on Outposts.
The following action is related to GetObjectLegalHold
:
Example Syntax
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 input = { // GetObjectLegalHoldRequest
Bucket: "STRING_VALUE", // required
Key: "STRING_VALUE", // required
VersionId: "STRING_VALUE",
RequestPayer: "requester",
ExpectedBucketOwner: "STRING_VALUE",
};
const command = new GetObjectLegalHoldCommand(input);
const response = await client.send(command);
// { // GetObjectLegalHoldOutput
// LegalHold: { // ObjectLockLegalHold
// Status: "ON" || "OFF",
// },
// };
GetObjectLegalHoldCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
Bucket Required | string | undefined | The bucket name containing the object whose legal hold status you want to retrieve. Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues |
Key Required | string | undefined | The key name for the object whose legal hold status you want to retrieve. |
ExpectedBucketOwner | string | undefined | The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code |
RequestPayer | RequestPayer | undefined | Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide. This functionality is not supported for directory buckets. |
VersionId | string | undefined | The version ID of the object whose legal hold status you want to retrieve. |
GetObjectLegalHoldCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
LegalHold | ObjectLockLegalHold | undefined | The current legal hold status for the specified object. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
S3ServiceException | Base exception class for all service exceptions from S3 service. |