Definir configuração de notificação de cofre (PUT notification-configuration)

Descrição

Recuperar um arquivo e um inventário de cofre são operações assíncronas no Amazon S3 Glacier (S3 Glacier) para as quais você deve primeiro iniciar um trabalho e aguardar que ele seja concluído para poder fazer download da saída do trabalho. Você pode configurar um cofre para publicar uma mensagem em um tópico do Amazon Simple Notification Service (Amazon SNS) quando esses trabalhos forem concluídos. Você pode usar essa operação para definir a configuração de notificação no cofre. Para obter mais informações, consulte Configurar notificações de cofre no Amazon S3 Glacier.

Para configurar notificações de cofre, envie uma solicitação PUT para o sub-recurso notification-configuration do cofre. Uma configuração de notificação é específica de um cofre; por isso, ela também é conhecida como um sub-recurso de cofre. A solicitação deve incluir um documento JSON que forneça um tópico do Amazon Simple Notification Service (Amazon SNS) e os eventos para os quais você deseja que o S3 Glacier envie notificações ao tópico.

Você pode configurar um cofre a fim de publicar uma notificação para os seguintes eventos de cofre:

• ArchiveRetrievalCompleted— Este evento ocorre quando um trabalho que tenha sido iniciado para uma recuperação de arquivo é concluído (Initiate Job (trabalhos POST)). O status do trabalho concluído pode ser Succeeded ou Failed. A notificação enviada para o tópico do SNS é a mesma saída retornada de Trabalho de descrição (GET JobID).

• InventoryRetrievalCompleted— Este evento ocorre quando um trabalho que tenha sido iniciado para uma recuperação de inventário é concluído (Initiate Job (trabalhos POST)). O status do trabalho concluído pode ser Succeeded ou Failed. A notificação enviada para o tópico do SNS é a mesma saída retornada de Trabalho de descrição (GET JobID).

Os tópicos do Amazon SNS devem conceder permissão ao cofre para poder publicar notificações no tópico.

Solicitações

Para definir a configuração de notificação no cofre, envie uma solicitação PUT para o URI do sub-recurso notification-configuration do cofre. Você especifica a configuração no corpo da solicitação. A configuração inclui o nome do tópico do Amazon SNS e um conjunto de eventos que disparam uma notificação para cada tópico.

Sintaxe

PUT /AccountId/vaults/VaultName/notification-configuration HTTP/1.1
Host: glacier.Region.amazonaws.com
Date: Date
Authorization: SignatureValue
x-amz-glacier-version: 2012-06-01

{
   "SNSTopic": String,
   "Events":[String, ...] 
}

nota

O valor de AccountId é o ID de Conta da AWS da conta proprietária do cofre. Você pode especificar um ID de Conta da AWS ou, de forma opcional, um '-' (hífen) único; nesse caso, o Amazon S3 Glacier usa o ID de Conta da AWS associado às credenciais usadas para assinar a solicitação. Se você usar um ID de conta, não inclua nenhum hífen ('-') no ID.

Parâmetros de solicitação

Essa operação não usa parâmetros de solicitação.

Cabeçalhos de solicitação

Essa operação usa somente os cabeçalhos de solicitação que são comuns a todas as operações. Para informações sobre os cabeçalhos de solicitação comuns, consulte Cabeçalhos de solicitação comuns.

Corpo da solicitação

O JSON no corpo da solicitação contém os campos a seguir.

Eventos

Uma matriz de um ou mais eventos para os quais você deseja que o S3 Glacier envie uma notificação.

Valores válidos: ArchiveRetrievalCompleted | InventoryRetrievalCompleted

Obrigatório: sim

Tipo: matriz

SNSTopic

O ARN do tópico do Amazon SNS. Para obter mais informações, vá para Conceitos básicos do Amazon SNS no Guia de conceitos básicos do Amazon Simple Notification Service.

Obrigatório: sim

Tipo: string

Respostas

Em resposta, o Amazon S3 Glacier (S3 Glacier) retornará 204 No Content, se a configuração de notificação for aceita.

Sintaxe

HTTP/1.1 204 No Content
x-amzn-RequestId: x-amzn-RequestId
Date: Date

Cabeçalhos de resposta

Essa operação usa somente os cabeçalhos de solicitação que são comuns a todas as operações. Para informações sobre os cabeçalhos de solicitação comuns, consulte Cabeçalhos de solicitação comuns.

Corpo da resposta

Essa operação não retorna um corpo de resposta.

Erros

Para obter informações sobre exceções e mensagens de erro do Amazon S3 Glacier, consulte Respostas de erro.

Exemplos

O exemplo a seguir demonstra como configurar uma notificação de cofre.

Exemplo de solicitação

A solicitação a seguir define a configuração de notificação examplevault, de maneira que notificações para dois eventos (ArchiveRetrievalCompleted e InventoryRetrievalCompleted) são enviadas para o tópico arn:aws:sns:us-west-2:012345678901:mytopic do Amazon SNS.

PUT /-/vaults/examplevault/notification-policy HTTP/1.1
Host: glacier.us-west-2.amazonaws.com
x-amz-Date: 20170210T120000Z
x-amz-glacier-version: 2012-06-01
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/glacier/aws4_request,SignedHeaders=host;x-amz-date;x-amz-glacier-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2

{ 
   "Events": ["ArchiveRetrievalCompleted", "InventoryRetrievalCompleted"],
   "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic"       
}

Exemplo de resposta

Uma resposta bem-sucedida retorna um 204 No Content.

HTTP/1.1 204 No Content
x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
Date: Wed, 10 Feb 2017 12:00:00 GMT

Seções relacionadas

• Get Vault Notifications (GET notification-configuration)

• Delete Vault Notifications (DELETE notification-configuration)

• Gerenciamento de identidade e acesso para o Amazon S3 Glacier

Consulte também

Para obter mais informações sobre como usar essa API em um dos Amazon SDKs específicos de linguagem, consulte o seguinte:

• AWS Command Line Interface