Skip to content

GetObjectAnnotationOutput

Source code in docs_src/capo_s3/types/get_object_annotation_output.py
class GetObjectAnnotationOutput(TypedDict, closed=True):
    annotation_payload: "capo_s3.types.streaming_blob.StreamingBlob"
    """<p>The annotation payload.</p>"""
    object_version_id: NotRequired["capo_s3.types.object_version_id.ObjectVersionId"]
    """<p>The version ID of the object that the annotation is attached to.</p>"""
    last_modified: NotRequired["capo_s3.types.last_modified.LastModified"]
    """<p>The date and time the annotation was last modified.</p>"""
    content_length: NotRequired["capo_s3.types.content_length.ContentLength"]
    """<p>The size of the annotation payload, in bytes.</p>"""
    e_tag: NotRequired["capo_s3.types.e_tag.ETag"]
    """<p>The entity tag of the annotation.</p>"""
    checksum_crc32: NotRequired["capo_s3.types.checksum_crc32.ChecksumCRC32"]
    """<p>The CRC32 checksum of the annotation payload.</p>"""
    checksum_crc32_c: NotRequired["capo_s3.types.checksum_crc32_c.ChecksumCRC32C"]
    """<p>The CRC32C checksum of the annotation payload.</p>"""
    checksum_crc64_nvme: NotRequired[
        "capo_s3.types.checksum_crc64_nvme.ChecksumCRC64NVME"
    ]
    """<p>The CRC64NVME checksum of the annotation payload.</p>"""
    checksum_sha1: NotRequired["capo_s3.types.checksum_sha1.ChecksumSHA1"]
    """<p>The SHA1 checksum of the annotation payload.</p>"""
    checksum_sha256: NotRequired["capo_s3.types.checksum_sha256.ChecksumSHA256"]
    """<p>The SHA256 checksum of the annotation payload.</p>"""
    checksum_sha512: NotRequired["capo_s3.types.checksum_sha512.ChecksumSHA512"]
    """<p>The SHA512 checksum of the annotation payload.</p>"""
    checksum_md5: NotRequired["capo_s3.types.checksum_md5.ChecksumMD5"]
    """<p>The MD5 checksum of the annotation payload.</p>"""
    checksum_xxhash64: NotRequired["capo_s3.types.checksum_xxhash64.ChecksumXXHASH64"]
    """<p>The XXHASH64 checksum of the annotation payload.</p>"""
    checksum_xxhash3: NotRequired["capo_s3.types.checksum_xxhash3.ChecksumXXHASH3"]
    """<p>The XXHASH3 checksum of the annotation payload.</p>"""
    checksum_xxhash128: NotRequired[
        "capo_s3.types.checksum_xxhash128.ChecksumXXHASH128"
    ]
    """<p>The XXHASH128 checksum of the annotation payload.</p>"""
    checksum_type: NotRequired["capo_s3.types.checksum_type.ChecksumType"]
    """<p>The type of checksum used.</p>"""
    server_side_encryption: NotRequired[
        "capo_s3.types.server_side_encryption.ServerSideEncryption"
    ]
    """<p>The server-side encryption algorithm used.</p>"""
    request_charged: NotRequired["capo_s3.types.request_charged.RequestCharged"]
    replication_status: NotRequired[
        "capo_s3.types.replication_status.ReplicationStatus"
    ]
    """<p>The replication status of the annotation. Possible values include <code>PENDING</code>, <code>COMPLETED</code>, <code>FAILED</code>, and <code>REPLICA</code>.</p>"""

annotation_payload instance-attribute

annotation_payload: StreamingBlob

The annotation payload.

checksum_crc32 instance-attribute

checksum_crc32: NotRequired[ChecksumCRC32]

The CRC32 checksum of the annotation payload.

checksum_crc32_c instance-attribute

checksum_crc32_c: NotRequired[ChecksumCRC32C]

The CRC32C checksum of the annotation payload.

checksum_crc64_nvme instance-attribute

checksum_crc64_nvme: NotRequired[ChecksumCRC64NVME]

The CRC64NVME checksum of the annotation payload.

checksum_md5 instance-attribute

checksum_md5: NotRequired[ChecksumMD5]

The MD5 checksum of the annotation payload.

checksum_sha1 instance-attribute

checksum_sha1: NotRequired[ChecksumSHA1]

The SHA1 checksum of the annotation payload.

checksum_sha256 instance-attribute

checksum_sha256: NotRequired[ChecksumSHA256]

The SHA256 checksum of the annotation payload.

checksum_sha512 instance-attribute

checksum_sha512: NotRequired[ChecksumSHA512]

The SHA512 checksum of the annotation payload.

checksum_type instance-attribute

checksum_type: NotRequired[ChecksumType]

The type of checksum used.

checksum_xxhash128 instance-attribute

checksum_xxhash128: NotRequired[ChecksumXXHASH128]

The XXHASH128 checksum of the annotation payload.

checksum_xxhash3 instance-attribute

checksum_xxhash3: NotRequired[ChecksumXXHASH3]

The XXHASH3 checksum of the annotation payload.

checksum_xxhash64 instance-attribute

checksum_xxhash64: NotRequired[ChecksumXXHASH64]

The XXHASH64 checksum of the annotation payload.

content_length instance-attribute

content_length: NotRequired[ContentLength]

The size of the annotation payload, in bytes.

e_tag instance-attribute

e_tag: NotRequired[ETag]

The entity tag of the annotation.

last_modified instance-attribute

last_modified: NotRequired[LastModified]

The date and time the annotation was last modified.

object_version_id instance-attribute

object_version_id: NotRequired[ObjectVersionId]

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

replication_status instance-attribute

replication_status: NotRequired[ReplicationStatus]

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

request_charged instance-attribute

request_charged: NotRequired[RequestCharged]

server_side_encryption instance-attribute

server_side_encryption: NotRequired[ServerSideEncryption]

The server-side encryption algorithm used.