AWS CLI Command Reference

[ aws . s3api ]

get-object-annotation

Description

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.

Note

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 :

See also: AWS API Documentation

Synopsis

  get-object-annotation
--bucket <value>
--key <value>
--annotation-name <value>
[--version-id <value>]
[--request-payer <value>]
[--expected-bucket-owner <value>]
[--checksum-mode <value>]
<outfile>
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--bucket (string) [required]

The name of the bucket that contains the object.

--key (string) [required]

The object key.

Constraints:

  • min: 1

--annotation-name (string) [required]

The name of the annotation to retrieve.

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

--version-id (string)

The version ID of the object.

--request-payer (string)

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 the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide .

Note

This functionality is not supported for directory buckets.

Possible values:

  • requester

--expected-bucket-owner (string)

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.

--checksum-mode (string)

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

Possible values:

  • ENABLED

outfile (string) [required] Filename where the content will be saved

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

AnnotationPayload -> (streaming blob)

The annotation payload.

ObjectVersionId -> (string)

The version ID of the object that the annotation is attached to.

LastModified -> (timestamp)

The date and time the annotation was last modified.

ContentLength -> (long)

The size of the annotation payload, in bytes.

ETag -> (string)

The entity tag of the annotation.

ChecksumCRC32 -> (string)

The CRC32 checksum of the annotation payload.

ChecksumCRC32C -> (string)

The CRC32C checksum of the annotation payload.

ChecksumCRC64NVME -> (string)

The CRC64NVME checksum of the annotation payload.

ChecksumSHA1 -> (string)

The SHA1 checksum of the annotation payload.

ChecksumSHA256 -> (string)

The SHA256 checksum of the annotation payload.

ChecksumSHA512 -> (string)

The SHA512 checksum of the annotation payload.

ChecksumMD5 -> (string)

The MD5 checksum of the annotation payload.

ChecksumXXHASH64 -> (string)

The XXHASH64 checksum of the annotation payload.

ChecksumXXHASH3 -> (string)

The XXHASH3 checksum of the annotation payload.

ChecksumXXHASH128 -> (string)

The XXHASH128 checksum of the annotation payload.

ChecksumType -> (string)

The type of checksum used.

Possible values:

  • COMPOSITE
  • FULL_OBJECT

ServerSideEncryption -> (string)

The server-side encryption algorithm used.

Possible values:

  • AES256
  • aws:fsx
  • aws:kms
  • aws:kms:dsse

RequestCharged -> (string)

If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide .

Note

This functionality is not supported for directory buckets.

Possible values:

  • requester

ReplicationStatus -> (string)

The replication status of the annotation. Possible values include PENDING , COMPLETED , FAILED , and REPLICA .

Possible values:

  • COMPLETE
  • PENDING
  • FAILED
  • REPLICA
  • COMPLETED
© Copyright 2026, Amazon Web Services. Created using Sphinx.