

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á.

# ListBackupJobs
<a name="API_ListBackupJobs"></a>

Retorna uma lista dos trabalhos de backup existentes para uma conta autenticada nos últimos 30 dias. Para um período mais longo, considere usar essas [ferramentas de monitoramento](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html).

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

```
GET /backup-jobs/?accountId=ByAccountId&backupVaultName=ByBackupVaultName&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&messageCategory=ByMessageCategory&nextToken=NextToken&parentJobId=ByParentJobId&resourceArn=ByResourceArn&resourceType=ByResourceType&state=ByState HTTP/1.1
```

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

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

 ** [ByAccountId](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByAccountId"></a>
O ID da conta a partir da qual listar os trabalhos. Retorna somente os trabalhos de backup associados ao ID da conta especificado.  
Se usado em uma conta AWS Organizations de gerenciamento, o passe `*` retorna todos os trabalhos em toda a organização.  
Padrão: `^[0-9]{12}$` 

 ** [ByBackupVaultName](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByBackupVaultName"></a>
Retorna somente os trabalhos de backup que serão armazenados no cofre de backup especificado. 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}$` 

 ** [ByCompleteAfter](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCompleteAfter"></a>
Retorna somente os trabalhos de backup concluídos após uma data expressa em formato Unix e Tempo Universal Coordenado (UTC).

 ** [ByCompleteBefore](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCompleteBefore"></a>
Retorna somente os trabalhos de backup concluídos antes de uma data expressa em formato Unix e Tempo Universal Coordenado (UTC).

 ** [ByCreatedAfter](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCreatedAfter"></a>
Retorna somente os trabalhos de backup que foram criados após a data especificada.

 ** [ByCreatedBefore](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByCreatedBefore"></a>
Retorna somente os trabalhos de backup que foram criados antes da data especificada.

 ** [ByMessageCategory](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByMessageCategory"></a>
Esse é um parâmetro opcional que pode ser usado para filtrar trabalhos com um valor MessageCategory que corresponda ao valor inserido.  
Exemplos de strings podem incluir `AccessDenied`, `SUCCESS`, `AGGREGATE_ALL` e `InvalidParameters`.  
Consulte [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html).   
O curinga () retorna a contagem de todas as categorias de mensagens.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos de todas as categorias de mensagens e retorna a soma.

 ** [ByParentJobId](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByParentJobId"></a>
Isso é um filtro para listar os trabalhos filho (aninhados) com base no ID do trabalho pai.

 ** [ByResourceArn](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceArn"></a>
Retorna somente os trabalhos de backup que correspondam ao Nome do recurso da Amazon (ARN) do recurso especificado.

 ** [ByResourceType](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByResourceType"></a>
Retorna somente os trabalhos de backup para os recursos especificados:  
+  `Aurora` para Amazon Aurora
+  `CloudFormation`para AWS CloudFormation 
+  `DocumentDB` para Amazon DocumentDB (compatível com MongoDB)
+  `DynamoDB` para Amazon DynamoDB
+  `EBS` para Amazon Elastic Block Store
+  `EC2` para Amazon Elastic Compute Cloud
+  `EFS` para Amazon Elastic File System
+  `EKS` para o Amazon Elastic Kubernetes Service
+  `FSx`para Amazon FSx
+  `Neptune` para Amazon Neptune
+  `RDS` para Amazon Relational Database Service
+  `Redshift` para Amazon Redshift
+  `S3` para Amazon Simple Storage Service (Amazon S3)
+  `SAP HANA on Amazon EC2` para bancos de dados SAP HANA em instâncias do Amazon Elastic Compute Cloud
+  `Storage Gateway`para AWS Storage Gateway 
+  `Timestream` para Amazon Timestream
+  `VirtualMachine`para máquinas VMware virtuais
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [ByState](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-ByState"></a>
Retorna somente os trabalhos de backup que estejam no estado especificado.  
 `Completed with issues` é um status encontrado somente no console do AWS Backup . Para a API, esse status se refere a trabalhos com um estado de `COMPLETED` e a uma `MessageCategory` com um valor diferente de `SUCCESS`, o que significa que o status é Concluído, mas vem com uma mensagem de status.  
Para obter a contagem de trabalhos `Completed with issues`, execute duas solicitações GET e subtraia o número menor:  
GET /backup-jobs/?state=COMPLETED  
GET /backup-jobs/?messageCategory=SUCCESS&state=COMPLETED  
Valores válidos: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` 

 ** [MaxResults](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-MaxResults"></a>
O número máximo de itens a serem retornados.  
Intervalo válido: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListBackupJobs_RequestSyntax) **   <a name="Backup-ListBackupJobs-request-uri-NextToken"></a>
O próximo item após uma lista parcial dos itens retornados. Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de itens, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.

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

Essa solicitação não tem corpo.

## Sintaxe da resposta
<a name="API_ListBackupJobs_ResponseSyntax"></a>

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

{
   "BackupJobs": [ 
      { 
         "AccountId": "string",
         "BackupJobId": "string",
         "BackupOptions": { 
            "string" : "string" 
         },
         "BackupSizeInBytes": number,
         "BackupType": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "BytesTransferred": number,
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanName": "string",
            "BackupPlanVersion": "string",
            "BackupRuleCron": "string",
            "BackupRuleId": "string",
            "BackupRuleName": "string",
            "BackupRuleTimezone": "string"
         },
         "CreationDate": number,
         "EncryptionKeyArn": "string",
         "ExpectedCompletionDate": number,
         "IamRoleArn": "string",
         "InitiationDate": number,
         "IsEncrypted": boolean,
         "IsParent": boolean,
         "MessageCategory": "string",
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointLifecycle": { 
            "DeleteAfterDays": number,
            "DeleteAfterEvent": "string",
            "MoveToColdStorageAfterDays": number,
            "OptInToArchiveForSupportedResources": boolean
         },
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "StartBy": number,
         "State": "string",
         "StatusMessage": "string",
         "VaultLockState": "string",
         "VaultType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Elementos de resposta
<a name="API_ListBackupJobs_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.

 ** [BackupJobs](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-BackupJobs"></a>
Uma matriz de estruturas contendo metadados sobre os trabalhos de backup retornados no formato JSON.  
Tipo: matriz de objetos [BackupJob](API_BackupJob.md)

 ** [NextToken](#API_ListBackupJobs_ResponseSyntax) **   <a name="Backup-ListBackupJobs-response-NextToken"></a>
O próximo item após uma lista parcial dos itens retornados. Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de itens, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string

## Erros
<a name="API_ListBackupJobs_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

 ** 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_ListBackupJobs_SeeAlso"></a>

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