Gerenciamento de anotações

Você pode adicionar, recuperar e excluir anotações em objetos do Amazon S3 usando os SDKs do AWS Management Console, da AWS CLI ou da AWS. As seções a seguir descrevem como realizar cada operação.

Adição ou atualização de uma anotação

Você pode adicionar uma nova anotação a um objeto ou atualizar uma anotação existente substituindo a carga útil.

Usar o console do S3

Como usar o AWS CLI

Para adicionar ou atualizar uma anotação em um objeto, use o comando put-object-annotation. O parâmetro --annotation-payload aceita um caminho de arquivo.

aws s3api put-object-annotation \
    --bucket amzn-s3-demo-bucket \
    --key myDocument.pdf \
    --annotation-name "ml.sentiment" \
    --annotation-payload /tmp/sentiment.json

Para gravar a anotação somente se o objeto não tiver sido substituído desde a última leitura, especifique o parâmetro --object-if-match com a ETag atual do objeto.

aws s3api put-object-annotation \
    --bucket amzn-s3-demo-bucket \
    --key myDocument.pdf \
    --annotation-name "ml.sentiment" \
    --annotation-payload /tmp/sentiment.json \
    --object-if-match "\"d6eb32081c822ed572b70567826d9d9d\""

Usar SDKs da AWS

O exemplo a seguir usa o SDK da AWS para Python (Boto3) para adicionar uma anotação a um objeto.

import boto3
import json

s3 = boto3.client('s3')

s3.put_object_annotation(
    Bucket='amzn-s3-demo-bucket',
    Key='myDocument.pdf',
    AnnotationName='ml.sentiment',
    AnnotationPayload=json.dumps({
        'score': 0.95,
        'label': 'positive',
        'model': 'sentiment-v3'
    }).encode('utf-8')
)

Recuperação de anotações

Você pode recuperar uma anotação específica ou listar todas as anotações em um objeto.

Usar o console do S3

Como usar o AWS CLI

Para recuperar uma anotação específica, use o comando get-object-annotation.

aws s3api get-object-annotation \
    --bucket amzn-s3-demo-bucket \
    --key myDocument.pdf \
    --annotation-name "ml.sentiment" \
    output.json

Para listar todas as anotações em um objeto, use o comando list-object-annotations.

aws s3api list-object-annotations \
    --bucket amzn-s3-demo-bucket \
    --key myDocument.pdf

Usar SDKs da AWS

O exemplo a seguir usa o SDK da AWS para Python (Boto3) para recuperar e listar anotações.

import boto3
import json

s3 = boto3.client('s3')

# Retrieve a specific annotation
response = s3.get_object_annotation(
    Bucket='amzn-s3-demo-bucket',
    Key='myDocument.pdf',
    AnnotationName='ml.sentiment'
)
content = json.loads(response['AnnotationPayload'].read())

# List all annotations on an object
response = s3.list_object_annotations(
    Bucket='amzn-s3-demo-bucket',
    Key='myDocument.pdf'
)
for annotation in response['Annotations']:
    print(f"{annotation['AnnotationName']} - {annotation['Size']} bytes")

Exclusão de anotações

Você pode excluir uma anotação específica de um objeto. A exclusão de anotações é permanente e não pode ser desfeita.

Usar o console do S3

Como usar o AWS CLI

Para excluir uma anotação específica, use o comando delete-object-annotation.

aws s3api delete-object-annotation \
    --bucket amzn-s3-demo-bucket \
    --key myDocument.pdf \
    --annotation-name "ml.sentiment"

Usar SDKs da AWS

O exemplo a seguir usa o SDK da AWS para Python (Boto3) para excluir uma anotação.

import boto3

s3 = boto3.client('s3')

s3.delete_object_annotation(
    Bucket='amzn-s3-demo-bucket',
    Key='myDocument.pdf',
    AnnotationName='ml.sentiment'
)