Usar GetObjectRetention com um AWS SDK ou ferramenta de linha de comando

Os exemplos de código a seguir mostram como usar o GetObjectRetention.

Exemplos de ações são trechos de código de programas maiores e devem ser executados em contexto. É possível ver essa ação no contexto no seguinte exemplo de código:

• Bloquear objetos do Amazon S3

.NET

AWS SDK for .NET

nota

Há mais no GitHub. Encontre o exemplo completo e saiba como configurar e executar no Repositório de exemplos de código da AWS.

    /// <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();
        }
    }

• Consulte detalhes da API em GetObjectRetention na Referência de API do AWS SDK for .NET.

CLI

AWS CLI

Como recuperar a configuração de retenção de objetos de um objeto

O exemplo de get-object-retention a seguir recupera a configuração de retenção de objetos do objeto especificado.

aws s3api get-object-retention \
    --bucket my-bucket-with-object-lock \
    --key doc1.rtf

Saída:

{
    "Retention": {
        "Mode": "GOVERNANCE",
        "RetainUntilDate": "2025-01-01T00:00:00.000Z"
    }
}

• Consulte detalhes da API em GetObjectRetention na Referência de comandos da AWS CLI.

Java

SDK para Java 2.x

nota

Há mais no GitHub. Encontre o exemplo completo e saiba como configurar e executar no Repositório de exemplos de código da AWS.

    // 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;
        }
    }

• Consulte detalhes da API em GetObjectRetention na Referência de API do AWS SDK for Java 2.x.

PowerShell

Tools for PowerShell

Exemplo 1: o comando retorna o modo e a data até a qual o objeto ficará retido.

Get-S3ObjectRetention -BucketName 's3buckettesting' -Key 'testfile.txt'

• Para obter detalhes da API, consulte GetObjectRetention na AWS Tools for PowerShell Cmdlet Reference.

Para ver uma lista completa dos Guias do desenvolvedor de SDK da AWS e exemplos de código, consulte Usar este serviço com um AWS SDK. Este tópico também inclui informações sobre como começar e detalhes sobre versões anteriores do SDK.