

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# StartBackupJob
<a name="API_StartBackupJob"></a>

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

## Sintaxe da Solicitação
<a name="API_StartBackupJob_RequestSyntax"></a>

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

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

## Parâmetros da solicitação de URI
<a name="API_StartBackupJob_RequestParameters"></a>

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

## Corpo da Solicitação
<a name="API_StartBackupJob_RequestBody"></a>

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

 ** [BackupOptions](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-BackupOptions"></a>
A opção de backup para um recurso selecionado. Essa opção só está disponível para trabalhos de backup do Serviço de Cópias de Sombra de Volume (VSS) do Windows.  
Valores válidos: defina como `"WindowsVSS":"enabled"` para habilitar a opção de backup do `WindowsVSS` e criar um backup do VSS 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](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-BackupVaultName"></a>
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: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [CompleteWindowMinutes](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-CompleteWindowMinutes"></a>
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](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-IamRoleArn"></a>
Especifica o ARN do perfil do IAM usado para criar o ponto de recuperação de destino. Por exemplo, `arn:aws:iam::123456789012:role/S3Access`.  
Tipo: String  
Obrigatório: Sim

 ** [IdempotencyToken](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-IdempotencyToken"></a>
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

 ** [Index](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-Index"></a>
Inclua esse parâmetro para permitir a criação de índices se o trabalho de backup tiver um tipo de recurso compatível com índices de backup.  
Os tipos de recursos compatíveis com índices de backup incluem:  
+  `EBS` para Amazon Elastic Block Store
+  `S3` para Amazon Simple Storage Service (Amazon S3)
O índice pode ter 1 de 2 valores possíveis, `ENABLED` ou `DISABLED`.  
Para criar um índice de backup para um ponto de recuperação `ACTIVE` qualificado que ainda não tenha um índice de backup, defina o valor como `ENABLED`.  
Para excluir um índice de backup, defina o valor como `DISABLED`.  
Tipo: string  
Valores válidos: `ENABLED | DISABLED`   
Obrigatório: não

 ** [Lifecycle](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-Lifecycle"></a>
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 o armazenamento refrigerado devem ser armazenados em armazenamento refrigerado por no mínimo 90 dias. Portanto, a configuração de “retenção” deve ser noventa 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 a frio” não pode ser alterada depois que um backup é transferido para o armazenamento a 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](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource). 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](API_Lifecycle.md)  
Obrigatório: não

 ** [LogicallyAirGappedBackupVaultArn](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-LogicallyAirGappedBackupVaultArn"></a>
O ARN de um cofre logicamente isolado. O ARN deve estar na mesma conta e região. Se fornecidos, os recursos compatíveis totalmente gerenciados fazem backup diretamente para um cofre com espaço aéreo lógico, enquanto outros recursos compatíveis criam um instantâneo temporário (faturável) no cofre de backup e, em seguida, o copiam para um cofre com lacuna lógica. Recursos incompatíveis só fazem backup no cofre de backup especificado.  
Tipo: string  
Obrigatório: não

 ** [RecoveryPointTags](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-RecoveryPointTags"></a>
As tags a serem atribuídas ao recurso.  
Tipo: mapa de string para string  
Obrigatório: não

 ** [ResourceArn](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-ResourceArn"></a>
Um Nome do 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](#API_StartBackupJob_RequestSyntax) **   <a name="Backup-StartBackupJob-request-StartWindowMinutes"></a>
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 para`RUNNING`) 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
<a name="API_StartBackupJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

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

## Elementos de resposta
<a name="API_StartBackupJob_ResponseElements"></a>

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

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

 ** [BackupJobId](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-BackupJobId"></a>
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.  
Tipo: string

 ** [CreationDate](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-CreationDate"></a>
A data e a hora em que um trabalho de backup foi criado, em formato Unix e Tempo Universal Coordenado (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: Timestamp

 ** [IsParent](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-IsParent"></a>
Isso é um valor booliano que indica que se trata de um trabalho de backup pai (composto).  
Tipo: booliano

 ** [RecoveryPointArn](#API_StartBackupJob_ResponseSyntax) **   <a name="Backup-StartBackupJob-response-RecoveryPointArn"></a>
 *Observação: esse campo só é retornado para recursos do Amazon EFS e do Advanced DynamoDB.*   
Um 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
<a name="API_StartBackupJob_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).

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

Código de status HTTP: 400

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

Código de status HTTP: 400

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

Código de status HTTP: 400

 ** MissingParameterValueException **   
Indica que um parâmetro necessário está ausente.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** ResourceNotFoundException **   
Um recurso necessário para a ação não existe.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

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

Código de status HTTP: 500

## Consulte também
<a name="API_StartBackupJob_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartBackupJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartBackupJob) 