StartBackupJob

Iniciar um trabalho de backup sob demanda para o recurso especificado.

Sintaxe da Solicitação

PUT /backup-jobs HTTP/1.1
Content-type: application/json

{
   "BackupOptions": { 
      "string" : "string" 
   },
   "BackupVaultName": "string",
   "CompleteWindowMinutes": number,
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "RecoveryPointTags": { 
      "string" : "string" 
   },
   "ResourceArn": "string",
   "StartWindowMinutes": number
}

URIParâmetros de solicitação

A solicitação não usa nenhum URI parâmetro.

Corpo da Solicitação

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

BackupOptions

A opção de backup para um recurso selecionado. Essa opção só está disponível para trabalhos de backup do Windows Volume Shadow Copy Service (VSS).

Valores válidos: defina como "WindowsVSS":"enabled" para ativar a opção de WindowsVSS backup e criar um VSS backup do Windows. Defina "WindowsVSS""disabled" como para criar um backup regular. A opção WindowsVSS é habilitada por padrão.

Tipo:: mapa de string para string

Padrão da chave: ^[a-zA-Z0-9\-\_\.]{1,50}$

Padrão de valor: ^[a-zA-Z0-9\-\_\.]{1,50}$

Obrigatório: Não

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.

Tipo: string

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

Exigido: Sim

CompleteWindowMinutes

Um valor em minutos durante o qual um backup iniciado com êxito deve ser concluído, ou então o AWS Backup cancelará o trabalho. Este valor é opcional. Esse valor começa a contagem regressiva a partir do momento em que o backup foi programado. Isso não adiciona tempo adicional para StartWindowMinutes ou, se o backup foi iniciado depois do programado.

Como StartWindowMinutes, esse parâmetro tem um valor máximo de 100 anos (52.560.000 minutos).

Tipo: longo

Obrigatório: Não

IamRoleArn

Especifica a IAM função ARN usada para criar o ponto de recuperação de destino; por exemplo,arn:aws:iam::123456789012:role/S3Access.

Tipo: string

Obrigatório: Sim

IdempotencyToken

Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas a StartBackupJob. Tentar novamente uma solicitação com êxito com o mesmo token de idempotência resultará em uma mensagem de êxito sem nenhuma ação tomada.

Tipo: string

Obrigatório: Não

Lifecycle

O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup fará a transição e expirará os backups automaticamente de acordo com o ciclo de vida que você definir.

Os backups transferidos para armazenamento "frio" devem ficar armazenados lá por no mínimo 90 dias. Portanto, a configuração de “retenção” deve ser 90 dias a mais do que a configuração de “número de dias para a transição para o armazenamento frio”. A configuração de "número de dias para transferência ao armazenamento 'frio'" não poderá ser alterada depois que um backup for transferido para o armazenamento "frio".

Os tipos de recursos que podem fazer a transição para o armazenamento refrigerado estão listados na tabela Disponibilidade de recursos por recursos. AWS Backup ignora essa expressão para outros tipos de recursos.

Esse parâmetro tem um valor máximo de 100 anos (36.500 dias).

Tipo: objeto Lifecycle

Obrigatório: Não

RecoveryPointTags

As tags a serem atribuídas aos recursos.

Tipo: mapa de string para string

Obrigatório: Não

ResourceArn

Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.

Tipo: string

Obrigatório: Sim

StartWindowMinutes

Um valor em minutos após a programação de um backup antes que um trabalho seja cancelado, se ele não for iniciado com êxito. Esse valor é opcional e o padrão é oito horas. Se esse valor for incluído, deve ser de pelo menos 60 minutos para evitar erros.

Esse parâmetro tem um valor máximo de 100 anos (52.560.000 minutos).

Durante a janela inicial, o status do trabalho de backup permanece no status CREATED até que seja iniciado com êxito ou até que o tempo da janela inicial se esgote. Se, dentro da janela inicial, o horário AWS Backup receber um erro que permita que o trabalho seja repetido, AWS Backup tentará iniciá-lo automaticamente pelo menos a cada 10 minutos até que o backup seja iniciado com sucesso (o status do trabalho mude paraRUNNING) ou até que o status do trabalho mude para EXPIRED (o que se espera que ocorra quando o tempo da janela inicial terminar).

Tipo: longo

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "BackupJobId": "string",
   "CreationDate": number,
   "IsParent": boolean,
   "RecoveryPointArn": "string"
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.

Os dados a seguir são retornados em JSON formato pelo serviço.

BackupJobId

Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.

Tipo: string

CreationDate

A data e a hora em que uma tarefa de backup é criada, no formato Unix e na Hora Universal Coordenada (UTC). O valor de CreationDate tem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.

Tipo: carimbo de data/hora

IsParent

Isso é um valor booliano que indica que se trata de um trabalho de backup pai (composto).

Tipo: booliano

RecoveryPointArn

Observação: esse campo só é retornado para recursos da Amazon EFS e do Advanced DynamoDB.

E ARN que identifica de forma exclusiva um ponto de recuperação; por exemplo,. arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45

Tipo: string

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.

HTTPCódigo de status: 400

InvalidRequestException

Indica que há algo errado com a entrada da solicitação. Por exemplo, um parâmetro é do tipo errado.

HTTPCódigo de status: 400

LimitExceededException

Um limite na solicitação foi excedido; por exemplo, o número máximo de itens permitidos em uma solicitação.

HTTPCódigo de status: 400

MissingParameterValueException

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

HTTPCódigo de status: 400

ResourceNotFoundException

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

HTTPCódigo de status: 400

ServiceUnavailableException

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

HTTPCódigo de status: 500

Consulte também

Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte:

• AWS Command Line Interface

• AWS SDKpara. NET

• AWS SDKpara C++

• AWS SDKpara Go v2

• AWS SDKpara Java V2

• AWS SDKpara JavaScript V3

• AWS SDKpara PHP V3

• AWS SDKpara Python

• AWS SDKpara Ruby V3