PutBackupVaultNotifications - AWS Backup
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

PutBackupVaultNotifications

Ativa as notificações em um cofre de backup para o tópico e os eventos especificados.

Sintaxe da Solicitação

PUT /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
Content-type: application/json

{
   "BackupVaultEvents": [ "string" ],
   "SNSTopicArn": "string"
}

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

backupVaultName

O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.

Padrão: ^[a-zA-Z0-9\-\_]{2,50}$

Obrigatório: Sim

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

BackupVaultEvents

Uma matriz de eventos que indicam o status de trabalhos para recursos de backup para o cofre de backup.

Para casos de uso comuns e exemplos de código, consulte Usar o Amazon SNS para rastrear eventos do AWS Backup.

Os seguintes eventos são compatíveis:

  • BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED

  • COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED

  • RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED

  • S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

nota

A lista abaixo mostra os itens que são eventos obsoletos e não estão mais em uso (para referência). Eventos obsoletos não retornarão status ou notificações. Consulte a lista acima para ver os eventos compatíveis.

Tipo: Matriz de strings

Valores Válidos: BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED | BACKUP_JOB_SUCCESSFUL | BACKUP_JOB_FAILED | BACKUP_JOB_EXPIRED | RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RESTORE_JOB_SUCCESSFUL | RESTORE_JOB_FAILED | COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED | RECOVERY_POINT_MODIFIED | BACKUP_PLAN_CREATED | BACKUP_PLAN_MODIFIED | S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED

Obrigatório: Sim

SNSTopicArn

O Nome do recurso da Amazon (ARN) que especifica o tópico dos eventos de um cofre de backup. Por exemplo, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Tipo: string

Obrigatório: Sim

Sintaxe da Resposta

HTTP/1.1 200

Elementos de Resposta

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

Erros

Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.

InvalidParameterValueException

Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.

Código de Status HTTP: 400

MissingParameterValueException

Indica que um parâmetro necessário está ausente.

Código de Status HTTP: 400

ResourceNotFoundException

Um recurso necessário para a ação não existe.

Código de Status HTTP: 400

ServiceUnavailableException

Houve falha na solicitação devido a um erro temporário do servidor.

Código de Status HTTP: 500

Consulte também

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