AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetObjectAnnotation operation. Retrieves an annotation from an Amazon S3 object. To use this operation, you must have the s3:GetObjectAnnotation permission.

If checksum mode is enabled via the x-amz-checksum-mode header, Amazon S3 returns the stored checksum in the response headers for client-side validation.

Annotations are not supported by the following features: S3 Inventory Reports, API Gateway, S3 Storage Lens, Amazon S3 File Gateway, Amazon FSx, S3 on Outposts, and S3 Express One Zone (directory buckets).

The following operations are related to GetObjectAnnotation:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.S3.Model.GetObjectAnnotationRequest

Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C# 
public class GetObjectAnnotationRequest : AmazonWebServiceRequest
         IAmazonWebServiceRequest

The GetObjectAnnotationRequest type exposes the following members

Constructors

NameDescription
Public Method GetObjectAnnotationRequest()

Properties

NameTypeDescription
Public Property AnnotationName System.String

Gets and sets the property AnnotationName.

The name of the annotation to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 512 bytes.

Public Property BucketName System.String

Gets and sets the property BucketName.

The name of the bucket that contains the object.

Public Property ChecksumMode Amazon.S3.ChecksumMode

Gets and sets the property ChecksumMode.

Set to ENABLED to validate the checksum of the annotation payload on retrieval.

Public Property ExpectedBucketOwner System.String

Gets and sets the property ExpectedBucketOwner.

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with an HTTP 403 (Access Denied) error.

Public Property Key System.String

Gets and sets the property Key.

The object key.

Public Property RequestPayer Amazon.S3.RequestPayer

Gets and sets the property RequestPayer.

Public Property VersionId System.String

Gets and sets the property VersionId.

The version ID of the object.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer