Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
Use GetObjectRetention
with an Amazon SDK or CLI
The following code examples show how to use GetObjectRetention
.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in
context in the following code example:
- .NET
-
- Amazon SDK for .NET
-
/// <summary>
/// Get the retention period for an S3 object.
/// </summary>
/// <param name="bucketName">The bucket of the object.</param>
/// <param name="objectKey">The object key.</param>
/// <returns>The object retention details.</returns>
public async Task<ObjectLockRetention> GetObjectRetention(string bucketName,
string objectKey)
{
try
{
var request = new GetObjectRetentionRequest()
{
BucketName = bucketName,
Key = objectKey
};
var response = await _amazonS3.GetObjectRetentionAsync(request);
Console.WriteLine($"\tObject retention for {objectKey} in {bucketName}: " +
$"\n\t{response.Retention.Mode} until {response.Retention.RetainUntilDate:d}.");
return response.Retention;
}
catch (AmazonS3Exception ex)
{
Console.WriteLine($"\tUnable to fetch object lock retention: '{ex.Message}'");
return new ObjectLockRetention();
}
}
- CLI
-
- Amazon CLI
-
To retrieve the object retention configuration for an object
The following get-object-retention
example retrieves the object retention configuration for the specified object.
aws s3api get-object-retention \
--bucket my-bucket-with-object-lock \
--key doc1.rtf
Output:
{
"Retention": {
"Mode": "GOVERNANCE",
"RetainUntilDate": "2025-01-01T00:00:00.000Z"
}
}
- Java
-
- SDK for Java 2.x
-
// Get the retention period for an S3 object.
public ObjectLockRetention getObjectRetention(String bucketName, String key){
try {
GetObjectRetentionRequest retentionRequest = GetObjectRetentionRequest.builder()
.bucket(bucketName)
.key(key)
.build();
GetObjectRetentionResponse response = getClient().getObjectRetention(retentionRequest);
System.out.println("tObject retention for "+key +" in "+ bucketName +": " + response.retention().mode() +" until "+ response.retention().retainUntilDate() +".");
return response.retention();
} catch (S3Exception e) {
System.err.println(e.awsErrorDetails().errorMessage());
return null;
}
}
- PowerShell
-
- Tools for PowerShell
-
Example 1: The command returns the mode and date till the object would be retained.
Get-S3ObjectRetention -BucketName 's3buckettesting' -Key 'testfile.txt'
For a complete list of Amazon SDK developer guides and code examples, see
Using this service with an Amazon SDK.
This topic also includes information about getting started and details about previous SDK versions.