Establecimiento de la configuración de notificación del almacén (PUT configuración-notificaciones)

Descripción

La recuperación de archivos e inventarios de almacén son operaciones asíncronas en Amazon S3 Glacier (S3 Glacier) por lo que, para poder descargar la salida de un trabajo, es necesario iniciarlo primero y esperar hasta que se complete. Puede configurar un almacén para que se publique un mensaje en un tema de Amazon Simple Notification Service (Amazon SNS) cuando estos trabajos se completen. Puede utilizar esta operación para definir la configuración de las notificaciones del almacén. Para obtener más información, consulte Configuración de las notificaciones de almacén en Amazon S3 Glacier.

Para configurar las notificaciones de un almacén, envíe una solicitud PUT al subrecurso notification-configuration del almacén. La configuración de las notificaciones es específica del almacén, por lo que también se conoce como "subrecurso del almacén". La solicitud debe incluir un documento JSON que contenga un tema de Amazon Simple Notification Service (Amazon SNS) y los eventos para los que quiere que S3 Glacier envíe notificaciones al tema.

Puede configurar un almacén para que se publique una notificación de los siguientes eventos:

• ArchiveRetrievalCompleted: este evento se produce cuando se completa un trabajo que se inició para recuperar un archivo (Iniciar trabajo (POSTtrabajos)). El estado del trabajo completado puede ser Succeeded o Failed. La notificación que se envía al tema de SNS es la misma salida que se devuelve de Descripción del trabajo (GET JobID).

• InventoryRetrievalCompleted: este evento se produce cuando se completa un trabajo que se inició para recuperar un inventario (Iniciar trabajo (POSTtrabajos)). El estado del trabajo completado puede ser Succeeded o Failed. La notificación que se envía al tema de SNS es la misma salida que se devuelve de Descripción del trabajo (GET JobID).

Los temas de Amazon SNS deben conceder permiso al almacén para que pueda publicar notificaciones en el tema.

Solicitudes

Para configurar las notificaciones de un almacén, envíe una solicitud PUT al URI del subrecurso notification-configuration del almacén. Debe especificar la configuración en el cuerpo de la solicitud. La configuración incluye el nombre del tema de Amazon SNS y una matriz de eventos que desencadenan las notificaciones en cada tema.

Sintaxis

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

El valor AccountId es el ID de la Cuenta de AWS propietaria del almacén. Puede especificar un ID de Cuenta de AWS o, si lo desea, un solo carácter “-” (guion), en cuyo caso, Amazon S3 Glacier usa el ID de la Cuenta de AWS asociada con las credenciales empleadas para firmar la solicitud. Si usa un ID de cuenta, no incluya ningún guion (“-”) en el ID.

Parámetros de solicitud

Esta operación no usa parámetros de solicitud.

Encabezados de solicitud

Esta operación solo usa encabezados de solicitud que sean comunes para todas las operaciones. Para obtener información acerca de los encabezados de solicitudes comunes, consulte Encabezados de solicitudes comunes.

Cuerpo de la solicitud

El código JSON del cuerpo de la solicitud contiene los siguientes campos.

Eventos

Matriz de uno o varios eventos para los que quiere que S3 Glacier envíe una notificación.

Valores válidos: ArchiveRetrievalCompleted | InventoryRetrievalCompleted

Obligatorio: Sí

Tipo: Array

SNSTopic

ARN del tema de Amazon SNS. Para obtener más información, vaya a Introducción a Amazon SNS en la Guía de introducción de Amazon Simple Notification Service.

Obligatorio: Sí

Tipo: cadena

Respuestas

Como respuesta, Amazon S3 Glacier (S3 Glacier) devuelve 204 No Content si se acepta la configuración de las notificaciones.

Sintaxis

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

Encabezados de respuesta

Esta operación solo usa encabezados de solicitud que sean comunes para todas las operaciones. Para obtener información acerca de los encabezados de solicitudes comunes, consulte Encabezados de solicitudes comunes.

Cuerpo de respuesta

Esta operación no devuelve ningún cuerpo de respuesta.

Errores

Para obtener información acerca de los mensajes de error y las excepciones de Amazon S3 Glacier, consulte Respuestas de error.

Ejemplos

En el ejemplo siguiente, se muestra cómo se configuran las notificaciones de un almacén.

Solicitud de ejemplo

La siguiente solicitud configura las notificaciones de examplevault para que se envíen notificaciones de dos eventos (ArchiveRetrievalCompleted e InventoryRetrievalCompleted) al tema de Amazon SNS arn:aws:sns:us-west-2:012345678901:mytopic.

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"       
}

Respuesta de ejemplo

Si la respuesta es correcta, devuelve 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

Secciones relacionadas

• Obtención de notificaciones del almacén (GET configuración-notificaciones)

• Eliminación de las notificaciones del almacén (DELETE configuración-notificaciones)

• Administración de identidades y accesos para Amazon S3 Glacier

Véase también

Para obtener más información sobre el uso de esta API en uno de los SDK de Amazon específicos de idioma, consulte lo siguiente:

• AWS Command Line Interface