

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

# AWS Backup
<a name="API_Operations_AWS_Backup"></a>

As seguintes ações são apoiadas por AWS Backup:
+  [AssociateBackupVaultMpaApprovalTeam](API_AssociateBackupVaultMpaApprovalTeam.md) 
+  [CancelLegalHold](API_CancelLegalHold.md) 
+  [CreateBackupPlan](API_CreateBackupPlan.md) 
+  [CreateBackupSelection](API_CreateBackupSelection.md) 
+  [CreateBackupVault](API_CreateBackupVault.md) 
+  [CreateFramework](API_CreateFramework.md) 
+  [CreateLegalHold](API_CreateLegalHold.md) 
+  [CreateLogicallyAirGappedBackupVault](API_CreateLogicallyAirGappedBackupVault.md) 
+  [CreateReportPlan](API_CreateReportPlan.md) 
+  [CreateRestoreAccessBackupVault](API_CreateRestoreAccessBackupVault.md) 
+  [CreateRestoreTestingPlan](API_CreateRestoreTestingPlan.md) 
+  [CreateRestoreTestingSelection](API_CreateRestoreTestingSelection.md) 
+  [CreateTieringConfiguration](API_CreateTieringConfiguration.md) 
+  [DeleteBackupPlan](API_DeleteBackupPlan.md) 
+  [DeleteBackupSelection](API_DeleteBackupSelection.md) 
+  [DeleteBackupVault](API_DeleteBackupVault.md) 
+  [DeleteBackupVaultAccessPolicy](API_DeleteBackupVaultAccessPolicy.md) 
+  [DeleteBackupVaultLockConfiguration](API_DeleteBackupVaultLockConfiguration.md) 
+  [DeleteBackupVaultNotifications](API_DeleteBackupVaultNotifications.md) 
+  [DeleteFramework](API_DeleteFramework.md) 
+  [DeleteRecoveryPoint](API_DeleteRecoveryPoint.md) 
+  [DeleteReportPlan](API_DeleteReportPlan.md) 
+  [DeleteRestoreTestingPlan](API_DeleteRestoreTestingPlan.md) 
+  [DeleteRestoreTestingSelection](API_DeleteRestoreTestingSelection.md) 
+  [DeleteTieringConfiguration](API_DeleteTieringConfiguration.md) 
+  [DescribeBackupJob](API_DescribeBackupJob.md) 
+  [DescribeBackupVault](API_DescribeBackupVault.md) 
+  [DescribeCopyJob](API_DescribeCopyJob.md) 
+  [DescribeFramework](API_DescribeFramework.md) 
+  [DescribeGlobalSettings](API_DescribeGlobalSettings.md) 
+  [DescribeProtectedResource](API_DescribeProtectedResource.md) 
+  [DescribeRecoveryPoint](API_DescribeRecoveryPoint.md) 
+  [DescribeRegionSettings](API_DescribeRegionSettings.md) 
+  [DescribeReportJob](API_DescribeReportJob.md) 
+  [DescribeReportPlan](API_DescribeReportPlan.md) 
+  [DescribeRestoreJob](API_DescribeRestoreJob.md) 
+  [DescribeScanJob](API_DescribeScanJob.md) 
+  [DisassociateBackupVaultMpaApprovalTeam](API_DisassociateBackupVaultMpaApprovalTeam.md) 
+  [DisassociateRecoveryPoint](API_DisassociateRecoveryPoint.md) 
+  [DisassociateRecoveryPointFromParent](API_DisassociateRecoveryPointFromParent.md) 
+  [ExportBackupPlanTemplate](API_ExportBackupPlanTemplate.md) 
+  [GetBackupPlan](API_GetBackupPlan.md) 
+  [GetBackupPlanFromJSON](API_GetBackupPlanFromJSON.md) 
+  [GetBackupPlanFromTemplate](API_GetBackupPlanFromTemplate.md) 
+  [GetBackupSelection](API_GetBackupSelection.md) 
+  [GetBackupVaultAccessPolicy](API_GetBackupVaultAccessPolicy.md) 
+  [GetBackupVaultNotifications](API_GetBackupVaultNotifications.md) 
+  [GetLegalHold](API_GetLegalHold.md) 
+  [GetRecoveryPointIndexDetails](API_GetRecoveryPointIndexDetails.md) 
+  [GetRecoveryPointRestoreMetadata](API_GetRecoveryPointRestoreMetadata.md) 
+  [GetRestoreJobMetadata](API_GetRestoreJobMetadata.md) 
+  [GetRestoreTestingInferredMetadata](API_GetRestoreTestingInferredMetadata.md) 
+  [GetRestoreTestingPlan](API_GetRestoreTestingPlan.md) 
+  [GetRestoreTestingSelection](API_GetRestoreTestingSelection.md) 
+  [GetSupportedResourceTypes](API_GetSupportedResourceTypes.md) 
+  [GetTieringConfiguration](API_GetTieringConfiguration.md) 
+  [ListBackupJobs](API_ListBackupJobs.md) 
+  [ListBackupJobSummaries](API_ListBackupJobSummaries.md) 
+  [ListBackupPlans](API_ListBackupPlans.md) 
+  [ListBackupPlanTemplates](API_ListBackupPlanTemplates.md) 
+  [ListBackupPlanVersions](API_ListBackupPlanVersions.md) 
+  [ListBackupSelections](API_ListBackupSelections.md) 
+  [ListBackupVaults](API_ListBackupVaults.md) 
+  [ListCopyJobs](API_ListCopyJobs.md) 
+  [ListCopyJobSummaries](API_ListCopyJobSummaries.md) 
+  [ListFrameworks](API_ListFrameworks.md) 
+  [ListIndexedRecoveryPoints](API_ListIndexedRecoveryPoints.md) 
+  [ListLegalHolds](API_ListLegalHolds.md) 
+  [ListProtectedResources](API_ListProtectedResources.md) 
+  [ListProtectedResourcesByBackupVault](API_ListProtectedResourcesByBackupVault.md) 
+  [ListRecoveryPointsByBackupVault](API_ListRecoveryPointsByBackupVault.md) 
+  [ListRecoveryPointsByLegalHold](API_ListRecoveryPointsByLegalHold.md) 
+  [ListRecoveryPointsByResource](API_ListRecoveryPointsByResource.md) 
+  [ListReportJobs](API_ListReportJobs.md) 
+  [ListReportPlans](API_ListReportPlans.md) 
+  [ListRestoreAccessBackupVaults](API_ListRestoreAccessBackupVaults.md) 
+  [ListRestoreJobs](API_ListRestoreJobs.md) 
+  [ListRestoreJobsByProtectedResource](API_ListRestoreJobsByProtectedResource.md) 
+  [ListRestoreJobSummaries](API_ListRestoreJobSummaries.md) 
+  [ListRestoreTestingPlans](API_ListRestoreTestingPlans.md) 
+  [ListRestoreTestingSelections](API_ListRestoreTestingSelections.md) 
+  [ListScanJobs](API_ListScanJobs.md) 
+  [ListScanJobSummaries](API_ListScanJobSummaries.md) 
+  [ListTags](API_ListTags.md) 
+  [ListTieringConfigurations](API_ListTieringConfigurations.md) 
+  [PutBackupVaultAccessPolicy](API_PutBackupVaultAccessPolicy.md) 
+  [PutBackupVaultLockConfiguration](API_PutBackupVaultLockConfiguration.md) 
+  [PutBackupVaultNotifications](API_PutBackupVaultNotifications.md) 
+  [PutRestoreValidationResult](API_PutRestoreValidationResult.md) 
+  [RevokeRestoreAccessBackupVault](API_RevokeRestoreAccessBackupVault.md) 
+  [StartBackupJob](API_StartBackupJob.md) 
+  [StartCopyJob](API_StartCopyJob.md) 
+  [StartReportJob](API_StartReportJob.md) 
+  [StartRestoreJob](API_StartRestoreJob.md) 
+  [StartScanJob](API_StartScanJob.md) 
+  [StopBackupJob](API_StopBackupJob.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateBackupPlan](API_UpdateBackupPlan.md) 
+  [UpdateFramework](API_UpdateFramework.md) 
+  [UpdateGlobalSettings](API_UpdateGlobalSettings.md) 
+  [UpdateRecoveryPointIndexSettings](API_UpdateRecoveryPointIndexSettings.md) 
+  [UpdateRecoveryPointLifecycle](API_UpdateRecoveryPointLifecycle.md) 
+  [UpdateRegionSettings](API_UpdateRegionSettings.md) 
+  [UpdateReportPlan](API_UpdateReportPlan.md) 
+  [UpdateRestoreTestingPlan](API_UpdateRestoreTestingPlan.md) 
+  [UpdateRestoreTestingSelection](API_UpdateRestoreTestingSelection.md) 
+  [UpdateTieringConfiguration](API_UpdateTieringConfiguration.md) 

# AssociateBackupVaultMpaApprovalTeam
<a name="API_AssociateBackupVaultMpaApprovalTeam"></a>

Associa uma equipe de aprovação MPA a um cofre de backup.

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

```
PUT /backup-vaults/backupVaultName/mpaApprovalTeam HTTP/1.1
Content-type: application/json

{
   "MpaApprovalTeamArn": "string",
   "RequesterComment": "string"
}
```

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

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

 ** [backupVaultName](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-AssociateBackupVaultMpaApprovalTeam-request-uri-BackupVaultName"></a>
O nome do cofre de backup que deve ser associado à equipe de aprovação MPA.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

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

 ** [MpaApprovalTeamArn](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-AssociateBackupVaultMpaApprovalTeam-request-MpaApprovalTeamArn"></a>
O nome do recurso da Amazon (ARN) da equipe de aprovação MPA que deve ser associada ao cofre de backup.  
Tipo: String  
Obrigatório: Sim

 ** [RequesterComment](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-AssociateBackupVaultMpaApprovalTeam-request-RequesterComment"></a>
Um comentário fornecido pelo solicitante explicando a solicitação de associação.  
Tipo: string  
Obrigatório: não

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

```
HTTP/1.1 204
```

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

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

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

 ** 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_AssociateBackupVaultMpaApprovalTeam_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/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/AssociateBackupVaultMpaApprovalTeam) 

# CancelLegalHold
<a name="API_CancelLegalHold"></a>

Remove a retenção legal especificada em um ponto de recuperação. Essa ação só pode ser executada por um usuário com permissões suficientes.

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

```
DELETE /legal-holds/legalHoldId?cancelDescription=CancelDescription&retainRecordInDays=RetainRecordInDays HTTP/1.1
```

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

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

 ** [CancelDescription](#API_CancelLegalHold_RequestSyntax) **   <a name="Backup-CancelLegalHold-request-uri-CancelDescription"></a>
Uma string que descreve o motivo da remoção da retenção legal.  
Obrigatório: Sim

 ** [legalHoldId](#API_CancelLegalHold_RequestSyntax) **   <a name="Backup-CancelLegalHold-request-uri-LegalHoldId"></a>
O ID da retenção legal.  
Obrigatório: Sim

 ** [RetainRecordInDays](#API_CancelLegalHold_RequestSyntax) **   <a name="Backup-CancelLegalHold-request-uri-RetainRecordInDays"></a>
O valor inteiro, em dias, após o qual deve ser removida a retenção legal.

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 201
```

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

Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 201 com um corpo HTTP vazio.

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

 ** InvalidResourceStateException **   
 AWS Backup já está executando uma ação nesse ponto de recuperação. Ele não pode realizar a ação solicitada até que a primeira ação seja concluída. Tente novamente mais tarde.    
 ** 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_CancelLegalHold_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/CancelLegalHold) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CancelLegalHold) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CancelLegalHold) 

# CreateBackupPlan
<a name="API_CreateBackupPlan"></a>

Cria um plano de backup usando o nome do plano de backup e as regras de backup. Um plano de backup é um documento que contém informações AWS Backup usadas para agendar tarefas que criam pontos de recuperação para recursos.

Se chamar `CreateBackupPlan` com um plano existente, você receberá uma exceção `AlreadyExistsException`.

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

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

{
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   },
   "BackupPlanTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string"
}
```

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

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

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

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

 ** [BackupPlan](#API_CreateBackupPlan_RequestSyntax) **   <a name="Backup-CreateBackupPlan-request-BackupPlan"></a>
O corpo de um plano de backup. Inclui um `BackupPlanName` e um ou mais conjuntos de `Rules`.  
Tipo: objeto [BackupPlanInput](API_BackupPlanInput.md)  
Obrigatório: Sim

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

 ** [CreatorRequestId](#API_CreateBackupPlan_RequestSyntax) **   <a name="Backup-CreateBackupPlan-request-CreatorRequestId"></a>
Identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes. Se a solicitação incluir um `CreatorRequestId` que corresponda a um plano de backup existente, esse plano será retornado. Esse parâmetro é opcional.  
Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-\$1” .  
Tipo: string  
Obrigatório: não

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

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

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "VersionId": "string"
}
```

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

 ** [AdvancedBackupSettings](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-AdvancedBackupSettings"></a>
As configurações de um tipo de recurso. Essa opção só está disponível para trabalhos de backup do Serviço de Cópias de Sombra de Volume (VSS) do Windows.  
Tipo: matriz de objetos [AdvancedBackupSetting](API_AdvancedBackupSetting.md)

 ** [BackupPlanArn](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-BackupPlanArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um plano de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.  
Tipo: string

 ** [BackupPlanId](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-BackupPlanId"></a>
O ID do plano de backup.  
Tipo: string

 ** [CreationDate](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-CreationDate"></a>
A data e hora em que o plano de backup foi criado, em formato de hora 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

 ** [VersionId](#API_CreateBackupPlan_ResponseSyntax) **   <a name="Backup-CreateBackupPlan-response-VersionId"></a>
Strings Unicode exclusivas geradas aleatoriamente, codificadas em UTF-8 que têm no máximo 1.024 bytes. Eles não podem ser editados.  
Tipo: string

## Erros
<a name="API_CreateBackupPlan_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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

 ** 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_CreateBackupPlan_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/CreateBackupPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateBackupPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateBackupPlan) 

# CreateBackupSelection
<a name="API_CreateBackupSelection"></a>

Cria um documento JSON que especifica um conjunto de recursos a serem atribuídos a um plano de backup. Para ver exemplos, consulte [Atribuir recursos de forma programática](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json). 

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

```
PUT /backup/plans/backupPlanId/selections/ HTTP/1.1
Content-type: application/json

{
   "BackupSelection": { 
      "Conditions": { 
         "StringEquals": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringLike": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringNotLike": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ]
      },
      "IamRoleArn": "string",
      "ListOfTags": [ 
         { 
            "ConditionKey": "string",
            "ConditionType": "string",
            "ConditionValue": "string"
         }
      ],
      "NotResources": [ "string" ],
      "Resources": [ "string" ],
      "SelectionName": "string"
   },
   "CreatorRequestId": "string"
}
```

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

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

 ** [backupPlanId](#API_CreateBackupSelection_RequestSyntax) **   <a name="Backup-CreateBackupSelection-request-uri-BackupPlanId"></a>
O ID do plano de backup.  
Obrigatório: Sim

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

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

 ** [BackupSelection](#API_CreateBackupSelection_RequestSyntax) **   <a name="Backup-CreateBackupSelection-request-BackupSelection"></a>
O corpo de uma solicitação para atribuir um conjunto de recursos a um plano de backup.  
Tipo: objeto [BackupSelection](API_BackupSelection.md)  
Obrigatório: Sim

 ** [CreatorRequestId](#API_CreateBackupSelection_RequestSyntax) **   <a name="Backup-CreateBackupSelection-request-CreatorRequestId"></a>
Uma string exclusiva que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes. Esse parâmetro é opcional.  
Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-\$1” .  
Tipo: string  
Obrigatório: não

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

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

{
   "BackupPlanId": "string",
   "CreationDate": number,
   "SelectionId": "string"
}
```

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

 ** [BackupPlanId](#API_CreateBackupSelection_ResponseSyntax) **   <a name="Backup-CreateBackupSelection-response-BackupPlanId"></a>
O ID do plano de backup.  
Tipo: string

 ** [CreationDate](#API_CreateBackupSelection_ResponseSyntax) **   <a name="Backup-CreateBackupSelection-response-CreationDate"></a>
A data e hora em que uma seleção de backup é criada, 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

 ** [SelectionId](#API_CreateBackupSelection_ResponseSyntax) **   <a name="Backup-CreateBackupSelection-response-SelectionId"></a>
Identifica de forma exclusiva o corpo de uma solicitação para atribuir um conjunto de recursos a um plano de backup.  
Tipo: string

## Erros
<a name="API_CreateBackupSelection_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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

 ** 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_CreateBackupSelection_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/CreateBackupSelection) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateBackupSelection) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateBackupSelection) 

# CreateBackupVault
<a name="API_CreateBackupVault"></a>

Cria um contêiner lógico onde os backups são armazenados. Uma solicitação `CreateBackupVault` inclui um nome, opcionalmente uma ou mais tags de recurso, uma chave de criptografia e um ID de solicitação.

**nota**  
Não inclua dados confidenciais, como números de passaporte, no nome de um cofre de backup.

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

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

{
   "BackupVaultTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string",
   "EncryptionKeyArn": "string"
}
```

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

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

 ** [backupVaultName](#API_CreateBackupVault_RequestSyntax) **   <a name="Backup-CreateBackupVault-request-uri-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. Eles consistem em letras, números e hifens.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

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

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

 ** [CreatorRequestId](#API_CreateBackupVault_RequestSyntax) **   <a name="Backup-CreateBackupVault-request-CreatorRequestId"></a>
Uma string exclusiva que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes. Esse parâmetro é opcional.  
Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-\$1” .  
Tipo: string  
Obrigatório: não

 ** [EncryptionKeyArn](#API_CreateBackupVault_RequestSyntax) **   <a name="Backup-CreateBackupVault-request-EncryptionKeyArn"></a>
A chave de criptografia no lado do servidor usada para proteger seus backups, por exemplo, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.  
Tipo: string  
Obrigatório: não

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CreationDate": number
}
```

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

 ** [BackupVaultArn](#API_CreateBackupVault_ResponseSyntax) **   <a name="Backup-CreateBackupVault-response-BackupVaultArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: string

 ** [BackupVaultName](#API_CreateBackupVault_ResponseSyntax) **   <a name="Backup-CreateBackupVault-response-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 em que são criados. Eles consistem em letras minúsculas, números e hifens.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [CreationDate](#API_CreateBackupVault_ResponseSyntax) **   <a name="Backup-CreateBackupVault-response-CreationDate"></a>
A data e hora em que um cofre de backup foi criado, em formato de hora 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

## Erros
<a name="API_CreateBackupVault_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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

 ** 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_CreateBackupVault_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/CreateBackupVault) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateBackupVault) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateBackupVault) 

# CreateFramework
<a name="API_CreateFramework"></a>

Cria uma framework com um ou mais controles. Uma framework é uma coleção de controles podem ser utilizados para avaliar suas práticas de backup. Usando controles personalizáveis pré-criados para definir suas políticas, você pode avaliar se as suas práticas de backup estão em conformidade com as suas políticas e quais recursos ainda não estão em conformidade.

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

```
POST /audit/frameworks HTTP/1.1
Content-type: application/json

{
   "FrameworkControls": [ 
      { 
         "ControlInputParameters": [ 
            { 
               "ParameterName": "string",
               "ParameterValue": "string"
            }
         ],
         "ControlName": "string",
         "ControlScope": { 
            "ComplianceResourceIds": [ "string" ],
            "ComplianceResourceTypes": [ "string" ],
            "Tags": { 
               "string" : "string" 
            }
         }
      }
   ],
   "FrameworkDescription": "string",
   "FrameworkName": "string",
   "FrameworkTags": { 
      "string" : "string" 
   },
   "IdempotencyToken": "string"
}
```

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

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

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

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

 ** [FrameworkControls](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkControls"></a>
Os controles que compõem o framework. Cada controle na lista tem um nome, parâmetros de entrada e escopo.  
Tipo: matriz de objetos [FrameworkControl](API_FrameworkControl.md)  
Obrigatório: Sim

 ** [FrameworkDescription](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkDescription"></a>
Uma descrição opcional da framework com no máximo 1.024 caracteres.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.  
Padrão: `.*\S.*`   
Obrigatório: não

 ** [FrameworkName](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkName"></a>
O nome exclusivo da framework. Esse nome deve ter entre 1 e 256 caracteres, começando com uma letra, e consistir em letras (a-z, A-Z), números (0-9) e sublinhados (\$1).  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

 ** [FrameworkTags](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-FrameworkTags"></a>
As tags a serem atribuídas à framework.  
Tipo: mapa de string para string  
Obrigatório: não

 ** [IdempotencyToken](#API_CreateFramework_RequestSyntax) **   <a name="Backup-CreateFramework-request-IdempotencyToken"></a>
Uma string escolhida pelo cliente que você pode usar para distinguir entre chamadas idênticas para `CreateFrameworkInput`. 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

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

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

{
   "FrameworkArn": "string",
   "FrameworkName": "string"
}
```

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

 ** [FrameworkArn](#API_CreateFramework_ResponseSyntax) **   <a name="Backup-CreateFramework-response-FrameworkArn"></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

 ** [FrameworkName](#API_CreateFramework_ResponseSyntax) **   <a name="Backup-CreateFramework-response-FrameworkName"></a>
O nome exclusivo da framework. Esse nome deve ter entre 1 e 256 caracteres, começando com uma letra, e consistir em letras (a-z, A-Z), números (0-9) e sublinhados (\$1).  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*` 

## Erros
<a name="API_CreateFramework_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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

 ** 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_CreateFramework_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/CreateFramework) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateFramework) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateFramework) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateFramework) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateFramework) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateFramework) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateFramework) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateFramework) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateFramework) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateFramework) 

# CreateLegalHold
<a name="API_CreateLegalHold"></a>

Cria uma retenção legal em um ponto de recuperação (backup). Uma retenção legal é uma restrição à alteração ou exclusão de um backup até que um usuário autorizado cancele a retenção legal. haverá falha em qualquer ação para excluir ou desassociar um ponto de recuperação com um erro se uma ou mais retenções legais ativas estiverem no ponto de recuperação.

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

```
POST /legal-holds/ HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "IdempotencyToken": "string",
   "RecoveryPointSelection": { 
      "DateRange": { 
         "FromDate": number,
         "ToDate": number
      },
      "ResourceIdentifiers": [ "string" ],
      "VaultNames": [ "string" ]
   },
   "Tags": { 
      "string" : "string" 
   },
   "Title": "string"
}
```

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

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

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

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

 ** [Description](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-Description"></a>
A descrição da string da retenção legal.  
Tipo: String  
Obrigatório: Sim

 ** [IdempotencyToken](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-IdempotencyToken"></a>
Essa é uma string escolhida pelo usuário usada para distinguir entre chamadas idênticas. 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

 ** [RecoveryPointSelection](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-RecoveryPointSelection"></a>
Os critérios para atribuir um conjunto de recursos, como tipos de recursos ou cofres de backup.  
Tipo: objeto [RecoveryPointSelection](API_RecoveryPointSelection.md)  
Obrigatório: não

 ** [Tags](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-Tags"></a>
Tags opcionais a serem incluídas. Uma tag é um par de chave/valor que ajuda você a gerenciar, filtrar e pesquisar seus recursos. Os caracteres permitidos incluem letras, números e espaços em UTF-8, além dos seguintes caracteres especiais: \$1 - = . \$1 : /.   
Tipo: mapa de string para string  
Obrigatório: não

 ** [Title](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-Title"></a>
O título da retenção legal.  
Tipo: String  
Obrigatório: sim

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

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

{
   "CreationDate": number,
   "Description": "string",
   "LegalHoldArn": "string",
   "LegalHoldId": "string",
   "RecoveryPointSelection": { 
      "DateRange": { 
         "FromDate": number,
         "ToDate": number
      },
      "ResourceIdentifiers": [ "string" ],
      "VaultNames": [ "string" ]
   },
   "Status": "string",
   "Title": "string"
}
```

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

 ** [CreationDate](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-CreationDate"></a>
A hora em que a retenção legal foi criada.  
Tipo: Timestamp

 ** [Description](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Description"></a>
A descrição da string da retenção legal.  
Tipo: string

 ** [LegalHoldArn](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-LegalHoldArn"></a>
O nome do recurso da Amazon (ARN) da retenção legal.  
Tipo: string

 ** [LegalHoldId](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-LegalHoldId"></a>
O ID da retenção legal.  
Tipo: string

 ** [RecoveryPointSelection](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-RecoveryPointSelection"></a>
Os critérios para atribuir um conjunto de recursos, como tipos de recursos ou cofres de backup.  
Tipo: objeto [RecoveryPointSelection](API_RecoveryPointSelection.md)

 ** [Status](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Status"></a>
O status da retenção legal.  
Tipo: string  
Valores válidos: `CREATING | ACTIVE | CANCELING | CANCELED` 

 ** [Title](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Title"></a>
O título da retenção legal.  
Tipo: string

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

 ** 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

 ** 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_CreateLegalHold_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/CreateLegalHold) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateLegalHold) 

# CreateLogicallyAirGappedBackupVault
<a name="API_CreateLogicallyAirGappedBackupVault"></a>

Cria um contêiner lógico no qual os backups podem ser copiados.

Essa solicitação inclui um nome, a região, o número máximo de dias de retenção, o número mínimo de dias de retenção e, opcionalmente, pode incluir tags e um ID de solicitação do criador.

**nota**  
Não inclua dados confidenciais, como números de passaporte, no nome de um cofre de backup.

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

```
PUT /logically-air-gapped-backup-vaults/backupVaultName HTTP/1.1
Content-type: application/json

{
   "BackupVaultTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string",
   "EncryptionKeyArn": "string",
   "MaxRetentionDays": number,
   "MinRetentionDays": number
}
```

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

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

 ** [backupVaultName](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-uri-BackupVaultName"></a>
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup logicamente isolados são identificados por nomes que são exclusivos da conta usada para criá-los e a região em que são criados.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

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

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

 ** [CreatorRequestId](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-CreatorRequestId"></a>
O ID da solicitação de criação.  
Esse parâmetro é opcional. Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-\$1” .  
Tipo: string  
Obrigatório: não

 ** [EncryptionKeyArn](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-EncryptionKeyArn"></a>
O ARN da chave KMS gerenciada pelo cliente a ser usada para criptografar o cofre de backup logicamente isolado. Se não for especificado, o cofre será criptografado com uma chave AWS própria gerenciada pelo Backup AWS .  
Tipo: string  
Obrigatório: não

 ** [MaxRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-MaxRetentionDays"></a>
O período máximo de retenção que o cofre retém seus pontos de recuperação.  
Tipo: longo  
Obrigatório: Sim

 ** [MinRetentionDays](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-request-MinRetentionDays"></a>
Essa configuração especifica o período mínimo de retenção que o cofre retém seus pontos de recuperação.  
O valor mínimo aceito é de sete dias.  
Tipo: longo  
Obrigatório: sim

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CreationDate": number,
   "VaultState": "string"
}
```

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

 ** [BackupVaultArn](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-response-BackupVaultArn"></a>
O nome do recurso da Amazon (ARN) do cofre.  
Tipo: string

 ** [BackupVaultName](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-response-BackupVaultName"></a>
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup logicamente isolados são identificados por nomes que são exclusivos da conta usada para criá-los e a região em que são criados.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [CreationDate](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-response-CreationDate"></a>
A data e a hora em que o cofre foi criado.  
Esse valor está no formato Unix, Tempo Universal Coordenado (UTC) e 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

 ** [VaultState](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **   <a name="Backup-CreateLogicallyAirGappedBackupVault-response-VaultState"></a>
O estado atual do cofre.  
Tipo: string  
Valores válidos: `CREATING | AVAILABLE | FAILED` 

## Erros
<a name="API_CreateLogicallyAirGappedBackupVault_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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_CreateLogicallyAirGappedBackupVault_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/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateLogicallyAirGappedBackupVault) 

# CreateReportPlan
<a name="API_CreateReportPlan"></a>

Cria um plano de relatório. Um plano de relatório é um documento que contém informações sobre o conteúdo do relatório e onde AWS Backup será entregue.

Se chamar `CreateReportPlan` com um plano existente, você receberá uma exceção `AlreadyExistsException`.

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

```
POST /audit/report-plans HTTP/1.1
Content-type: application/json

{
   "IdempotencyToken": "string",
   "ReportDeliveryChannel": { 
      "Formats": [ "string" ],
      "S3BucketName": "string",
      "S3KeyPrefix": "string"
   },
   "ReportPlanDescription": "string",
   "ReportPlanName": "string",
   "ReportPlanTags": { 
      "string" : "string" 
   },
   "ReportSetting": { 
      "Accounts": [ "string" ],
      "FrameworkArns": [ "string" ],
      "NumberOfFrameworks": number,
      "OrganizationUnits": [ "string" ],
      "Regions": [ "string" ],
      "ReportTemplate": "string"
   }
}
```

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

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

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

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

 ** [IdempotencyToken](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-IdempotencyToken"></a>
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas para `CreateReportPlanInput`. 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

 ** [ReportDeliveryChannel](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportDeliveryChannel"></a>
Uma estrutura que contém informações sobre onde e como entregar seus relatórios, especificamente o nome do bucket do Amazon S3, o prefixo de chave do S3 e os formatos dos relatórios.  
Tipo: objeto [ReportDeliveryChannel](API_ReportDeliveryChannel.md)  
Obrigatório: Sim

 ** [ReportPlanDescription](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportPlanDescription"></a>
Uma descrição opcional do plano de relatório com 1.024 caracteres no máximo.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.  
Padrão: `.*\S.*`   
Obrigatório: não

 ** [ReportPlanName](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportPlanName"></a>
O nome exclusivo do plano de relatório. Esse nome deve ter entre 1 e 256 caracteres, começando com uma letra, e consistir em letras (a-z, A-Z), números (0-9) e sublinhados (\$1).  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

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

 ** [ReportSetting](#API_CreateReportPlan_RequestSyntax) **   <a name="Backup-CreateReportPlan-request-ReportSetting"></a>
Identifica o modelo do relatório. Relatórios são criados utilizando um modelo de relatório. Os modelos de relatório são:  
 `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT `   
Se o modelo de relatório for `RESOURCE_COMPLIANCE_REPORT` ou`CONTROL_COMPLIANCE_REPORT`, esse recurso de API também descreve a cobertura do relatório por Regiões da AWS estruturas.  
Tipo: objeto [ReportSetting](API_ReportSetting.md)  
Obrigatório: sim

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

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

{
   "CreationTime": number,
   "ReportPlanArn": "string",
   "ReportPlanName": "string"
}
```

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

 ** [CreationTime](#API_CreateReportPlan_ResponseSyntax) **   <a name="Backup-CreateReportPlan-response-CreationTime"></a>
A data e hora em que o cofre de backup foi criado, em formato de hora Unix e Tempo Universal Coordenado (UTC). O valor de `CreationTime` 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

 ** [ReportPlanArn](#API_CreateReportPlan_ResponseSyntax) **   <a name="Backup-CreateReportPlan-response-ReportPlanArn"></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

 ** [ReportPlanName](#API_CreateReportPlan_ResponseSyntax) **   <a name="Backup-CreateReportPlan-response-ReportPlanName"></a>
O nome exclusivo do plano de relatório.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*` 

## Erros
<a name="API_CreateReportPlan_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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

 ** 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_CreateReportPlan_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/CreateReportPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateReportPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateReportPlan) 

# CreateRestoreAccessBackupVault
<a name="API_CreateRestoreAccessBackupVault"></a>

Cria um cofre de backup com acesso para restauração que concede acesso temporário aos pontos de recuperação em um cofre de backup logicamente isolado, sujeito à aprovação MPA.

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

```
PUT /restore-access-backup-vaults HTTP/1.1
Content-type: application/json

{
   "BackupVaultName": "string",
   "BackupVaultTags": { 
      "string" : "string" 
   },
   "CreatorRequestId": "string",
   "RequesterComment": "string",
   "SourceBackupVaultArn": "string"
}
```

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

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

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

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

 ** [BackupVaultName](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-BackupVaultName"></a>
O nome do cofre de backup que deve ser associado a uma equipe de aprovação MPA.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: não

 ** [BackupVaultTags](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-BackupVaultTags"></a>
Tags opcionais para atribuir ao cofre de backup do acesso para restauração.  
Tipo: mapa de string para string  
Obrigatório: não

 ** [CreatorRequestId](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-CreatorRequestId"></a>
Uma string exclusiva que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes.  
Tipo: string  
Obrigatório: não

 ** [RequesterComment](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-RequesterComment"></a>
Um comentário explicando o motivo da solicitação do acesso para restauração ao cofre de backup.  
Tipo: string  
Obrigatório: não

 ** [SourceBackupVaultArn](#API_CreateRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-request-SourceBackupVaultArn"></a>
O ARN do cofre de backup de origem que contém os pontos de recuperação aos quais o acesso temporário é solicitado.  
Tipo: String  
Obrigatório: sim

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

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

{
   "CreationDate": number,
   "RestoreAccessBackupVaultArn": "string",
   "RestoreAccessBackupVaultName": "string",
   "VaultState": "string"
}
```

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

 ** [CreationDate](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-response-CreationDate"></a>
A data e hora em que o cofre de backup de acesso para restauração foi criado, em formato de hora Unix e Tempo Universal Coordenado   
Tipo: Timestamp

 ** [RestoreAccessBackupVaultArn](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-response-RestoreAccessBackupVaultArn"></a>
O ARN que identifica de forma exclusiva o cofre de backup do acesso à restauração criado.  
Tipo: string

 ** [RestoreAccessBackupVaultName](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-response-RestoreAccessBackupVaultName"></a>
O nome do cofre de backup de acesso para restauração criado.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [VaultState](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **   <a name="Backup-CreateRestoreAccessBackupVault-response-VaultState"></a>
O estado atual do cofre de backup de acesso para restauração.  
Tipo: string  
Valores válidos: `CREATING | AVAILABLE | FAILED` 

## Erros
<a name="API_CreateRestoreAccessBackupVault_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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_CreateRestoreAccessBackupVault_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/CreateRestoreAccessBackupVault) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateRestoreAccessBackupVault) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateRestoreAccessBackupVault) 

# CreateRestoreTestingPlan
<a name="API_CreateRestoreTestingPlan"></a>

Criar um plano de teste de restauração.

Primeira de duas etapas para criar um plano de teste de restauração. Depois que essa solicitação for bem-sucedida, conclua o procedimento usando CreateRestoreTestingSelection.

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

```
PUT /restore-testing/plans HTTP/1.1
Content-type: application/json

{
   "CreatorRequestId": "string",
   "RestoreTestingPlan": { 
      "RecoveryPointSelection": { 
         "Algorithm": "string",
         "ExcludeVaults": [ "string" ],
         "IncludeVaults": [ "string" ],
         "RecoveryPointTypes": [ "string" ],
         "SelectionWindowDays": number
      },
      "RestoreTestingPlanName": "string",
      "ScheduleExpression": "string",
      "ScheduleExpressionTimezone": "string",
      "StartWindowHours": number
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

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

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

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

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

 ** [CreatorRequestId](#API_CreateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-CreateRestoreTestingPlan-request-CreatorRequestId"></a>
Essa é uma string exclusiva que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes. Esse parâmetro é opcional. Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-\$1” .  
Tipo: string  
Obrigatório: não

 ** [RestoreTestingPlan](#API_CreateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-CreateRestoreTestingPlan-request-RestoreTestingPlan"></a>
Um plano de testes de restauração deve conter uma string `RestoreTestingPlanName` exclusiva criada por você e deve conter um cron `ScheduleExpression`. Você também pode incluir um inteiro `StartWindowHours` e uma string `CreatorRequestId`.  
`RestoreTestingPlanName` é uma string exclusiva que é o nome do plano de testes de restauração. Ele não pode ser alterado após a criação e deve consistir somente em caracteres alfanuméricos e sublinhados.  
Tipo: objeto [RestoreTestingPlanForCreate](API_RestoreTestingPlanForCreate.md)  
Obrigatório: Sim

 ** [Tags](#API_CreateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-CreateRestoreTestingPlan-request-Tags"></a>
As tags a serem atribuídas ao plano de teste de restauração.  
Tipo: mapa de string para string  
Obrigatório: Não

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

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

{
   "CreationTime": number,
   "RestoreTestingPlanArn": "string",
   "RestoreTestingPlanName": "string"
}
```

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

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

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

 ** [CreationTime](#API_CreateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingPlan-response-CreationTime"></a>
A data e hora em que um plano de testes de restauração foi criado, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CreationTime` 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

 ** [RestoreTestingPlanArn](#API_CreateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingPlan-response-RestoreTestingPlanArn"></a>
Um nome do recurso da Amazon (ARN) que identifica de forma exclusiva o plano de testes de restauração criado.  
Tipo: string

 ** [RestoreTestingPlanName](#API_CreateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingPlan-response-RestoreTestingPlanName"></a>
Essa string exclusiva é o nome do plano de testes de restauração.  
O nome não poderá ser alterado após a criação. Ele só pode conter caracteres alfanuméricos e sublinhados. O tamanho máximo é 50.  
Tipo: string

## Erros
<a name="API_CreateRestoreTestingPlan_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** ConflictException **   
 AWS Backup não pode realizar a ação que você solicitou até que termine de executar uma ação anterior. Tente novamente mais tarde.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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

 ** 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_CreateRestoreTestingPlan_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/CreateRestoreTestingPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateRestoreTestingPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateRestoreTestingPlan) 

# CreateRestoreTestingSelection
<a name="API_CreateRestoreTestingSelection"></a>

Essa solicitação pode ser enviada após a CreateRestoreTestingPlan solicitação ser retornada com sucesso. Essa é a segunda parte da criação de um plano de testes de recursos e deve ser concluída sequencialmente.

Isso consiste em `RestoreTestingSelectionName`, `ProtectedResourceType` e um dos seguintes:
+  `ProtectedResourceArns` 
+  `ProtectedResourceConditions` 

Cada tipo de recurso protegido pode ter um único valor.

Uma seleção de testes de restauração pode incluir um valor curinga (“\$1”) para `ProtectedResourceArns` com `ProtectedResourceConditions`. Como alternativa, você pode incluir até 30 recursos protegidos específicos ARNs no`ProtectedResourceArns`.

Não é possível selecionar por tipos de recursos protegidos e específicos ARNs. A solicitação falhará se ambos forem incluídos.

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

```
PUT /restore-testing/plans/RestoreTestingPlanName/selections HTTP/1.1
Content-type: application/json

{
   "CreatorRequestId": "string",
   "RestoreTestingSelection": { 
      "IamRoleArn": "string",
      "ProtectedResourceArns": [ "string" ],
      "ProtectedResourceConditions": { 
         "StringEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      },
      "ProtectedResourceType": "string",
      "RestoreMetadataOverrides": { 
         "string" : "string" 
      },
      "RestoreTestingSelectionName": "string",
      "ValidationWindowHours": number
   }
}
```

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

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

 ** [RestoreTestingPlanName](#API_CreateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-CreateRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
Insira o nome do plano de teste de restauração que foi retornado da CreateRestoreTestingPlan solicitação relacionada.  
Obrigatório: Sim

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

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

 ** [CreatorRequestId](#API_CreateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-CreateRestoreTestingSelection-request-CreatorRequestId"></a>
Essa é uma string exclusiva opcional que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes. Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-\$1” .  
Tipo: string  
Obrigatório: não

 ** [RestoreTestingSelection](#API_CreateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-CreateRestoreTestingSelection-request-RestoreTestingSelection"></a>
Isso consiste em `RestoreTestingSelectionName`, `ProtectedResourceType` e um dos seguintes:  
+  `ProtectedResourceArns` 
+  `ProtectedResourceConditions` 
Cada tipo de recurso protegido pode ter um único valor.  
Uma seleção de testes de restauração pode incluir um valor curinga (“\$1”) para `ProtectedResourceArns` com `ProtectedResourceConditions`. Como alternativa, você pode incluir até 30 recursos protegidos específicos ARNs no`ProtectedResourceArns`.  
Tipo: objeto [RestoreTestingSelectionForCreate](API_RestoreTestingSelectionForCreate.md)  
Obrigatório: sim

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

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

{
   "CreationTime": number,
   "RestoreTestingPlanArn": "string",
   "RestoreTestingPlanName": "string",
   "RestoreTestingSelectionName": "string"
}
```

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

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

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

 ** [CreationTime](#API_CreateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingSelection-response-CreationTime"></a>
A hora em que a seleção de testes de recursos foi criada.  
Tipo: Timestamp

 ** [RestoreTestingPlanArn](#API_CreateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingSelection-response-RestoreTestingPlanArn"></a>
O ARN do plano de teste de restauração ao qual a seleção de teste de restauração está associada.  
Tipo: string

 ** [RestoreTestingPlanName](#API_CreateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingSelection-response-RestoreTestingPlanName"></a>
O nome do plano de teste de restauração.  
O nome não poderá ser alterado após a criação. Ele só pode conter caracteres alfanuméricos e sublinhados. O tamanho máximo é 50.  
Tipo: string

 ** [RestoreTestingSelectionName](#API_CreateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-CreateRestoreTestingSelection-response-RestoreTestingSelectionName"></a>
O nome da seleção de teste de restauração que pertence ao plano de teste de restauração relacionado.  
O nome não poderá ser alterado após a criação. Ele só pode conter caracteres alfanuméricos e sublinhados. O tamanho máximo é 50.  
Tipo: string

## Erros
<a name="API_CreateRestoreTestingSelection_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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_CreateRestoreTestingSelection_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/CreateRestoreTestingSelection) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateRestoreTestingSelection) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateRestoreTestingSelection) 

# CreateTieringConfiguration
<a name="API_CreateTieringConfiguration"></a>

Cria uma configuração de camadas.

Uma configuração hierárquica permite a movimentação automática dos dados de backup para um nível de armazenamento de menor custo, com base na idade dos objetos de backup no cofre de backup.

Cada cofre só pode ter uma configuração de classificação por níveis específica do cofre, além de qualquer configuração global que se aplique a todos os cofres.

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

```
PUT /tiering-configurations HTTP/1.1
Content-type: application/json

{
   "CreatorRequestId": "string",
   "TieringConfiguration": { 
      "BackupVaultName": "string",
      "ResourceSelection": [ 
         { 
            "Resources": [ "string" ],
            "ResourceType": "string",
            "TieringDownSettingsInDays": number
         }
      ],
      "TieringConfigurationName": "string"
   },
   "TieringConfigurationTags": { 
      "string" : "string" 
   }
}
```

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

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

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

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

 ** [CreatorRequestId](#API_CreateTieringConfiguration_RequestSyntax) **   <a name="Backup-CreateTieringConfiguration-request-CreatorRequestId"></a>
Essa é uma string exclusiva que identifica a solicitação e permite que solicitações com falha sejam repetidas sem o risco de executar a operação duas vezes. Esse parâmetro é opcional. Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-\$1” .  
Tipo: string  
Obrigatório: não

 ** [TieringConfiguration](#API_CreateTieringConfiguration_RequestSyntax) **   <a name="Backup-CreateTieringConfiguration-request-TieringConfiguration"></a>
Uma configuração de camadas deve conter uma `TieringConfigurationName` string exclusiva criada por você e deve conter um `BackupVaultName` e. `ResourceSelection` Opcionalmente, você pode incluir uma `CreatorRequestId` string.  
A `TieringConfigurationName` é uma string exclusiva que é o nome da configuração de camadas. Ele não pode ser alterado após a criação e deve consistir somente em caracteres alfanuméricos e sublinhados.  
Tipo: objeto [TieringConfigurationInputForCreate](API_TieringConfigurationInputForCreate.md)  
Obrigatório: Sim

 ** [TieringConfigurationTags](#API_CreateTieringConfiguration_RequestSyntax) **   <a name="Backup-CreateTieringConfiguration-request-TieringConfigurationTags"></a>
As tags a serem atribuídas à configuração de camadas.  
Tipo: mapa de string para string  
Obrigatório: Não

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

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

{
   "CreationTime": number,
   "TieringConfigurationArn": "string",
   "TieringConfigurationName": "string"
}
```

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

 ** [CreationTime](#API_CreateTieringConfiguration_ResponseSyntax) **   <a name="Backup-CreateTieringConfiguration-response-CreationTime"></a>
A data e a hora em que uma configuração de camadas foi criada, no formato Unix e no Tempo Universal Coordenado (UTC). O valor de `CreationTime` 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

 ** [TieringConfigurationArn](#API_CreateTieringConfiguration_ResponseSyntax) **   <a name="Backup-CreateTieringConfiguration-response-TieringConfigurationArn"></a>
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva a configuração de camadas criada.  
Tipo: string

 ** [TieringConfigurationName](#API_CreateTieringConfiguration_ResponseSyntax) **   <a name="Backup-CreateTieringConfiguration-response-TieringConfigurationName"></a>
Essa sequência de caracteres exclusiva é o nome da configuração de camadas.  
O nome não poderá ser alterado após a criação. Ele só pode conter caracteres alfanuméricos e sublinhados. O comprimento máximo é 200.  
Tipo: string

## Erros
<a name="API_CreateTieringConfiguration_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** ConflictException **   
 AWS Backup não pode realizar a ação que você solicitou até que termine de executar uma ação anterior. Tente novamente mais tarde.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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

 ** 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_CreateTieringConfiguration_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/CreateTieringConfiguration) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateTieringConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateTieringConfiguration) 

# DeleteBackupPlan
<a name="API_DeleteBackupPlan"></a>

Exclui um plano de backup. É possível excluir um plano de backup somente depois que todas as seleções de recursos associadas forem excluídas. A exclusão de um plano de backup exclui a versão atual do plano. As versões anteriores, se houver, ainda existirão.

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

```
DELETE /backup/plans/backupPlanId HTTP/1.1
```

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

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

 ** [backupPlanId](#API_DeleteBackupPlan_RequestSyntax) **   <a name="Backup-DeleteBackupPlan-request-uri-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "DeletionDate": number,
   "VersionId": "string"
}
```

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

 ** [BackupPlanArn](#API_DeleteBackupPlan_ResponseSyntax) **   <a name="Backup-DeleteBackupPlan-response-BackupPlanArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica exclusivamente um plano de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.  
Tipo: string

 ** [BackupPlanId](#API_DeleteBackupPlan_ResponseSyntax) **   <a name="Backup-DeleteBackupPlan-response-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Tipo: string

 ** [DeletionDate](#API_DeleteBackupPlan_ResponseSyntax) **   <a name="Backup-DeleteBackupPlan-response-DeletionDate"></a>
A data e hora em que um plano de backup foi excluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `DeletionDate` 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

 ** [VersionId](#API_DeleteBackupPlan_ResponseSyntax) **   <a name="Backup-DeleteBackupPlan-response-VersionId"></a>
Strings Unicode exclusivas geradas aleatoriamente, codificadas em UTF-8 que têm no máximo 1.024 bytes. A versão IDs não pode ser editada.  
Tipo: string

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

 ** 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_DeleteBackupPlan_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/DeleteBackupPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupPlan) 

# DeleteBackupSelection
<a name="API_DeleteBackupSelection"></a>

Exclui a seleção de recursos associada a um plano de backup especificado pelo `SelectionId`.

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

```
DELETE /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
```

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

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

 ** [backupPlanId](#API_DeleteBackupSelection_RequestSyntax) **   <a name="Backup-DeleteBackupSelection-request-uri-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Obrigatório: Sim

 ** [selectionId](#API_DeleteBackupSelection_RequestSyntax) **   <a name="Backup-DeleteBackupSelection-request-uri-SelectionId"></a>
Identifica de forma exclusiva uma solicitação para atribuir um conjunto de recursos a um plano de backup.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DeleteBackupSelection_ResponseElements"></a>

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

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

 ** 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_DeleteBackupSelection_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/DeleteBackupSelection) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupSelection) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupSelection) 

# DeleteBackupVault
<a name="API_DeleteBackupVault"></a>

Exclui o cofre de backup identificado por seu nome. Só será possível excluir um cofre se ele estiver vazio.

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

```
DELETE /backup-vaults/backupVaultName HTTP/1.1
```

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

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

 ** [backupVaultName](#API_DeleteBackupVault_RequestSyntax) **   <a name="Backup-DeleteBackupVault-request-uri-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.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DeleteBackupVault_ResponseElements"></a>

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

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

 ** 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_DeleteBackupVault_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/DeleteBackupVault) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupVault) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupVault) 

# DeleteBackupVaultAccessPolicy
<a name="API_DeleteBackupVaultAccessPolicy"></a>

Exclui o documento de política que gerencia as permissões em um cofre de backup.

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

```
DELETE /backup-vaults/backupVaultName/access-policy HTTP/1.1
```

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

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

 ** [backupVaultName](#API_DeleteBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-DeleteBackupVaultAccessPolicy-request-uri-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. Eles consistem em letras minúsculas, números e hifens.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DeleteBackupVaultAccessPolicy_ResponseElements"></a>

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

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

 ** 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_DeleteBackupVaultAccessPolicy_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/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupVaultAccessPolicy) 

# DeleteBackupVaultLockConfiguration
<a name="API_DeleteBackupVaultLockConfiguration"></a>

Exclui o AWS Backup Vault Lock de um cofre de backup especificado pelo nome de um cofre de backup.

Se a configuração do Vault Lock for imutável, não será possível excluir o Vault Lock usando operações de API e você receberá uma `InvalidRequestException` se tentar fazer isso. Para obter mais informações, consulte [Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) no *Guia do AWS Backup desenvolvedor*.

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

```
DELETE /backup-vaults/backupVaultName/vault-lock HTTP/1.1
```

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

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

 ** [backupVaultName](#API_DeleteBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-DeleteBackupVaultLockConfiguration-request-uri-BackupVaultName"></a>
O nome do cofre de backup do qual excluir o AWS Backup Vault Lock.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DeleteBackupVaultLockConfiguration_ResponseElements"></a>

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

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

 ** 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_DeleteBackupVaultLockConfiguration_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/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupVaultLockConfiguration) 

# DeleteBackupVaultNotifications
<a name="API_DeleteBackupVaultNotifications"></a>

Exclui as notificações de eventos para o cofre de backup especificado.

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

```
DELETE /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
```

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

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

 ** [backupVaultName](#API_DeleteBackupVaultNotifications_RequestSyntax) **   <a name="Backup-DeleteBackupVaultNotifications-request-uri-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 em que são criados.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DeleteBackupVaultNotifications_ResponseElements"></a>

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

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

 ** 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_DeleteBackupVaultNotifications_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/DeleteBackupVaultNotifications) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteBackupVaultNotifications) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteBackupVaultNotifications) 

# DeleteFramework
<a name="API_DeleteFramework"></a>

Exclui a framework especificada por um nome de framework.

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

```
DELETE /audit/frameworks/frameworkName HTTP/1.1
```

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

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

 ** [frameworkName](#API_DeleteFramework_RequestSyntax) **   <a name="Backup-DeleteFramework-request-uri-FrameworkName"></a>
O nome exclusivo de uma framework.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DeleteFramework_ResponseElements"></a>

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

## Erros
<a name="API_DeleteFramework_Errors"></a>

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

 ** ConflictException **   
 AWS Backup não pode realizar a ação que você solicitou até que termine de executar uma ação anterior. Tente novamente mais tarde.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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_DeleteFramework_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/DeleteFramework) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteFramework) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteFramework) 

# DeleteRecoveryPoint
<a name="API_DeleteRecoveryPoint"></a>

Exclui o ponto de recuperação especificado por um ID de ponto de recuperação.

Se o ID do ponto de recuperação pertencer a um backup contínuo, chamar esse endpoint excluirá o backup contínuo existente e interromperá o backup contínuo futuro.

Quando as permissões de um perfil do IAM são insuficientes para chamar essa API, o serviço envia de volta uma resposta HTTP 200 com um corpo HTTP vazio, mas o ponto de recuperação não é excluído. Em vez disso, ele entra em um estado `EXPIRED`.

 Os pontos de recuperação `EXPIRED` podem ser excluídos com essa API quando o perfil do IAM tiver a ação `iam:CreateServiceLinkedRole`. Para saber mais sobre como adicionar esse perfil, consulte [Solucionar problemas com exclusões manuais](https://docs.aws.amazon.com/aws-backup/latest/devguide/deleting-backups.html#deleting-backups-troubleshooting).

Se o usuário ou perfil for excluído ou se a permissão no perfil for removida, haverá falha na exclusão e ela entrará em um estado `EXPIRED`.

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

```
DELETE /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1
```

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

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

 ** [backupVaultName](#API_DeleteRecoveryPoint_RequestSyntax) **   <a name="Backup-DeleteRecoveryPoint-request-uri-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.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [recoveryPointArn](#API_DeleteRecoveryPoint_RequestSyntax) **   <a name="Backup-DeleteRecoveryPoint-request-uri-RecoveryPointArn"></a>
Um Nome do recurso da Amazon (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`.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DeleteRecoveryPoint_ResponseElements"></a>

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

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

 ** InvalidResourceStateException **   
 AWS Backup já está executando uma ação nesse ponto de recuperação. Ele não pode realizar a ação solicitada até que a primeira ação seja concluída. Tente novamente mais tarde.    
 ** 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_DeleteRecoveryPoint_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/DeleteRecoveryPoint) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteRecoveryPoint) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteRecoveryPoint) 

# DeleteReportPlan
<a name="API_DeleteReportPlan"></a>

Exclui o plano de relatório especificado por um nome de plano de relatório.

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

```
DELETE /audit/report-plans/reportPlanName HTTP/1.1
```

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

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

 ** [reportPlanName](#API_DeleteReportPlan_RequestSyntax) **   <a name="Backup-DeleteReportPlan-request-uri-ReportPlanName"></a>
O nome exclusivo de um plano de relatório.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DeleteReportPlan_ResponseElements"></a>

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

## Erros
<a name="API_DeleteReportPlan_Errors"></a>

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

 ** ConflictException **   
 AWS Backup não pode realizar a ação que você solicitou até que termine de executar uma ação anterior. Tente novamente mais tarde.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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_DeleteReportPlan_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/DeleteReportPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteReportPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteReportPlan) 

# DeleteRestoreTestingPlan
<a name="API_DeleteRestoreTestingPlan"></a>

Essa solicitação exclui o plano de testes de restauração especificado.

A exclusão só ocorrerá com sucesso se todas as seleções de testes de restauração associadas forem excluídas primeiro.

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

```
DELETE /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
```

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

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

 ** [RestoreTestingPlanName](#API_DeleteRestoreTestingPlan_RequestSyntax) **   <a name="Backup-DeleteRestoreTestingPlan-request-uri-RestoreTestingPlanName"></a>
Nome exclusivo obrigatório do plano de testes de restauração que você deseja excluir.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

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

## Erros
<a name="API_DeleteRestoreTestingPlan_Errors"></a>

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

 ** 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

 ** 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_DeleteRestoreTestingPlan_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/DeleteRestoreTestingPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteRestoreTestingPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteRestoreTestingPlan) 

# DeleteRestoreTestingSelection
<a name="API_DeleteRestoreTestingSelection"></a>

Insira o nome do plano de testes de restauração e o nome da seleção de testes de restauração.

Todas as seleções de testes associadas a um plano de testes de restauração devem ser excluídas antes que o plano de testes de restauração possa ser excluído.

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

```
DELETE /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
```

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

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

 ** [RestoreTestingPlanName](#API_DeleteRestoreTestingSelection_RequestSyntax) **   <a name="Backup-DeleteRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
Nome exclusivo obrigatório do plano de testes de restauração que contém a seleção de testes de restauração que você deseja excluir.  
Obrigatório: Sim

 ** [RestoreTestingSelectionName](#API_DeleteRestoreTestingSelection_RequestSyntax) **   <a name="Backup-DeleteRestoreTestingSelection-request-uri-RestoreTestingSelectionName"></a>
Nome exclusivo obrigatório da seleção de testes de restauração que você deseja excluir.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

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

## Erros
<a name="API_DeleteRestoreTestingSelection_Errors"></a>

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

 ** 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_DeleteRestoreTestingSelection_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/DeleteRestoreTestingSelection) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteRestoreTestingSelection) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteRestoreTestingSelection) 

# DeleteTieringConfiguration
<a name="API_DeleteTieringConfiguration"></a>

Exclui a configuração de camadas especificada por um nome de configuração de camadas.

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

```
DELETE /tiering-configurations/tieringConfigurationName HTTP/1.1
```

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

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

 ** [tieringConfigurationName](#API_DeleteTieringConfiguration_RequestSyntax) **   <a name="Backup-DeleteTieringConfiguration-request-uri-TieringConfigurationName"></a>
O nome exclusivo de uma configuração hierárquica.  
Padrão: `^[a-zA-Z0-9_]{1,200}$`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DeleteTieringConfiguration_ResponseElements"></a>

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

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

 ** 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_DeleteTieringConfiguration_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/DeleteTieringConfiguration) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DeleteTieringConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DeleteTieringConfiguration) 

# DescribeBackupJob
<a name="API_DescribeBackupJob"></a>

Retorna os detalhes do trabalho de backup para o `BackupJobId` especificado.

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

```
GET /backup-jobs/backupJobId HTTP/1.1
```

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

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

 ** [backupJobId](#API_DescribeBackupJob_RequestSyntax) **   <a name="Backup-DescribeBackupJob-request-uri-BackupJobId"></a>
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "AccountId": "string",
   "BackupJobId": "string",
   "BackupOptions": { 
      "string" : "string" 
   },
   "BackupSizeInBytes": number,
   "BackupType": "string",
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "BytesTransferred": number,
   "ChildJobsInState": { 
      "string" : 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",
   "NumberOfChildJobs": number,
   "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"
}
```

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

 ** [AccountId](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-AccountId"></a>
Retorna o ID da conta que é proprietária do trabalho de backup.  
Tipo: sequência  
Padrão: `^[0-9]{12}$` 

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

 ** [BackupOptions](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupOptions"></a>
Representa as opções especificadas como parte do plano de backup ou do trabalho de backup sob demanda.  
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}$` 

 ** [BackupSizeInBytes](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupSizeInBytes"></a>
O tamanho de um backup (ponto de recuperação), em bytes.  
Esse valor pode ser renderizado de forma diferente dependendo do tipo de recurso, pois AWS Backup extrai informações de dados de outros AWS serviços. Por exemplo, o valor retornado pode exibir `0`, que pode ser diferente do valor previsto.  
O comportamento esperado para valores por tipo de recurso é descrito a seguir:  
+ O Amazon Aurora, o Amazon DocumentDB e o Amazon Neptune não têm esse valor preenchido pela operação `GetBackupJobStatus`.
+ Para o Amazon DynamoDB com recursos avançados, esse valor se refere ao tamanho do ponto de recuperação (backup).
+ A Amazon EC2 e o Amazon EBS mostram o tamanho do volume (armazenamento provisionado) retornado como parte desse valor. O Amazon EBS não retorna informações sobre o tamanho do backup. O tamanho do snapshot terá o mesmo valor do recurso original do qual foi feito backup.
+ Para o Amazon EFS, esse valor se refere aos bytes delta transferidos durante um backup.
+ Para o Amazon EKS, esse valor se refere ao tamanho do seu ponto de recuperação EKS aninhado.
+  FSx A Amazon não preenche esse valor da operação `GetBackupJobStatus` para sistemas de FSx arquivos.
+ Uma instância do Amazon RDS será exibida como `0`.
+ Para máquinas virtuais em execução VMware, esse valor é passado AWS Backup por meio de um fluxo de trabalho assíncrono, o que pode significar que esse valor exibido pode subrepresentar o tamanho real do backup.
Tipo: longo

 ** [BackupType](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupType"></a>
Representa o tipo real de backup selecionado para um trabalho de backup. Por exemplo, se um backup bem-sucedido do Serviço de Cópias de Sombra de Volume (VSS) do Windows tiver sido feito, o `BackupType` retornará `"WindowsVSS"`. Se `BackupType` estiver vazio, então o tipo de backup foi um backup normal.  
Tipo: string

 ** [BackupVaultArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BackupVaultArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica exclusivamente um cofre de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: string

 ** [BackupVaultName](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-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}$` 

 ** [BytesTransferred](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-BytesTransferred"></a>
O tamanho em bytes transferido para um cofre de backup no momento em que o status do trabalho foi consultado.  
Tipo: longo

 ** [ChildJobsInState](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ChildJobsInState"></a>
Isso retorna as estatísticas dos trabalhos de backup filho (aninhados) incluídos.  
Tipo: mapa de string para string  
Chaves válidas: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` 

 ** [CompletionDate](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-CompletionDate"></a>
A data e a hora em que um trabalho de criação de backup é concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CompletionDate` 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

 ** [CreatedBy](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-CreatedBy"></a>
Contém informações de identificação sobre a criação de uma tarefa de backup, incluindo `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion` e `BackupRuleId` do plano de backup usado para criá-lo.  
Tipo: objeto [RecoveryPointCreator](API_RecoveryPointCreator.md)

 ** [CreationDate](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-CreationDate"></a>
A data e hora em que o trabalho de backup foi criado, em formato de hora 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

 ** [EncryptionKeyArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-EncryptionKeyArn"></a>
O nome do recurso da Amazon (ARN) da chave do KMS que deve ser utilizada para criptografar o backup. Ela pode ser uma chave gerenciada pelo cliente ou uma chave AWS gerenciada, dependendo da configuração do cofre.  
Tipo: string

 ** [ExpectedCompletionDate](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ExpectedCompletionDate"></a>
A data e a hora em que se espera que um trabalho de backup de recursos seja concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `ExpectedCompletionDate` 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

 ** [IamRoleArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-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

 ** [InitiationDate](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-InitiationDate"></a>
A data em que um trabalho de backup foi iniciado.  
Tipo: Timestamp

 ** [IsEncrypted](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-IsEncrypted"></a>
Um valor booliano que indica se o backup está criptografado. Todos os backups AWS Backup são criptografados, mas esse campo indica o status da criptografia para fins de transparência.  
Tipo: booliano

 ** [IsParent](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-IsParent"></a>
Isso retorna o valor booliano de que um trabalho de backup é um trabalho pai (composto).  
Tipo: booliano

 ** [MessageCategory](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-MessageCategory"></a>
A contagem de trabalhos para a categoria de mensagem especificada.  
Exemplos de strings podem incluir `AccessDenied`, `SUCCESS`, `AGGREGATE_ALL` e `INVALIDPARAMETERS`. Veja o [Monitoramento](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) para obter uma lista de MessageCategory sequências de caracteres aceitas.  
Tipo: string

 ** [NumberOfChildJobs](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-NumberOfChildJobs"></a>
Isso retorna o número de trabalhos de backup filho (aninhados).  
Tipo: longo

 ** [ParentJobId](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ParentJobId"></a>
Isso retorna o ID do trabalho de backup do recurso pai (composto).  
Tipo: string

 ** [PercentDone](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-PercentDone"></a>
Contém uma porcentagem estimada de conclusão de um trabalho no momento em que o status do trabalho foi consultado.  
Tipo: string

 ** [RecoveryPointArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-RecoveryPointArn"></a>
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

 ** [RecoveryPointLifecycle](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-RecoveryPointLifecycle"></a>
Especifica o período, em dias, antes de um ponto de recuperação fazer a transição para o armazenamento a frio, ou seja excluído.  
Os backups transferidos para o armazenamento refrigerado devem ser armazenados em armazenamento refrigerado por no mínimo 90 dias. Portanto, no console, a configuração de retenção deve ser 90 dias a mais do que a transição para frio após a configuração de dias. A transição para frio após a configuração de dias não poderá ser alterada depois que um backup for transferido para 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.  
Para remover o ciclo de vida e os períodos de retenção existentes e manter seus pontos de recuperação indefinidamente, especifique -1 para `MoveToColdStorageAfterDays` e `DeleteAfterDays`.  
Tipo: objeto [Lifecycle](API_Lifecycle.md)

 ** [ResourceArn](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ResourceArn"></a>
Um ARN identifica de forma exclusiva um recurso salvo. O formato do ARN depende do tipo de recurso.  
Tipo: string

 ** [ResourceName](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ResourceName"></a>
O nome não exclusivo do recurso que pertence ao backup especificado.  
Tipo: string

 ** [ResourceType](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-ResourceType"></a>
O tipo de AWS recurso a ser copiado; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS).  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [StartBy](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-StartBy"></a>
Especifica a hora em formato Unix e Tempo Universal Coordenado (UTC) em que uma tarefa de backup deve ser iniciada antes que seja cancelada. O valor é calculado adicionando a janela inicial ao horário programado. Portanto, se o horário programado fosse às 18h e a janela inicial fosse 2 horas, o horário `StartBy` seria às 20h na data especificada. O valor de `StartBy` 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

 ** [State](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-State"></a>
O estado atual de um trabalho de backup.  
Tipo: string  
Valores válidos: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL` 

 ** [StatusMessage](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-StatusMessage"></a>
Uma mensagem detalhada explicando o status do trabalho para fazer backup de um recurso.  
Tipo: string

 ** [VaultLockState](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-VaultLockState"></a>
O estado do bloqueio do cofre de backup. Para cofres logicamente isolados, isso indica se o cofre está bloqueado no modo de conformidade. Os valores válidos são `LOCKED` e `UNLOCKED`.  
Tipo: string

 ** [VaultType](#API_DescribeBackupJob_ResponseSyntax) **   <a name="Backup-DescribeBackupJob-response-VaultType"></a>
O tipo de cofre de backup no qual o ponto de recuperação está armazenado. Os valores válidos são `BACKUP_VAULT` para cofres de backup padrão e `LOGICALLY_AIR_GAPPED_BACKUP_VAULT` para cofres logicamente isolados.  
Tipo: string

## Erros
<a name="API_DescribeBackupJob_Errors"></a>

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

 ** DependencyFailureException **   
Um AWS serviço ou recurso dependente retornou um erro ao AWS Backup serviço e a ação não pode ser concluída.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 500

 ** 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

 ** 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_DescribeBackupJob_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/DescribeBackupJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeBackupJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeBackupJob) 

# DescribeBackupVault
<a name="API_DescribeBackupVault"></a>

Retorna metadados sobre um cofre de backup especificado por seu nome.

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

```
GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```

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

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

 ** [BackupVaultAccountId](#API_DescribeBackupVault_RequestSyntax) **   <a name="Backup-DescribeBackupVault-request-uri-BackupVaultAccountId"></a>
O ID da conta do cofre de backup especificado.

 ** [backupVaultName](#API_DescribeBackupVault_RequestSyntax) **   <a name="Backup-DescribeBackupVault-request-uri-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.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CreationDate": number,
   "CreatorRequestId": "string",
   "EncryptionKeyArn": "string",
   "EncryptionKeyType": "string",
   "LatestMpaApprovalTeamUpdate": { 
      "ExpiryDate": number,
      "InitiationDate": number,
      "MpaSessionArn": "string",
      "Status": "string",
      "StatusMessage": "string"
   },
   "LockDate": number,
   "Locked": boolean,
   "MaxRetentionDays": number,
   "MinRetentionDays": number,
   "MpaApprovalTeamArn": "string",
   "MpaSessionArn": "string",
   "NumberOfRecoveryPoints": number,
   "SourceBackupVaultArn": "string",
   "VaultState": "string",
   "VaultType": "string"
}
```

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

 ** [BackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-BackupVaultArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: string

 ** [BackupVaultName](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-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 em que são criados.  
Tipo: string

 ** [CreationDate](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-CreationDate"></a>
A data e hora em que o cofre de backup foi criado, em formato de hora 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

 ** [CreatorRequestId](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-CreatorRequestId"></a>
Uma string exclusiva que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes. Esse parâmetro é opcional. Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-\$1” .  
Tipo: string

 ** [EncryptionKeyArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-EncryptionKeyArn"></a>
A chave de criptografia no lado do servidor usada para proteger seus backups, por exemplo, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.  
Tipo: string

 ** [EncryptionKeyType](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-EncryptionKeyType"></a>
O tipo de chave de criptografia usada para o cofre de backup. Os valores válidos são CUSTOMER\$1MANAGED\$1KMS\$1KEY para chaves gerenciadas pelo cliente ou \$1OWNED\$1KMS\$1KEY para chaves de propriedade própria. AWS AWS  
Tipo: string  
Valores válidos: `AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY` 

 ** [LatestMpaApprovalTeamUpdate](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-LatestMpaApprovalTeamUpdate"></a>
Informações sobre a atualização mais recente da associação da equipe de aprovação MPA para esse cofre de backup.  
Tipo: objeto [LatestMpaApprovalTeamUpdate](API_LatestMpaApprovalTeamUpdate.md)

 ** [LockDate](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-LockDate"></a>
A data e a hora em que a configuração do AWS Backup Vault Lock não pode ser alterada ou excluída.  
Se tiver aplicado o Vault Lock ao seu cofre sem especificar uma data de bloqueio, você poderá alterar qualquer uma das configurações do Vault Lock ou excluir totalmente o Vault Lock do cofre, a qualquer momento.  
Esse valor está no formato Unix, Tempo Universal Coordenado (UTC) e 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

 ** [Locked](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-Locked"></a>
Um booleano que indica se o AWS Backup Vault Lock está atualmente protegendo o cofre de backup. `True`significa que o Vault Lock faz com que as operações de exclusão ou atualização nos pontos de recuperação armazenados no cofre falhem.  
Tipo: booliano

 ** [MaxRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MaxRetentionDays"></a>
A configuração AWS Backup Vault Lock que especifica o período máximo de retenção em que o cofre retém seus pontos de recuperação. Se esse parâmetro não for especificado, o Vault Lock não aplicará um período máximo de retenção nos pontos de recuperação no cofre (permitindo o armazenamento indefinido).  
Se esse parâmetro for especificado, qualquer trabalho de backup ou de cópia para o cofre deverá ter uma política de ciclo de vida com um período de retenção igual ou inferior ao período máximo de retenção. Se o período de retenção do trabalho for maior do que o período máximo de retenção, haverá falha no trabalho de backup ou de cópia do cofre e você deverá modificar as configurações do ciclo de vida ou usar um cofre diferente. Os pontos de recuperação já armazenados no cofre antes do Vault Lock não serão afetados.  
Tipo: longo

 ** [MinRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MinRetentionDays"></a>
A configuração do AWS Backup Vault Lock que especifica o período mínimo de retenção em que o cofre retém seus pontos de recuperação. Se esse parâmetro não for especificado, o Vault Lock não aplicará um período mínimo de retenção.  
Se esse parâmetro for especificado, qualquer trabalho de backup ou de cópia para o cofre deverá ter uma política de ciclo de vida com um período de retenção igual ou superior ao período mínimo de retenção. Se o período de retenção do trabalho for inferior do que o período mínimo de retenção, haverá falha do cofre no trabalho de backup ou de cópia e você deverá modificar as configurações do ciclo de vida ou usar um cofre diferente. Os pontos de recuperação já armazenados no cofre antes do Vault Lock não serão afetados.  
Tipo: longo

 ** [MpaApprovalTeamArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MpaApprovalTeamArn"></a>
O ARN da equipe de aprovação MPA associada a esse cofre de backup.  
Tipo: string

 ** [MpaSessionArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MpaSessionArn"></a>
O ARN da sessão de MPA associada a esse cofre de backup.  
Tipo: string

 ** [NumberOfRecoveryPoints](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-NumberOfRecoveryPoints"></a>
O número de pontos de recuperação armazenados em um cofre de backup.  
O valor da contagem de pontos de recuperação exibido no console pode ser uma aproximação. Use a API [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html) para obter a contagem exata.  
Tipo: longo

 ** [SourceBackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-SourceBackupVaultArn"></a>
O ARN do cofre de backup de origem pelo qual esse cofre de backup de acesso para restauração foi criado.  
Tipo: string

 ** [VaultState](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-VaultState"></a>
O estado atual do cofre.->  
Tipo: string  
Valores válidos: `CREATING | AVAILABLE | FAILED` 

 ** [VaultType](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-VaultType"></a>
O tipo de cofre descrito.  
Tipo: string  
Valores válidos: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT` 

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

 ** 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_DescribeBackupVault_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/DescribeBackupVault) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeBackupVault) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeBackupVault) 

# DescribeCopyJob
<a name="API_DescribeCopyJob"></a>

Retorna os metadados associados à criação de uma cópia de um recurso.

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

```
GET /copy-jobs/copyJobId HTTP/1.1
```

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

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

 ** [copyJobId](#API_DescribeCopyJob_RequestSyntax) **   <a name="Backup-DescribeCopyJob-request-uri-CopyJobId"></a>
Identifica de forma exclusiva um trabalho de cópia.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "CopyJob": { 
      "AccountId": "string",
      "BackupSizeInBytes": number,
      "ChildJobsInState": { 
         "string" : number 
      },
      "CompletionDate": number,
      "CompositeMemberIdentifier": "string",
      "CopyJobId": "string",
      "CreatedBy": { 
         "BackupPlanArn": "string",
         "BackupPlanId": "string",
         "BackupPlanName": "string",
         "BackupPlanVersion": "string",
         "BackupRuleCron": "string",
         "BackupRuleId": "string",
         "BackupRuleName": "string",
         "BackupRuleTimezone": "string"
      },
      "CreatedByBackupJobId": "string",
      "CreationDate": number,
      "DestinationBackupVaultArn": "string",
      "DestinationEncryptionKeyArn": "string",
      "DestinationRecoveryPointArn": "string",
      "DestinationRecoveryPointLifecycle": { 
         "DeleteAfterDays": number,
         "DeleteAfterEvent": "string",
         "MoveToColdStorageAfterDays": number,
         "OptInToArchiveForSupportedResources": boolean
      },
      "DestinationVaultLockState": "string",
      "DestinationVaultType": "string",
      "IamRoleArn": "string",
      "IsParent": boolean,
      "MessageCategory": "string",
      "NumberOfChildJobs": number,
      "ParentJobId": "string",
      "ResourceArn": "string",
      "ResourceName": "string",
      "ResourceType": "string",
      "SourceBackupVaultArn": "string",
      "SourceRecoveryPointArn": "string",
      "State": "string",
      "StatusMessage": "string"
   }
}
```

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

 ** [CopyJob](#API_DescribeCopyJob_ResponseSyntax) **   <a name="Backup-DescribeCopyJob-response-CopyJob"></a>
Contém informações detalhadas sobre um trabalho de cópia.  
Tipo: objeto [CopyJob](API_CopyJob.md)

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

 ** 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_DescribeCopyJob_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/DescribeCopyJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeCopyJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeCopyJob) 

# DescribeFramework
<a name="API_DescribeFramework"></a>

Retorna os detalhes da framework para o `FrameworkName` especificado.

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

```
GET /audit/frameworks/frameworkName HTTP/1.1
```

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

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

 ** [frameworkName](#API_DescribeFramework_RequestSyntax) **   <a name="Backup-DescribeFramework-request-uri-FrameworkName"></a>
O nome exclusivo de uma framework.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "CreationTime": number,
   "DeploymentStatus": "string",
   "FrameworkArn": "string",
   "FrameworkControls": [ 
      { 
         "ControlInputParameters": [ 
            { 
               "ParameterName": "string",
               "ParameterValue": "string"
            }
         ],
         "ControlName": "string",
         "ControlScope": { 
            "ComplianceResourceIds": [ "string" ],
            "ComplianceResourceTypes": [ "string" ],
            "Tags": { 
               "string" : "string" 
            }
         }
      }
   ],
   "FrameworkDescription": "string",
   "FrameworkName": "string",
   "FrameworkStatus": "string",
   "IdempotencyToken": "string"
}
```

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

 ** [CreationTime](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-CreationTime"></a>
A data e a hora em que a framework é criada, na representação ISO 8601. O valor de `CreationTime` tem precisão de milissegundos. Por exemplo, 2020-07-10T15:00:00.000-08:00 representa o dia 10 de julho de 2020 às 15:00, 8 horas antes do UTC.  
Tipo: Timestamp

 ** [DeploymentStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-DeploymentStatus"></a>
O status de implantação de uma framework. Os status são:  
 `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`   
Tipo: string

 ** [FrameworkArn](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkArn"></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

 ** [FrameworkControls](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkControls"></a>
Os controles que compõem o framework. Cada controle na lista tem um nome, parâmetros de entrada e escopo.  
Tipo: matriz de objetos [FrameworkControl](API_FrameworkControl.md)

 ** [FrameworkDescription](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkDescription"></a>
Uma descrição opcional da framework.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.  
Padrão: `.*\S.*` 

 ** [FrameworkName](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkName"></a>
O nome exclusivo de uma framework.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*` 

 ** [FrameworkStatus](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-FrameworkStatus"></a>
Uma framework consiste em um ou mais controles. Cada controle rege um recurso, como planos de backup, seleções de backup, cofres de backup ou pontos de recuperação. Também é possível ativar ou desativar a gravação do AWS Config de cada recurso. Os status são:  
+  `ACTIVE` quando a gravação é ativada para todos os recursos controlados pela framework.
+  `PARTIALLY_ACTIVE` quando a gravação é desativada para pelo menos um recurso controlado pela framework.
+  `INACTIVE` quando a gravação é desativada para todos os recursos controlados pela framework.
+  `UNAVAILABLE`quando AWS Backup não consegue validar o status da gravação no momento.
Tipo: string

 ** [IdempotencyToken](#API_DescribeFramework_ResponseSyntax) **   <a name="Backup-DescribeFramework-response-IdempotencyToken"></a>
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas para `DescribeFrameworkOutput`. 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

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

 ** 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_DescribeFramework_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/DescribeFramework) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeFramework) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeFramework) 

# DescribeGlobalSettings
<a name="API_DescribeGlobalSettings"></a>

Descreve se a AWS conta habilitou diferentes opções de gerenciamento entre contas, incluindo backup entre contas, aprovação de várias partes e administrador delegado. Retorna um erro se a conta não for membro de uma organização do Organizations. Exemplo: `describe-global-settings --region us-west-2` 

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

```
GET /global-settings HTTP/1.1
```

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

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

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

Essa solicitação não tem corpo.

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

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

{
   "GlobalSettings": { 
      "string" : "string" 
   },
   "LastUpdateTime": number
}
```

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

 ** [GlobalSettings](#API_DescribeGlobalSettings_ResponseSyntax) **   <a name="Backup-DescribeGlobalSettings-response-GlobalSettings"></a>
O status das bandeiras`isCrossAccountBackupEnabled`, `isMpaEnabled` ('Mpa' se refere à aprovação multipartidária) e. `isDelegatedAdministratorEnabled`  
+  `isCrossAccountBackupEnabled`: permita que as contas da sua organização copiem backups para outras contas.
+  `isMpaEnabled`: adicione acesso entre contas à sua organização com a opção de atribuir uma equipe de aprovação multipartidária a um cofre logicamente isolado.
+  `isDelegatedAdministratorEnabled`: permita que o Backup sincronize automaticamente as permissões de administrador delegado com o Organizations.
Tipo: mapa de string para string

 ** [LastUpdateTime](#API_DescribeGlobalSettings_ResponseSyntax) **   <a name="Backup-DescribeGlobalSettings-response-LastUpdateTime"></a>
A data e a hora em que os sinalizadores compatíveis foram atualizados pela última vez. Essa atualização está em formato Unix e Tempo Universal Coordenado (UTC). O valor de `LastUpdateTime` 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

## Erros
<a name="API_DescribeGlobalSettings_Errors"></a>

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

 ** 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

 ** 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_DescribeGlobalSettings_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/DescribeGlobalSettings) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeGlobalSettings) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeGlobalSettings) 

# DescribeProtectedResource
<a name="API_DescribeProtectedResource"></a>

Retorna informações sobre um recurso salvo, incluindo a última vez em que foi feito o backup, seu Amazon Resource Name (ARN) e o tipo de AWS serviço do recurso salvo.

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

```
GET /resources/resourceArn HTTP/1.1
```

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

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

 ** [resourceArn](#API_DescribeProtectedResource_RequestSyntax) **   <a name="Backup-DescribeProtectedResource-request-uri-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.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "LastBackupTime": number,
   "LastBackupVaultArn": "string",
   "LastRecoveryPointArn": "string",
   "LatestRestoreExecutionTimeMinutes": number,
   "LatestRestoreJobCreationDate": number,
   "LatestRestoreRecoveryPointCreationDate": number,
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string"
}
```

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

 ** [LastBackupTime](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LastBackupTime"></a>
A data e hora em que o backup de um recurso foi feito pela última vez, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `LastBackupTime` 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

 ** [LastBackupVaultArn](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LastBackupVaultArn"></a>
O ARN (Nome do recurso da Amazon) do cofre de backup que contém o ponto de recuperação do backup mais recente.  
Tipo: string

 ** [LastRecoveryPointArn](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LastRecoveryPointArn"></a>
O ARN (Nome do recurso da Amazon) do ponto de recuperação mais recente.  
Tipo: string

 ** [LatestRestoreExecutionTimeMinutes](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LatestRestoreExecutionTimeMinutes"></a>
O tempo, em minutos, que o trabalho de restauração mais recente levou para ser concluído.  
Tipo: longo

 ** [LatestRestoreJobCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LatestRestoreJobCreationDate"></a>
A data de criação do trabalho de restauração mais recente.  
Tipo: Timestamp

 ** [LatestRestoreRecoveryPointCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-LatestRestoreRecoveryPointCreationDate"></a>
A data em que o ponto de recuperação mais recente foi criado.  
Tipo: Timestamp

 ** [ResourceArn](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-ResourceArn"></a>
Um ARN que identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.  
Tipo: string

 ** [ResourceName](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-ResourceName"></a>
O nome do recurso que pertence ao backup especificado.  
Tipo: string

 ** [ResourceType](#API_DescribeProtectedResource_ResponseSyntax) **   <a name="Backup-DescribeProtectedResource-response-ResourceType"></a>
O tipo de AWS recurso salvo como ponto de recuperação; por exemplo, um volume do Amazon EBS ou um banco de dados do Amazon RDS.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

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

 ** 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_DescribeProtectedResource_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/DescribeProtectedResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeProtectedResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeProtectedResource) 

# DescribeRecoveryPoint
<a name="API_DescribeRecoveryPoint"></a>

Retorna metadados associados a um ponto de recuperação, incluindo o ID, o status, a criptografia e o ciclo de vida.

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

```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```

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

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

 ** [BackupVaultAccountId](#API_DescribeRecoveryPoint_RequestSyntax) **   <a name="Backup-DescribeRecoveryPoint-request-uri-BackupVaultAccountId"></a>
O ID da conta do cofre de backup especificado.  
Padrão: `^[0-9]{12}$` 

 ** [backupVaultName](#API_DescribeRecoveryPoint_RequestSyntax) **   <a name="Backup-DescribeRecoveryPoint-request-uri-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.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [recoveryPointArn](#API_DescribeRecoveryPoint_RequestSyntax) **   <a name="Backup-DescribeRecoveryPoint-request-uri-RecoveryPointArn"></a>
Um Nome do recurso da Amazon (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`.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CalculatedLifecycle": { 
      "DeleteAt": number,
      "MoveToColdStorageAt": number
   },
   "CompletionDate": number,
   "CompositeMemberIdentifier": "string",
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanName": "string",
      "BackupPlanVersion": "string",
      "BackupRuleCron": "string",
      "BackupRuleId": "string",
      "BackupRuleName": "string",
      "BackupRuleTimezone": "string"
   },
   "CreationDate": number,
   "EncryptionKeyArn": "string",
   "EncryptionKeyType": "string",
   "IamRoleArn": "string",
   "IndexStatus": "string",
   "IndexStatusMessage": "string",
   "InitiationDate": number,
   "IsEncrypted": boolean,
   "IsParent": boolean,
   "LastRestoreTime": number,
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "ParentRecoveryPointArn": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "ScanResults": [ 
      { 
         "Findings": [ "string" ],
         "LastScanTimestamp": number,
         "MalwareScanner": "string",
         "ScanJobState": "string"
      }
   ],
   "SourceBackupVaultArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "StorageClass": "string",
   "VaultType": "string"
}
```

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

 ** [BackupSizeInBytes](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupSizeInBytes"></a>
O tamanho de um backup, em bytes.  
Tipo: longo

 ** [BackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-BackupVaultArn"></a>
Um ARN que identifica de forma exclusiva um cofre de backup. Por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: string

 ** [BackupVaultName](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-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 em que são criados.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [CalculatedLifecycle](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CalculatedLifecycle"></a>
Um objeto `CalculatedLifecycle` contendo timestamps `DeleteAt` e `MoveToColdStorageAt`.  
Tipo: objeto [CalculatedLifecycle](API_CalculatedLifecycle.md)

 ** [CompletionDate](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CompletionDate"></a>
A data e hora em que um trabalho para criar um ponto de recuperação foi concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CompletionDate` 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

 ** [CompositeMemberIdentifier](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CompositeMemberIdentifier"></a>
O identificador de um recurso dentro de um grupo composto, como um ponto de recuperação aninhado (filho) que pertence a uma pilha composta (pai). O ID é transferido do [ID lógico](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax) dentro de uma pilha.  
Tipo: string

 ** [CreatedBy](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CreatedBy"></a>
Contém informações de identificação sobre a criação de um ponto de recuperação, incluindo o `BackupPlanArn`, o `BackupPlanId`, a `BackupPlanVersion` e o `BackupRuleId` do plano de backup usado para criá-lo.  
Tipo: objeto [RecoveryPointCreator](API_RecoveryPointCreator.md)

 ** [CreationDate](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-CreationDate"></a>
A data e hora em que um ponto de recuperação 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

 ** [EncryptionKeyArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-EncryptionKeyArn"></a>
A chave de criptografia no lado do servidor usada para proteger seus backups. Por exemplo, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.  
Tipo: string

 ** [EncryptionKeyType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-EncryptionKeyType"></a>
O tipo de chave de criptografia usada para o ponto de recuperação. Os valores válidos são CUSTOMER\$1MANAGED\$1KMS\$1KEY para chaves gerenciadas pelo cliente ou \$1OWNED\$1KMS\$1KEY para chaves de propriedade própria. AWS AWS  
Tipo: string  
Valores válidos: `AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY` 

 ** [IamRoleArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-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

 ** [IndexStatus](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IndexStatus"></a>
Esse é o status atual do índice de backup associado ao ponto de recuperação especificado.  
Os status são: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
Um ponto de recuperação com um índice que possui o status de `ACTIVE` pode ser incluído em uma pesquisa.  
Tipo: string  
Valores válidos: `PENDING | ACTIVE | FAILED | DELETING` 

 ** [IndexStatusMessage](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IndexStatusMessage"></a>
Uma string na forma de uma mensagem detalhada explicando o status de um índice de backup associado ao ponto de recuperação.  
Tipo: string

 ** [InitiationDate](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-InitiationDate"></a>
A data e hora em que o trabalho de backup que criou esse ponto de recuperação foi iniciado, em formato Unix e Tempo Universal Coordenado (UTC).  
Tipo: Timestamp

 ** [IsEncrypted](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IsEncrypted"></a>
Um valor booliano que é retornado como `TRUE` se o ponto de recuperação especificado estiver criptografado ou `FALSE` se o ponto de recuperação não estiver criptografado.  
Tipo: booliano

 ** [IsParent](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-IsParent"></a>
Isso retorna o valor booliano de que um ponto de recuperação é um trabalho pai (composto).  
Tipo: booliano

 ** [LastRestoreTime](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-LastRestoreTime"></a>
A data e hora em que um ponto de recuperação foi restaurado pela última vez, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `LastRestoreTime` 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

 ** [Lifecycle](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-Lifecycle"></a>
O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup faz a transição e expira os backups automaticamente de acordo com o ciclo de vida definido por você.  
Os backups transferidos para o armazenamento "frio" devem ficar armazenados lá por no mínimo 90 dias. Portanto, a configuração de “retenção” deve ser 90 dias maior do que a configuração de “número de dias para transição para 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.  
Tipo: objeto [Lifecycle](API_Lifecycle.md)

 ** [ParentRecoveryPointArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ParentRecoveryPointArn"></a>
Isso é um ARN que identifica de forma exclusiva um ponto de recuperação pai (composto). Por exemplo, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.  
Tipo: string

 ** [RecoveryPointArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-RecoveryPointArn"></a>
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

 ** [ResourceArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceArn"></a>
Um ARN identifica de forma exclusiva um recurso salvo. O formato do ARN depende do tipo de recurso.  
Tipo: string

 ** [ResourceName](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceName"></a>
O nome do recurso que pertence ao backup especificado.  
Tipo: string

 ** [ResourceType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ResourceType"></a>
O tipo de AWS recurso a ser salvo como ponto de recuperação; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS).  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [ScanResults](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-ScanResults"></a>
Contém os resultados mais recentes da varredura em relação ao ponto de recuperação e atualmente inclui `MalwareScanner``ScanJobState`,`Findings`,, e `LastScanTimestamp`   
Tipo: matriz de objetos [ScanResult](API_ScanResult.md)  
Membros da Matriz: número mínimo de 0 itens. Número máximo de 5 itens.

 ** [SourceBackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-SourceBackupVaultArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva o cofre de origem em que o backup do recurso foi feito originalmente. Por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. Se a recuperação for restaurada na mesma AWS conta ou região, esse valor será`null`.  
Tipo: string

 ** [Status](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-Status"></a>
Um código de status que especifica o estado do ponto de recuperação. Para obter mais informações, consulte [Status do ponto de recuperação](https://docs.aws.amazon.com/aws-backup/latest/devguide/applicationstackbackups.html#cfnrecoverypointstatus) no *Guia do AWS Backup desenvolvedor*.  
+  `CREATING`status indica que um AWS Backup trabalho foi iniciado para um recurso. O processo de backup foi iniciado e está processando ativamente um trabalho de backup para o ponto de recuperação associado.
+  O status `AVAILABLE` indica que o backup foi criado com sucesso para o ponto de recuperação. O processo de backup foi concluído sem problemas e o ponto de recuperação agora está pronto para uso.
+  O status `PARTIAL` indica que um ponto de recuperação composto tem um ou mais pontos de recuperação aninhados que não estavam no backup.
+  `EXPIRED`o status indica que o ponto de recuperação excedeu seu período de retenção, mas AWS Backup não tem permissão ou não consegue excluí-lo. Para excluir manualmente esses pontos de recuperação, consulte [Etapa 3: Excluir os pontos de recuperação](https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups) na seção *Limpar recursos* da *Introdução*.
+  O status `STOPPED` ocorre em um backup contínuo em que um usuário executou alguma ação que faz com que o backup contínuo seja desativado. Isso pode ser causado pela remoção de permissões, pela desativação do controle de versão, pela desativação do envio de EventBridge eventos ou pela desativação das EventBridge regras estabelecidas pelo. AWS Backup Para pontos de recuperação de recursos do Amazon S3, Amazon RDS e Amazon Aurora, esse status ocorre quando o período de retenção de uma regra de backup contínuo é alterado.

  Para resolver o status `STOPPED`, certifique-se de que todas as permissões solicitadas estejam em vigor e que o versionamento esteja habilitado no bucket do S3. Quando essas condições forem atendidas, a próxima instância de uma regra de backup em execução resultará na criação de um ponto de recuperação contínuo. Os pontos de recuperação com status PARADO não precisam ser excluídos.

  Para o SAP HANA na Amazon, EC2 `STOPPED` o status ocorre devido à ação do usuário, à configuração incorreta do aplicativo ou à falha no backup. Para garantir que futuros backups contínuos tenham êxito, consulte o status do ponto de recuperação e verifique o SAP HANA para obter detalhes.
Tipo: string  
Valores válidos: `COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING` 

 ** [StatusMessage](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-StatusMessage"></a>
Uma mensagem de status explicando o status do ponto de recuperação.  
Tipo: string

 ** [StorageClass](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-StorageClass"></a>
Especifica a classe de armazenamento do ponto de recuperação. Os valores válidos são `WARM` ou `COLD`.  
Tipo: string  
Valores válidos: `WARM | COLD | DELETED` 

 ** [VaultType](#API_DescribeRecoveryPoint_ResponseSyntax) **   <a name="Backup-DescribeRecoveryPoint-response-VaultType"></a>
O tipo de cofre em que o ponto de recuperação descrito é armazenado.  
Tipo: string  
Valores válidos: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT` 

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

 ** 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_DescribeRecoveryPoint_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/DescribeRecoveryPoint) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeRecoveryPoint) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeRecoveryPoint) 

# DescribeRegionSettings
<a name="API_DescribeRegionSettings"></a>

Retorna as configurações atuais da inclusão do serviço para a região. Se a aceitação do serviço estiver habilitada para um serviço, AWS Backup tentará proteger os recursos desse serviço nessa região, quando o recurso estiver incluído em um backup sob demanda ou em um plano de backup agendado. Caso contrário, o AWS Backup não tentará proteger os recursos desse serviço nessa região.

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

```
GET /account-settings HTTP/1.1
```

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

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

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

Essa solicitação não tem corpo.

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

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

{
   "ResourceTypeManagementPreference": { 
      "string" : boolean 
   },
   "ResourceTypeOptInPreference": { 
      "string" : boolean 
   }
}
```

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

 ** [ResourceTypeManagementPreference](#API_DescribeRegionSettings_ResponseSyntax) **   <a name="Backup-DescribeRegionSettings-response-ResourceTypeManagementPreference"></a>
Retorna se gerencia AWS Backup totalmente os backups de um tipo de recurso.  
Para obter os benefícios do AWS Backup gerenciamento completo, consulte [AWS Backup Gerenciamento completo](https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management).  
Para obter uma lista dos tipos de recursos e se cada um oferece suporte ao AWS Backup gerenciamento completo, consulte a tabela [Disponibilidade de recursos por recurso](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource).  
Se`"DynamoDB":false`, você pode habilitar o AWS Backup gerenciamento completo do backup do DynamoDB ativando os [recursos avançados de backup AWS Backup do DynamoDB](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli).  
Tipo: mapa de string para booliano  
Padrão da chave: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [ResourceTypeOptInPreference](#API_DescribeRegionSettings_ResponseSyntax) **   <a name="Backup-DescribeRegionSettings-response-ResourceTypeOptInPreference"></a>
Os serviços junto com as preferências de aceitação para a região.  
Tipo: mapa de string para booliano  
Padrão da chave: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

## Erros
<a name="API_DescribeRegionSettings_Errors"></a>

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

 ** 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_DescribeRegionSettings_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/DescribeRegionSettings) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeRegionSettings) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeRegionSettings) 

# DescribeReportJob
<a name="API_DescribeReportJob"></a>

Retorna os detalhes associados à criação de um relatório conforme especificado por seu `ReportJobId`.

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

```
GET /audit/report-jobs/reportJobId HTTP/1.1
```

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

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

 ** [reportJobId](#API_DescribeReportJob_RequestSyntax) **   <a name="Backup-DescribeReportJob-request-uri-ReportJobId"></a>
O identificador do trabalho de relatório. Uma string Unicode exclusiva, gerada aleatoriamente, codificada em UTF-8, com, no máximo, 1.024 bytes. Não é possível editar o ID do trabalho de relatório.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "ReportJob": { 
      "CompletionTime": number,
      "CreationTime": number,
      "ReportDestination": { 
         "S3BucketName": "string",
         "S3Keys": [ "string" ]
      },
      "ReportJobId": "string",
      "ReportPlanArn": "string",
      "ReportTemplate": "string",
      "Status": "string",
      "StatusMessage": "string"
   }
}
```

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

 ** [ReportJob](#API_DescribeReportJob_ResponseSyntax) **   <a name="Backup-DescribeReportJob-response-ReportJob"></a>
As informações sobre um trabalho de relatório, incluindo seus horários de conclusão e criação, o destino do relatório, o ID exclusivo do trabalho de relatório, o Nome do recurso da Amazon (ARN), o modelo do relatório, o status e a mensagem de status.  
Tipo: objeto [ReportJob](API_ReportJob.md)

## Erros
<a name="API_DescribeReportJob_Errors"></a>

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

 ** 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_DescribeReportJob_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/DescribeReportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeReportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeReportJob) 

# DescribeReportPlan
<a name="API_DescribeReportPlan"></a>

Retorna uma lista de todos os planos de relatório para um Conta da AWS Região da AWS e.

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

```
GET /audit/report-plans/reportPlanName HTTP/1.1
```

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

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

 ** [reportPlanName](#API_DescribeReportPlan_RequestSyntax) **   <a name="Backup-DescribeReportPlan-request-uri-ReportPlanName"></a>
O nome exclusivo de um plano de relatório.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "ReportPlan": { 
      "CreationTime": number,
      "DeploymentStatus": "string",
      "LastAttemptedExecutionTime": number,
      "LastSuccessfulExecutionTime": number,
      "ReportDeliveryChannel": { 
         "Formats": [ "string" ],
         "S3BucketName": "string",
         "S3KeyPrefix": "string"
      },
      "ReportPlanArn": "string",
      "ReportPlanDescription": "string",
      "ReportPlanName": "string",
      "ReportSetting": { 
         "Accounts": [ "string" ],
         "FrameworkArns": [ "string" ],
         "NumberOfFrameworks": number,
         "OrganizationUnits": [ "string" ],
         "Regions": [ "string" ],
         "ReportTemplate": "string"
      }
   }
}
```

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

 ** [ReportPlan](#API_DescribeReportPlan_ResponseSyntax) **   <a name="Backup-DescribeReportPlan-response-ReportPlan"></a>
Retorna detalhes sobre o plano de relatório especificado por seu nome. Esses detalhes incluem o Nome do recurso da Amazon (ARN) do plano de relatório, a descrição, as configurações, o canal de entrega, o status da implantação, o horário de criação, última tentativa dos tempos de execução e os tempos de execução com êxito.  
Tipo: objeto [ReportPlan](API_ReportPlan.md)

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

 ** 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_DescribeReportPlan_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/DescribeReportPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeReportPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeReportPlan) 

# DescribeRestoreJob
<a name="API_DescribeRestoreJob"></a>

Retorna metadados associados a um trabalho de restauração especificado por um ID de trabalho.

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

```
GET /restore-jobs/restoreJobId HTTP/1.1
```

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

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

 ** [restoreJobId](#API_DescribeRestoreJob_RequestSyntax) **   <a name="Backup-DescribeRestoreJob-request-uri-RestoreJobId"></a>
Identifica de forma exclusiva o trabalho que restaura um ponto de recuperação.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "AccountId": "string",
   "BackupSizeInBytes": number,
   "BackupVaultArn": "string",
   "CompletionDate": number,
   "CreatedBy": { 
      "RestoreTestingPlanArn": "string"
   },
   "CreatedResourceArn": "string",
   "CreationDate": number,
   "DeletionStatus": "string",
   "DeletionStatusMessage": "string",
   "ExpectedCompletionTimeMinutes": number,
   "IamRoleArn": "string",
   "IsParent": boolean,
   "ParentJobId": "string",
   "PercentDone": "string",
   "RecoveryPointArn": "string",
   "RecoveryPointCreationDate": number,
   "ResourceType": "string",
   "RestoreJobId": "string",
   "SourceResourceArn": "string",
   "Status": "string",
   "StatusMessage": "string",
   "ValidationStatus": "string",
   "ValidationStatusMessage": "string"
}
```

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

 ** [AccountId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-AccountId"></a>
Retorna o ID da conta da que é proprietária do trabalho de restauração.  
Tipo: sequência  
Padrão: `^[0-9]{12}$` 

 ** [BackupSizeInBytes](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupSizeInBytes"></a>
O tamanho, em bytes, do recurso restaurado.  
Tipo: longo

 ** [BackupVaultArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-BackupVaultArn"></a>
O nome do recurso da Amazon (ARN) do cofre de backup que contém o ponto de recuperação que está sendo restaurado. Isso ajuda a identificar permissões e políticas de acesso ao cofre.  
Tipo: string

 ** [CompletionDate](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CompletionDate"></a>
A data e a hora em que um trabalho para restaurar um ponto de recuperação foi concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CompletionDate` 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

 ** [CreatedBy](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreatedBy"></a>
Contém informações de identificação sobre a criação de um trabalho de restauração.  
Tipo: objeto [RestoreJobCreator](API_RestoreJobCreator.md)

 ** [CreatedResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreatedResourceArn"></a>
O nome do recurso da Amazon (ARN) do recurso que foi criado pelo trabalho de restauração.  
O formato do ARN depende do tipo de recurso que está tendo o backup feito.  
Tipo: string

 ** [CreationDate](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-CreationDate"></a>
A data e hora em que a lista de domínios foi criada, 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

 ** [DeletionStatus](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-DeletionStatus"></a>
O status dos dados gerados pelo teste de restauração.  
Tipo: string  
Valores válidos: `DELETING | FAILED | SUCCESSFUL` 

 ** [DeletionStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-DeletionStatusMessage"></a>
Isso descreve o status de exclusão do trabalho de restauração.  
Tipo: string

 ** [ExpectedCompletionTimeMinutes](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ExpectedCompletionTimeMinutes"></a>
A quantidade de tempo, em minutos, que se espera que um trabalho de restauração de um ponto de recuperação leve.  
Tipo: longo

 ** [IamRoleArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-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

 ** [IsParent](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-IsParent"></a>
Esse é um valor booleano que indica se o trabalho de restauração é um trabalho de restauração principal (composto).  
Tipo: booliano

 ** [ParentJobId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ParentJobId"></a>
Esse é o identificador exclusivo da tarefa de restauração principal da tarefa de restauração selecionada.  
Tipo: string

 ** [PercentDone](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-PercentDone"></a>
Contém uma porcentagem estimada de conclusão de um trabalho no momento em que o status do trabalho foi consultado.  
Tipo: string

 ** [RecoveryPointArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RecoveryPointArn"></a>
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

 ** [RecoveryPointCreationDate](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RecoveryPointCreationDate"></a>
A data de criação do ponto de recuperação criado pelo trabalho de restauração especificado.  
Tipo: Timestamp

 ** [ResourceType](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ResourceType"></a>
Retorna metadados associados a um trabalho de restauração listado por tipo de recurso.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [RestoreJobId](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-RestoreJobId"></a>
Identifica de forma exclusiva o trabalho que restaura um ponto de recuperação.  
Tipo: string

 ** [SourceResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-SourceResourceArn"></a>
O nome do recurso da Amazon (ARN) do recurso original do qual foi feito backup. Isso fornece contexto sobre qual recurso está sendo restaurado.  
Tipo: string

 ** [Status](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-Status"></a>
Código de status que especifica o estado do trabalho que é iniciado AWS Backup para restaurar um ponto de recuperação.  
Tipo: string  
Valores válidos: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED` 

 ** [StatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-StatusMessage"></a>
Uma mensagem mostrando o status de um trabalho para restaurar um ponto de recuperação.  
Tipo: string

 ** [ValidationStatus](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ValidationStatus"></a>
O status da validação executada no trabalho de restauração indicado.  
Tipo: string  
Valores válidos: `FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING` 

 ** [ValidationStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **   <a name="Backup-DescribeRestoreJob-response-ValidationStatusMessage"></a>
A mensagem de status.  
Tipo: string

## Erros
<a name="API_DescribeRestoreJob_Errors"></a>

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

 ** DependencyFailureException **   
Um AWS serviço ou recurso dependente retornou um erro ao AWS Backup serviço e a ação não pode ser concluída.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 500

 ** 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

 ** 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_DescribeRestoreJob_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/DescribeRestoreJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeRestoreJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeRestoreJob) 

# DescribeScanJob
<a name="API_DescribeScanJob"></a>

Retorna os detalhes do trabalho de digitalização para a ScanJob ID especificada.

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

```
GET /scan/jobs/ScanJobId HTTP/1.1
```

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

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

 ** [ScanJobId](#API_DescribeScanJob_RequestSyntax) **   <a name="Backup-DescribeScanJob-request-uri-ScanJobId"></a>
Identifica de forma exclusiva uma solicitação para AWS Backup escanear um recurso.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "AccountId": "string",
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CompletionDate": number,
   "CreatedBy": { 
      "BackupPlanArn": "string",
      "BackupPlanId": "string",
      "BackupPlanVersion": "string",
      "BackupRuleId": "string"
   },
   "CreationDate": number,
   "IamRoleArn": "string",
   "MalwareScanner": "string",
   "RecoveryPointArn": "string",
   "ResourceArn": "string",
   "ResourceName": "string",
   "ResourceType": "string",
   "ScanBaseRecoveryPointArn": "string",
   "ScanId": "string",
   "ScanJobId": "string",
   "ScanMode": "string",
   "ScannerRoleArn": "string",
   "ScanResult": { 
      "ScanResultStatus": "string"
   },
   "State": "string",
   "StatusMessage": "string"
}
```

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

 ** [AccountId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-AccountId"></a>
Retorna o ID da conta que é proprietária do trabalho de digitalização.  
Padrão: `^[0-9]{12}$`   
Tipo: string

 ** [BackupVaultArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-BackupVaultArn"></a>
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup; por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`   
Tipo: string

 ** [BackupVaultName](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-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 exclusivos da conta usada para criá-los e da AWS região em que foram criados.  
Padrão: `^[a-zA-Z0-9\-\_\.]{2,50}$`   
Tipo: string

 ** [CompletionDate](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CompletionDate"></a>
A data e hora em que um índice de backup concluiu a criação, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CompletionDate` 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

 ** [CreatedBy](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CreatedBy"></a>
Contém informações de identificação sobre a criação de uma tarefa de verificação, incluindo o plano de backup e a regra que iniciaram a verificação.  
Tipo: objeto [ScanJobCreator](API_ScanJobCreator.md)

 ** [CreationDate](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-CreationDate"></a>
A data e hora em que um índice de backup concluiu a criação, 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

 ** [IamRoleArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-IamRoleArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup, por exemplo, `arn:aws:iam::123456789012:role/S3Access`.  
Tipo: string

 ** [MalwareScanner](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-MalwareScanner"></a>
O mecanismo de escaneamento usado para o trabalho de escaneamento correspondente. No momento, somente `GUARDUTY` é compatível.  
Tipo: string  
Valores válidos: `GUARDDUTY` 

 ** [RecoveryPointArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-RecoveryPointArn"></a>
Um ARN que identifica de forma exclusiva o ponto de recuperação de destino para digitalização.; por exemplo,. `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`  
Tipo: string

 ** [ResourceArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceArn"></a>
Um ARN que identifica de forma exclusiva o recurso de origem do ARN do ponto de recuperação correspondente.  
Tipo: string

 ** [ResourceName](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceName"></a>
O nome não exclusivo do recurso que pertence ao backup especificado.  
Tipo: string

 ** [ResourceType](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ResourceType"></a>
O tipo de AWS recurso a ser copiado; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS).  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
Tipo: string  
Valores válidos: `EBS | EC2 | S3` 

 ** [ScanBaseRecoveryPointArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanBaseRecoveryPointArn"></a>
Um ARN que identifica de forma exclusiva o ponto de recuperação básico para digitalização. Esse campo só será preenchido quando um trabalho de verificação incremental tiver ocorrido.  
Tipo: string

 ** [ScanId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanId"></a>
O ID de escaneamento gerado pela Amazon GuardDuty para a solicitação de Scan Job ID correspondente de AWS Backup.  
Tipo: string

 ** [ScanJobId](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanJobId"></a>
O ID do trabalho de digitalização que identificou de forma exclusiva a solicitação para. AWS Backup  
Tipo: string

 ** [ScanMode](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanMode"></a>
Especifica o tipo de escaneamento usado para o trabalho de escaneamento.  
Tipo: string  
Valores válidos: `FULL_SCAN | INCREMENTAL_SCAN` 

 ** [ScannerRoleArn](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScannerRoleArn"></a>
Especifica a função do IAM do scanner que o ARN usa para o trabalho de digitalização.  
Tipo: string

 ** [ScanResult](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-ScanResult"></a>
 Contém o `ScanResultsStatus` para o trabalho de digitalização e devoluções `THREATS_FOUND` ou `NO_THREATS_FOUND` para trabalhos concluídos.  
Tipo: objeto [ScanResultInfo](API_ScanResultInfo.md)

 ** [State](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-State"></a>
O estado atual de um trabalho de digitalização.  
Tipo: string  
Valores válidos: `CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING` 

 ** [StatusMessage](#API_DescribeScanJob_ResponseSyntax) **   <a name="Backup-DescribeScanJob-response-StatusMessage"></a>
Uma mensagem detalhada explicando o status do trabalho para fazer backup de um recurso.  
Tipo: string

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

 ** 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_DescribeScanJob_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/DescribeScanJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DescribeScanJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DescribeScanJob) 

# DisassociateBackupVaultMpaApprovalTeam
<a name="API_DisassociateBackupVaultMpaApprovalTeam"></a>

Remove a associação entre uma equipe de aprovação MPA e um cofre de backup, desativando o fluxo de trabalho de aprovação MPA para operações de restauração.

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

```
POST /backup-vaults/backupVaultName/mpaApprovalTeam?delete HTTP/1.1
Content-type: application/json

{
   "RequesterComment": "string"
}
```

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

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

 ** [backupVaultName](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-DisassociateBackupVaultMpaApprovalTeam-request-uri-BackupVaultName"></a>
O nome do cofre de backup do qual equipe de aprovação MPA deve ser desassociada.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

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

 ** [RequesterComment](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **   <a name="Backup-DisassociateBackupVaultMpaApprovalTeam-request-RequesterComment"></a>
Um comentário opcional explicando o motivo da desassociação da equipe de aprovação MPA do cofre de backup.  
Tipo: string  
Obrigatório: não

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

```
HTTP/1.1 204
```

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

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

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

 ** 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_DisassociateBackupVaultMpaApprovalTeam_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/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DisassociateBackupVaultMpaApprovalTeam) 

# DisassociateRecoveryPoint
<a name="API_DisassociateRecoveryPoint"></a>

Exclui o ponto de recuperação de backup contínuo especificado AWS Backup e libera o controle desse backup contínuo para o serviço de origem, como o Amazon RDS. O serviço de origem continuará criando e retendo backups contínuos usando o ciclo de vida que você especificou em seu plano de backup original.

Não é compatível com pontos de recuperação de backup de snapshots.

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

```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/disassociate HTTP/1.1
```

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

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

 ** [backupVaultName](#API_DisassociateRecoveryPoint_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPoint-request-uri-BackupVaultName"></a>
O nome exclusivo de um AWS Backup cofre.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [recoveryPointArn](#API_DisassociateRecoveryPoint_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPoint-request-uri-RecoveryPointArn"></a>
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva um ponto de recuperação. AWS Backup   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_DisassociateRecoveryPoint_ResponseElements"></a>

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

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

 ** InvalidResourceStateException **   
 AWS Backup já está executando uma ação nesse ponto de recuperação. Ele não pode realizar a ação solicitada até que a primeira ação seja concluída. Tente novamente mais tarde.    
 ** 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_DisassociateRecoveryPoint_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/DisassociateRecoveryPoint) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DisassociateRecoveryPoint) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DisassociateRecoveryPoint) 

# DisassociateRecoveryPointFromParent
<a name="API_DisassociateRecoveryPointFromParent"></a>

Essa ação para um ponto de recuperação filho específico (aninhado) remove o relacionamento entre o ponto de recuperação especificado e seu ponto de recuperação pai (composto).

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

```
DELETE /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/parentAssociation HTTP/1.1
```

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

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

 ** [backupVaultName](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPointFromParent-request-uri-BackupVaultName"></a>
O nome de um contêiner lógico no qual o ponto de recuperação filho (aninhado) é armazenado. Os cofres de backup são identificados por nomes exclusivos da conta usada para criá-los e da AWS região em que foram criados.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [recoveryPointArn](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **   <a name="Backup-DisassociateRecoveryPointFromParent-request-uri-RecoveryPointArn"></a>
O nome do recurso da Amazon (ARN) que identifica de forma exclusiva o ponto de recuperação filho (aninhado). Por exemplo, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 204
```

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

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

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

 ** 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_DisassociateRecoveryPointFromParent_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/DisassociateRecoveryPointFromParent) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/DisassociateRecoveryPointFromParent) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DisassociateRecoveryPointFromParent) 

# ExportBackupPlanTemplate
<a name="API_ExportBackupPlanTemplate"></a>

Retorna o plano de backup especificado pelo ID do plano como um modelo de backup.

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

```
GET /backup/plans/backupPlanId/toTemplate/ HTTP/1.1
```

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

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

 ** [backupPlanId](#API_ExportBackupPlanTemplate_RequestSyntax) **   <a name="Backup-ExportBackupPlanTemplate-request-uri-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupPlanTemplateJson": "string"
}
```

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

 ** [BackupPlanTemplateJson](#API_ExportBackupPlanTemplate_ResponseSyntax) **   <a name="Backup-ExportBackupPlanTemplate-response-BackupPlanTemplateJson"></a>
O corpo de um modelo de plano de backup no formato JSON.  
Isso é um documento JSON assinado que não pode ser modificado antes de ser passado para `GetBackupPlanFromJSON.` 
Tipo: string

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

 ** 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_ExportBackupPlanTemplate_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/ExportBackupPlanTemplate) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ExportBackupPlanTemplate) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ExportBackupPlanTemplate) 

# GetBackupPlan
<a name="API_GetBackupPlan"></a>

Retorna detalhes do `BackupPlan` do `BackupPlanId` especificado. Os detalhes são o corpo de um plano de backup no formato JSON, além dos metadados do plano.

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

```
GET /backup/plans/backupPlanId/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&versionId=VersionId HTTP/1.1
```

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

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

 ** [backupPlanId](#API_GetBackupPlan_RequestSyntax) **   <a name="Backup-GetBackupPlan-request-uri-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Obrigatório: Sim

 ** [MaxScheduledRunsPreview](#API_GetBackupPlan_RequestSyntax) **   <a name="Backup-GetBackupPlan-request-uri-MaxScheduledRunsPreview"></a>
Número de futuras execuções de backup programadas para prévia. Quando definido como 0 (padrão), nenhuma prévia de execuções programadas é incluída na resposta. O intervalo válido é de 0 a 10.  
Intervalo válido: valor mínimo de 0. Valor máximo de 10.

 ** [VersionId](#API_GetBackupPlan_RequestSyntax) **   <a name="Backup-GetBackupPlan-request-uri-VersionId"></a>
Strings Unicode exclusivas geradas aleatoriamente, codificadas em UTF-8 que têm no máximo 1.024 bytes. A versão IDs não pode ser editada.

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

Essa solicitação não tem corpo.

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

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

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   },
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "CreatorRequestId": "string",
   "DeletionDate": number,
   "LastExecutionDate": number,
   "ScheduledRunsPreview": [ 
      { 
         "ExecutionTime": number,
         "RuleExecutionType": "string",
         "RuleId": "string"
      }
   ],
   "VersionId": "string"
}
```

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

 ** [AdvancedBackupSettings](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-AdvancedBackupSettings"></a>
Contém uma lista de `BackupOptions` para cada tipo de recurso. A lista será preenchida somente se a opção avançada estiver definida para o plano de backup.  
Tipo: matriz de objetos [AdvancedBackupSetting](API_AdvancedBackupSetting.md)

 ** [BackupPlan](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-BackupPlan"></a>
Especifica o corpo de um plano de backup. Inclui um `BackupPlanName` e um ou mais conjuntos de `Rules`.  
Tipo: objeto [BackupPlan](API_BackupPlan.md)

 ** [BackupPlanArn](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-BackupPlanArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um plano de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.  
Tipo: string

 ** [BackupPlanId](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Tipo: string

 ** [CreationDate](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-CreationDate"></a>
A data e hora em que o plano de backup foi criado, em formato de hora 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

 ** [CreatorRequestId](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-CreatorRequestId"></a>
Uma string que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes.   
Tipo: string

 ** [DeletionDate](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-DeletionDate"></a>
A data e hora em que um plano de backup foi excluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `DeletionDate` 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

 ** [LastExecutionDate](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-LastExecutionDate"></a>
A última vez que esse plano de backup foi executado. A data e a hora devem estar em formato Unix e UTC (Tempo Universal Coordenado). O valor de `LastExecutionDate` 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

 ** [ScheduledRunsPreview](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-ScheduledRunsPreview"></a>
Lista das próximas execuções de backup programadas. A inclusão só é feita quando o parâmetro `MaxScheduledRunsPreview` é maior que 0. Contém até 10 futuras execuções de backup com seus horários programados, tipos de execução e regras IDs associadas.  
Tipo: matriz de objetos [ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md)

 ** [VersionId](#API_GetBackupPlan_ResponseSyntax) **   <a name="Backup-GetBackupPlan-response-VersionId"></a>
Strings Unicode exclusivas geradas aleatoriamente, codificadas em UTF-8 que têm no máximo 1.024 bytes. A versão IDs não pode ser editada.  
Tipo: string

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

 ** 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_GetBackupPlan_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/GetBackupPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetBackupPlan) 

# GetBackupPlanFromJSON
<a name="API_GetBackupPlanFromJSON"></a>

Retorna um documento JSON válido especificando um plano de backup ou um erro.

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

```
POST /backup/template/json/toPlan HTTP/1.1
Content-type: application/json

{
   "BackupPlanTemplateJson": "string"
}
```

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

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

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

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

 ** [BackupPlanTemplateJson](#API_GetBackupPlanFromJSON_RequestSyntax) **   <a name="Backup-GetBackupPlanFromJSON-request-BackupPlanTemplateJson"></a>
Um documento de plano de backup fornecido pelo cliente no formato JSON.  
Tipo: String  
Obrigatório: sim

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

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

{
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   }
}
```

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

 ** [BackupPlan](#API_GetBackupPlanFromJSON_ResponseSyntax) **   <a name="Backup-GetBackupPlanFromJSON-response-BackupPlan"></a>
Especifica o corpo de um plano de backup. Inclui um `BackupPlanName` e um ou mais conjuntos de `Rules`.  
Tipo: objeto [BackupPlan](API_BackupPlan.md)

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

 ** 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_GetBackupPlanFromJSON_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/GetBackupPlanFromJSON) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupPlanFromJSON) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetBackupPlanFromJSON) 

# GetBackupPlanFromTemplate
<a name="API_GetBackupPlanFromTemplate"></a>

Retorna o modelo especificado por seu `templateId` como um plano de backup.

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

```
GET /backup/template/plans/templateId/toPlan HTTP/1.1
```

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

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

 ** [templateId](#API_GetBackupPlanFromTemplate_RequestSyntax) **   <a name="Backup-GetBackupPlanFromTemplate-request-uri-BackupPlanTemplateId"></a>
Identifica de forma exclusiva um modelo de plano de backup armazenado.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupPlanDocument": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleId": "string",
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   }
}
```

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

 ** [BackupPlanDocument](#API_GetBackupPlanFromTemplate_ResponseSyntax) **   <a name="Backup-GetBackupPlanFromTemplate-response-BackupPlanDocument"></a>
Retorna o corpo de um plano de backup com base no modelo de destino, incluindo o nome, as regras e o cofre de backup do plano.  
Tipo: objeto [BackupPlan](API_BackupPlan.md)

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

 ** 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_GetBackupPlanFromTemplate_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/GetBackupPlanFromTemplate) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupPlanFromTemplate) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetBackupPlanFromTemplate) 

# GetBackupSelection
<a name="API_GetBackupSelection"></a>

Retorna metadados de seleção e um documento no formato JSON que especifica uma lista de recursos associados a um plano de backup.

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

```
GET /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
```

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

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

 ** [backupPlanId](#API_GetBackupSelection_RequestSyntax) **   <a name="Backup-GetBackupSelection-request-uri-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Obrigatório: Sim

 ** [selectionId](#API_GetBackupSelection_RequestSyntax) **   <a name="Backup-GetBackupSelection-request-uri-SelectionId"></a>
Identifica de forma exclusiva uma solicitação para atribuir um conjunto de recursos a um plano de backup.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupPlanId": "string",
   "BackupSelection": { 
      "Conditions": { 
         "StringEquals": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringLike": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ],
         "StringNotLike": [ 
            { 
               "ConditionKey": "string",
               "ConditionValue": "string"
            }
         ]
      },
      "IamRoleArn": "string",
      "ListOfTags": [ 
         { 
            "ConditionKey": "string",
            "ConditionType": "string",
            "ConditionValue": "string"
         }
      ],
      "NotResources": [ "string" ],
      "Resources": [ "string" ],
      "SelectionName": "string"
   },
   "CreationDate": number,
   "CreatorRequestId": "string",
   "SelectionId": "string"
}
```

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

 ** [BackupPlanId](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Tipo: string

 ** [BackupSelection](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-BackupSelection"></a>
Especifica o corpo de uma solicitação para atribuir um conjunto de recursos a um plano de backup.  
Tipo: objeto [BackupSelection](API_BackupSelection.md)

 ** [CreationDate](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-CreationDate"></a>
A data e hora em que uma seleção de backup foi criada, 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

 ** [CreatorRequestId](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-CreatorRequestId"></a>
Uma string que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes.  
Tipo: string

 ** [SelectionId](#API_GetBackupSelection_ResponseSyntax) **   <a name="Backup-GetBackupSelection-response-SelectionId"></a>
Identifica de forma exclusiva uma solicitação para atribuir um conjunto de recursos a um plano de backup.  
Tipo: string

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

 ** 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_GetBackupSelection_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/GetBackupSelection) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupSelection) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetBackupSelection) 

# GetBackupVaultAccessPolicy
<a name="API_GetBackupVaultAccessPolicy"></a>

Retorna o documento de política de acesso associado ao cofre de backup nomeado.

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

```
GET /backup-vaults/backupVaultName/access-policy HTTP/1.1
```

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

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

 ** [backupVaultName](#API_GetBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-GetBackupVaultAccessPolicy-request-uri-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.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "Policy": "string"
}
```

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

 ** [BackupVaultArn](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **   <a name="Backup-GetBackupVaultAccessPolicy-response-BackupVaultArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: string

 ** [BackupVaultName](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **   <a name="Backup-GetBackupVaultAccessPolicy-response-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 em que são criados.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [Policy](#API_GetBackupVaultAccessPolicy_ResponseSyntax) **   <a name="Backup-GetBackupVaultAccessPolicy-response-Policy"></a>
O documento da política de acesso ao cofre de backup no formato JSON.  
Tipo: string

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

 ** 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_GetBackupVaultAccessPolicy_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/GetBackupVaultAccessPolicy) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupVaultAccessPolicy) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetBackupVaultAccessPolicy) 

# GetBackupVaultNotifications
<a name="API_GetBackupVaultNotifications"></a>

Exclui as notificações de eventos para o cofre de backup especificado.

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

```
GET /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
```

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

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

 ** [backupVaultName](#API_GetBackupVaultNotifications_RequestSyntax) **   <a name="Backup-GetBackupVaultNotifications-request-uri-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.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultEvents": [ "string" ],
   "BackupVaultName": "string",
   "SNSTopicArn": "string"
}
```

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

 ** [BackupVaultArn](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-BackupVaultArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: string

 ** [BackupVaultEvents](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-BackupVaultEvents"></a>
Uma matriz de eventos que indicam o status de trabalhos para recursos de backup para o cofre de backup.  
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 | CONTINUOUS_BACKUP_INTERRUPTED | RECOVERY_POINT_INDEX_COMPLETED | RECOVERY_POINT_INDEX_DELETED | RECOVERY_POINT_INDEXING_FAILED` 

 ** [BackupVaultName](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-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 em que são criados.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [SNSTopicArn](#API_GetBackupVaultNotifications_ResponseSyntax) **   <a name="Backup-GetBackupVaultNotifications-response-SNSTopicArn"></a>
Um ARN que identifica de forma exclusiva um tópico do Amazon Simple Notification Service (Amazon SNS); por exemplo, `arn:aws:sns:us-west-2:111122223333:MyTopic`.  
Tipo: string

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

 ** 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_GetBackupVaultNotifications_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/GetBackupVaultNotifications) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetBackupVaultNotifications) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetBackupVaultNotifications) 

# GetLegalHold
<a name="API_GetLegalHold"></a>

Essa ação retorna detalhes de uma retenção legal especificada. Os detalhes são o corpo de uma retenção legal no formato JSON, além dos metadados.

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

```
GET /legal-holds/legalHoldId/ HTTP/1.1
```

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

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

 ** [legalHoldId](#API_GetLegalHold_RequestSyntax) **   <a name="Backup-GetLegalHold-request-uri-LegalHoldId"></a>
O ID da retenção legal.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "CancelDescription": "string",
   "CancellationDate": number,
   "CreationDate": number,
   "Description": "string",
   "LegalHoldArn": "string",
   "LegalHoldId": "string",
   "RecoveryPointSelection": { 
      "DateRange": { 
         "FromDate": number,
         "ToDate": number
      },
      "ResourceIdentifiers": [ "string" ],
      "VaultNames": [ "string" ]
   },
   "RetainRecordUntil": number,
   "Status": "string",
   "Title": "string"
}
```

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

 ** [CancelDescription](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CancelDescription"></a>
O motivo da remoção da retenção legal.  
Tipo: string

 ** [CancellationDate](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CancellationDate"></a>
Hora em formato numérico em que a retenção legal foi cancelada.  
Tipo: Timestamp

 ** [CreationDate](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CreationDate"></a>
A hora em que a retenção legal foi criada.  
Tipo: Timestamp

 ** [Description](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-Description"></a>
A descrição da string da retenção legal.  
Tipo: string

 ** [LegalHoldArn](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-LegalHoldArn"></a>
O ARN do framework da retenção legal especificada. O formato do ARN depende do tipo de recurso.  
Tipo: string

 ** [LegalHoldId](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-LegalHoldId"></a>
O ID da retenção legal.  
Tipo: string

 ** [RecoveryPointSelection](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-RecoveryPointSelection"></a>
Os critérios para atribuir um conjunto de recursos, como tipos de recursos ou cofres de backup.  
Tipo: objeto [RecoveryPointSelection](API_RecoveryPointSelection.md)

 ** [RetainRecordUntil](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-RetainRecordUntil"></a>
A data e a hora até as quais o registro da retenção legal será retido.  
Tipo: Timestamp

 ** [Status](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-Status"></a>
O status da retenção legal.  
Tipo: string  
Valores válidos: `CREATING | ACTIVE | CANCELING | CANCELED` 

 ** [Title](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-Title"></a>
O título da retenção legal.  
Tipo: string

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

 ** 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_GetLegalHold_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/GetLegalHold) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetLegalHold) 

# GetRecoveryPointIndexDetails
<a name="API_GetRecoveryPointIndexDetails"></a>

Essa operação retorna os metadados e os detalhes específicos do índice de backup associado ao ponto de recuperação especificado.

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

```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/index HTTP/1.1
```

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

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

 ** [backupVaultName](#API_GetRecoveryPointIndexDetails_RequestSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-request-uri-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 em que são criados.  
Os caracteres aceitos incluem letras minúsculas, números e hifens.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [recoveryPointArn](#API_GetRecoveryPointIndexDetails_RequestSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-request-uri-RecoveryPointArn"></a>
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`.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupVaultArn": "string",
   "IndexCompletionDate": number,
   "IndexCreationDate": number,
   "IndexDeletionDate": number,
   "IndexStatus": "string",
   "IndexStatusMessage": "string",
   "RecoveryPointArn": "string",
   "SourceResourceArn": "string",
   "TotalItemsIndexed": number
}
```

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

 ** [BackupVaultArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-BackupVaultArn"></a>
Um ARN que identifica de forma exclusiva o cofre de backup no qual o índice do ponto de recuperação está armazenado.  
Por exemplo, .`arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`  
Tipo: string

 ** [IndexCompletionDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexCompletionDate"></a>
A data e hora em que um índice de backup concluiu a criação, 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

 ** [IndexCreationDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexCreationDate"></a>
A data e hora em que um índice 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

 ** [IndexDeletionDate](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexDeletionDate"></a>
A data e hora em que um índice de backup foi excluído, 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

 ** [IndexStatus](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexStatus"></a>
Esse é o status atual do índice de backup associado ao ponto de recuperação especificado.  
Os status são: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
Um ponto de recuperação com um índice que possui o status de `ACTIVE` pode ser incluído em uma pesquisa.  
Tipo: string  
Valores válidos: `PENDING | ACTIVE | FAILED | DELETING` 

 ** [IndexStatusMessage](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-IndexStatusMessage"></a>
Uma mensagem detalhada explicando o status do índice de backup associado ao ponto de recuperação.  
Tipo: string

 ** [RecoveryPointArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-RecoveryPointArn"></a>
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

 ** [SourceResourceArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-SourceResourceArn"></a>
Uma string do nome do recurso da Amazon (ARN) que identifica de forma exclusiva um recurso de origem.  
Tipo: string

 ** [TotalItemsIndexed](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **   <a name="Backup-GetRecoveryPointIndexDetails-response-TotalItemsIndexed"></a>
Contagem de itens no índice de backup associado ao ponto de recuperação.  
Tipo: longo

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

 ** 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_GetRecoveryPointIndexDetails_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/GetRecoveryPointIndexDetails) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRecoveryPointIndexDetails) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRecoveryPointIndexDetails) 

# GetRecoveryPointRestoreMetadata
<a name="API_GetRecoveryPointRestoreMetadata"></a>

Retorna um conjunto de pares de chave/valor de metadados que foram usados para criar o backup.

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

```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/restore-metadata?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```

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

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

 ** [BackupVaultAccountId](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-request-uri-BackupVaultAccountId"></a>
O ID da conta do cofre de backup especificado.  
Padrão: `^[0-9]{12}$` 

 ** [backupVaultName](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-request-uri-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.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [recoveryPointArn](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-request-uri-RecoveryPointArn"></a>
Um Nome do recurso da Amazon (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`.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupVaultArn": "string",
   "RecoveryPointArn": "string",
   "ResourceType": "string",
   "RestoreMetadata": { 
      "string" : "string" 
   }
}
```

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

 ** [BackupVaultArn](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-BackupVaultArn"></a>
Um ARN que identifica de forma exclusiva um cofre de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: string

 ** [RecoveryPointArn](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-RecoveryPointArn"></a>
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

 ** [ResourceType](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-ResourceType"></a>
O tipo de recurso do ponto de recuperação.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [RestoreMetadata](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **   <a name="Backup-GetRecoveryPointRestoreMetadata-response-RestoreMetadata"></a>
O conjunto de pares de chave/valor de metadados que descrevem a configuração original do recurso que teve o backup feito. Esses valores variam dependendo do serviço que está sendo restaurado.  
Tipo: mapa de string para string

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

 ** 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_GetRecoveryPointRestoreMetadata_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/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRecoveryPointRestoreMetadata) 

# GetRestoreJobMetadata
<a name="API_GetRestoreJobMetadata"></a>

Essa solicitação retorna os metadados do trabalho de restauração especificado.

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

```
GET /restore-jobs/restoreJobId/metadata HTTP/1.1
```

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

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

 ** [restoreJobId](#API_GetRestoreJobMetadata_RequestSyntax) **   <a name="Backup-GetRestoreJobMetadata-request-uri-RestoreJobId"></a>
Esse é um identificador exclusivo de um trabalho de restauração interno AWS Backup.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "Metadata": { 
      "string" : "string" 
   },
   "RestoreJobId": "string"
}
```

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

 ** [Metadata](#API_GetRestoreJobMetadata_ResponseSyntax) **   <a name="Backup-GetRestoreJobMetadata-response-Metadata"></a>
Contém os metadados do trabalho de backup especificado.  
Tipo: mapa de string para string

 ** [RestoreJobId](#API_GetRestoreJobMetadata_ResponseSyntax) **   <a name="Backup-GetRestoreJobMetadata-response-RestoreJobId"></a>
Esse é um identificador exclusivo de um trabalho de restauração interno AWS Backup.  
Tipo: string

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

 ** 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_GetRestoreJobMetadata_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/GetRestoreJobMetadata) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRestoreJobMetadata) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRestoreJobMetadata) 

# GetRestoreTestingInferredMetadata
<a name="API_GetRestoreTestingInferredMetadata"></a>

Essa solicitação retorna o conjunto mínimo de metadados necessário para iniciar um trabalho de restauração com configurações padrão seguras. `BackupVaultName` e `RecoveryPointArn` são parâmetros obrigatórios. `BackupVaultAccountId` é um parâmetro opcional.

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

```
GET /restore-testing/inferred-metadata?BackupVaultAccountId=BackupVaultAccountId&BackupVaultName=BackupVaultName&RecoveryPointArn=RecoveryPointArn HTTP/1.1
```

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

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

 ** [BackupVaultAccountId](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-request-uri-BackupVaultAccountId"></a>
O ID da conta do cofre de backup especificado.

 ** [BackupVaultName](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-request-uri-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 exclusivos da conta usada para criá-los e da AWS região em que foram criados. Eles consistem em letras, números e hifens.  
Obrigatório: Sim

 ** [RecoveryPointArn](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-request-uri-RecoveryPointArn"></a>
Um Nome do recurso da Amazon (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`.   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "InferredMetadata": { 
      "string" : "string" 
   }
}
```

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

 ** [InferredMetadata](#API_GetRestoreTestingInferredMetadata_ResponseSyntax) **   <a name="Backup-GetRestoreTestingInferredMetadata-response-InferredMetadata"></a>
Isso é um mapa de strings dos metadados inferidos da solicitação.  
Tipo: mapa de string para string

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

 ** 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_GetRestoreTestingInferredMetadata_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/GetRestoreTestingInferredMetadata) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRestoreTestingInferredMetadata) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRestoreTestingInferredMetadata) 

# GetRestoreTestingPlan
<a name="API_GetRestoreTestingPlan"></a>

Retorna detalhes do `RestoreTestingPlan` do `RestoreTestingPlanName` especificado. Os detalhes são o corpo de um plano de testes de restauração no formato JSON, além dos metadados do plano.

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

```
GET /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
```

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

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

 ** [RestoreTestingPlanName](#API_GetRestoreTestingPlan_RequestSyntax) **   <a name="Backup-GetRestoreTestingPlan-request-uri-RestoreTestingPlanName"></a>
Nome exclusivo obrigatório do plano de testes de restauração.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "RestoreTestingPlan": { 
      "CreationTime": number,
      "CreatorRequestId": "string",
      "LastExecutionTime": number,
      "LastUpdateTime": number,
      "RecoveryPointSelection": { 
         "Algorithm": "string",
         "ExcludeVaults": [ "string" ],
         "IncludeVaults": [ "string" ],
         "RecoveryPointTypes": [ "string" ],
         "SelectionWindowDays": number
      },
      "RestoreTestingPlanArn": "string",
      "RestoreTestingPlanName": "string",
      "ScheduleExpression": "string",
      "ScheduleExpressionTimezone": "string",
      "StartWindowHours": number
   }
}
```

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

 ** [RestoreTestingPlan](#API_GetRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-GetRestoreTestingPlan-response-RestoreTestingPlan"></a>
Especifica o corpo de um plano de testes de restauração. Inclui `RestoreTestingPlanName`.  
Tipo: objeto [RestoreTestingPlanForGet](API_RestoreTestingPlanForGet.md)

## Erros
<a name="API_GetRestoreTestingPlan_Errors"></a>

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

 ** 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_GetRestoreTestingPlan_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/GetRestoreTestingPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRestoreTestingPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRestoreTestingPlan) 

# GetRestoreTestingSelection
<a name="API_GetRestoreTestingSelection"></a>

Retorna RestoreTestingSelection, que exibe recursos e elementos do plano de teste de restauração.

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

```
GET /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
```

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

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

 ** [RestoreTestingPlanName](#API_GetRestoreTestingSelection_RequestSyntax) **   <a name="Backup-GetRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
Nome exclusivo obrigatório do plano de testes de restauração.  
Obrigatório: Sim

 ** [RestoreTestingSelectionName](#API_GetRestoreTestingSelection_RequestSyntax) **   <a name="Backup-GetRestoreTestingSelection-request-uri-RestoreTestingSelectionName"></a>
Nome exclusivo obrigatório da seleção de testes de restauração.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "RestoreTestingSelection": { 
      "CreationTime": number,
      "CreatorRequestId": "string",
      "IamRoleArn": "string",
      "ProtectedResourceArns": [ "string" ],
      "ProtectedResourceConditions": { 
         "StringEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      },
      "ProtectedResourceType": "string",
      "RestoreMetadataOverrides": { 
         "string" : "string" 
      },
      "RestoreTestingPlanName": "string",
      "RestoreTestingSelectionName": "string",
      "ValidationWindowHours": number
   }
}
```

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

 ** [RestoreTestingSelection](#API_GetRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-GetRestoreTestingSelection-response-RestoreTestingSelection"></a>
Nome exclusivo da seleção de testes de restauração.  
Tipo: objeto [RestoreTestingSelectionForGet](API_RestoreTestingSelectionForGet.md)

## Erros
<a name="API_GetRestoreTestingSelection_Errors"></a>

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

 ** 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_GetRestoreTestingSelection_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/GetRestoreTestingSelection) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetRestoreTestingSelection) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetRestoreTestingSelection) 

# GetSupportedResourceTypes
<a name="API_GetSupportedResourceTypes"></a>

Retorna os tipos de AWS recursos suportados pelo AWS Backup.

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

```
GET /supported-resource-types HTTP/1.1
```

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

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

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

Essa solicitação não tem corpo.

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

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

{
   "ResourceTypes": [ "string" ]
}
```

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

 ** [ResourceTypes](#API_GetSupportedResourceTypes_ResponseSyntax) **   <a name="Backup-GetSupportedResourceTypes-response-ResourceTypes"></a>
Contém uma string com os tipos AWS de recursos compatíveis:  
+  `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
Tipo: matriz de strings  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

## Erros
<a name="API_GetSupportedResourceTypes_Errors"></a>

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

 ** 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_GetSupportedResourceTypes_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/GetSupportedResourceTypes) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetSupportedResourceTypes) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetSupportedResourceTypes) 

# GetTieringConfiguration
<a name="API_GetTieringConfiguration"></a>

Retorna detalhes do `TieringConfiguration` do `TieringConfigurationName` especificado. Os detalhes são o corpo de uma configuração em camadas no formato JSON, além dos metadados de configuração.

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

```
GET /tiering-configurations/tieringConfigurationName HTTP/1.1
```

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

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

 ** [tieringConfigurationName](#API_GetTieringConfiguration_RequestSyntax) **   <a name="Backup-GetTieringConfiguration-request-uri-TieringConfigurationName"></a>
O nome exclusivo de uma configuração hierárquica.  
Padrão: `^[a-zA-Z0-9_]{1,200}$`   
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "TieringConfiguration": { 
      "BackupVaultName": "string",
      "CreationTime": number,
      "CreatorRequestId": "string",
      "LastUpdatedTime": number,
      "ResourceSelection": [ 
         { 
            "Resources": [ "string" ],
            "ResourceType": "string",
            "TieringDownSettingsInDays": number
         }
      ],
      "TieringConfigurationArn": "string",
      "TieringConfigurationName": "string"
   }
}
```

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

 ** [TieringConfiguration](#API_GetTieringConfiguration_ResponseSyntax) **   <a name="Backup-GetTieringConfiguration-response-TieringConfiguration"></a>
Especifica o corpo de uma configuração de camadas. Inclui `TieringConfigurationName`.  
Tipo: objeto [TieringConfiguration](API_TieringConfiguration.md)

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

 ** 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_GetTieringConfiguration_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/GetTieringConfiguration) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetTieringConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetTieringConfiguration) 

# 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) 

# ListBackupJobSummaries
<a name="API_ListBackupJobSummaries"></a>

Essa é uma solicitação para um resumo dos trabalhos de backup criados ou em execução nos últimos 30 dias. Você pode incluir os parâmetros AccountId, State,,, ResourceType, MessageCategory AggregationPeriod MaxResults, NextToken ou para filtrar os resultados.

Essa solicitação retorna um resumo que contém Região, Conta, Estado, ResourceType, MessageCategory, StartTime EndTime, e Contagem dos trabalhos incluídos.

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

```
GET /audit/backup-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```

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

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

 ** [AccountId](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-AccountId"></a>
Retorna a contagem de trabalhos para a conta especificada.  
Se a solicitação for enviada de uma conta de membro ou de uma conta que não faz parte de AWS Organizations, os trabalhos na conta do solicitante serão devolvidos.  
As contas raiz, de administrador e de administrador delegado podem usar o valor ANY para retornar as contagens de trabalhos de todas as contas da organização.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos de todas as contas da organização autenticada e retorna a soma.  
Padrão: `^[0-9]{12}$` 

 ** [AggregationPeriod](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-AggregationPeriod"></a>
O período para os resultados retornados.  
+  `ONE_DAY`: A contagem diária de trabalhos dos últimos 14 dias.
+  `SEVEN_DAYS`: A contagem agregada de trabalhos dos últimos 7 dias.
+  `FOURTEEN_DAYS`: A contagem agregada de trabalhos dos últimos 14 dias.
Valores válidos: `ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS` 

 ** [MaxResults](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-MaxResults"></a>
O número máximo de itens a serem retornados.  
O valor é um inteiro. O intervalo de valores aceitos é de 1 a 500.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [MessageCategory](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-MessageCategory"></a>
Esse parâmetro retorna a contagem de trabalhos para a categoria de mensagem especificada.  
Exemplos de strings aceitas incluem `AccessDenied`, `Success` e `InvalidParameters`. Consulte [Monitoramento](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) para obter uma lista de MessageCategory sequências de caracteres aceitas.  
O valor ANY 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.

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

 ** [ResourceType](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-ResourceType"></a>
Retorna a contagem de trabalhos para o tipo de recurso especificado. Use a solicitação `GetSupportedResourceTypes` a fim de obter as strings para os tipos de recurso compatíveis.  
O valor ANY retorna a contagem de todos os tipos de recurso.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos para todos os tipos de recurso e retorna a soma.  
O tipo de AWS recurso a ser copiado; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS).  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [State](#API_ListBackupJobSummaries_RequestSyntax) **   <a name="Backup-ListBackupJobSummaries-request-uri-State"></a>
Esse parâmetro retorna a contagem dos trabalhos que estão no estado especificado.  
O valor ANY retorna a contagem de todos os estados.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos para todos os estados e retorna a soma.  
 `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:  
OBTENHA /audit/backup-job-summaries? AggregationPeriod=Quatorze\$1dias&state=Concluído  
OBTENHA /audit/backup-job-summaries? AggregationPeriod=FOURTEEN\$1DAYS& MessageCategory =SUCESSO&STATE=Concluído  
Valores válidos: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY` 

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

Essa solicitação não tem corpo.

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

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

{
   "AggregationPeriod": "string",
   "BackupJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MessageCategory": "string",
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [AggregationPeriod](#API_ListBackupJobSummaries_ResponseSyntax) **   <a name="Backup-ListBackupJobSummaries-response-AggregationPeriod"></a>
O período para os resultados retornados.  
+  `ONE_DAY`: A contagem diária de trabalhos dos últimos 14 dias.
+  `SEVEN_DAYS`: A contagem agregada de trabalhos dos últimos 7 dias.
+  `FOURTEEN_DAYS`: A contagem agregada de trabalhos dos últimos 14 dias.
Tipo: string

 ** [BackupJobSummaries](#API_ListBackupJobSummaries_ResponseSyntax) **   <a name="Backup-ListBackupJobSummaries-response-BackupJobSummaries"></a>
As informações resumidas.  
Tipo: matriz de objetos [BackupJobSummary](API_BackupJobSummary.md)

 ** [NextToken](#API_ListBackupJobSummaries_ResponseSyntax) **   <a name="Backup-ListBackupJobSummaries-response-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `MaxResults` de recursos, 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_ListBackupJobSummaries_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_ListBackupJobSummaries_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/ListBackupJobSummaries) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupJobSummaries) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupJobSummaries) 

# ListBackupPlans
<a name="API_ListBackupPlans"></a>

Lista os planos de backup ativos da conta.

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

```
GET /backup/plans/?includeDeleted=IncludeDeleted&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [IncludeDeleted](#API_ListBackupPlans_RequestSyntax) **   <a name="Backup-ListBackupPlans-request-uri-IncludeDeleted"></a>
Um valor booliano com um valor padrão de `FALSE` que retorna os planos de backup excluídos quando definido como `TRUE`.

 ** [MaxResults](#API_ListBackupPlans_RequestSyntax) **   <a name="Backup-ListBackupPlans-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_ListBackupPlans_RequestSyntax) **   <a name="Backup-ListBackupPlans-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_ListBackupPlans_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "BackupPlansList": [ 
      { 
         "AdvancedBackupSettings": [ 
            { 
               "BackupOptions": { 
                  "string" : "string" 
               },
               "ResourceType": "string"
            }
         ],
         "BackupPlanArn": "string",
         "BackupPlanId": "string",
         "BackupPlanName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "DeletionDate": number,
         "LastExecutionDate": number,
         "VersionId": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [BackupPlansList](#API_ListBackupPlans_ResponseSyntax) **   <a name="Backup-ListBackupPlans-response-BackupPlansList"></a>
Informações sobre planos de backup.  
Tipo: matriz de objetos [BackupPlansListMember](API_BackupPlansListMember.md)

 ** [NextToken](#API_ListBackupPlans_ResponseSyntax) **   <a name="Backup-ListBackupPlans-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_ListBackupPlans_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

 ** 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_ListBackupPlans_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/ListBackupPlans) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupPlans) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupPlans) 

# ListBackupPlanTemplates
<a name="API_ListBackupPlanTemplates"></a>

Lista os modelos do plano de backup.

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

```
GET /backup/template/plans?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

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

 ** [NextToken](#API_ListBackupPlanTemplates_RequestSyntax) **   <a name="Backup-ListBackupPlanTemplates-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_ListBackupPlanTemplates_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "BackupPlanTemplatesList": [ 
      { 
         "BackupPlanTemplateId": "string",
         "BackupPlanTemplateName": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [BackupPlanTemplatesList](#API_ListBackupPlanTemplates_ResponseSyntax) **   <a name="Backup-ListBackupPlanTemplates-response-BackupPlanTemplatesList"></a>
Uma matriz de itens da lista de modelos contendo metadados sobre seus modelos salvos.  
Tipo: matriz de objetos [BackupPlanTemplatesListMember](API_BackupPlanTemplatesListMember.md)

 ** [NextToken](#API_ListBackupPlanTemplates_ResponseSyntax) **   <a name="Backup-ListBackupPlanTemplates-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_ListBackupPlanTemplates_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

 ** 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_ListBackupPlanTemplates_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/ListBackupPlanTemplates) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupPlanTemplates) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupPlanTemplates) 

# ListBackupPlanVersions
<a name="API_ListBackupPlanVersions"></a>

Retorna metadados da versão de seus planos de backup, incluindo Amazon Resource Names (ARNs), plano de backup IDs, datas de criação e exclusão, nomes de planos e versão. IDs

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

```
GET /backup/plans/backupPlanId/versions/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [backupPlanId](#API_ListBackupPlanVersions_RequestSyntax) **   <a name="Backup-ListBackupPlanVersions-request-uri-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Obrigatório: Sim

 ** [MaxResults](#API_ListBackupPlanVersions_RequestSyntax) **   <a name="Backup-ListBackupPlanVersions-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_ListBackupPlanVersions_RequestSyntax) **   <a name="Backup-ListBackupPlanVersions-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_ListBackupPlanVersions_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "BackupPlanVersionsList": [ 
      { 
         "AdvancedBackupSettings": [ 
            { 
               "BackupOptions": { 
                  "string" : "string" 
               },
               "ResourceType": "string"
            }
         ],
         "BackupPlanArn": "string",
         "BackupPlanId": "string",
         "BackupPlanName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "DeletionDate": number,
         "LastExecutionDate": number,
         "VersionId": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [BackupPlanVersionsList](#API_ListBackupPlanVersions_ResponseSyntax) **   <a name="Backup-ListBackupPlanVersions-response-BackupPlanVersionsList"></a>
Uma matriz de itens da lista de versões contendo metadados sobre seus planos de backup.  
Tipo: matriz de objetos [BackupPlansListMember](API_BackupPlansListMember.md)

 ** [NextToken](#API_ListBackupPlanVersions_ResponseSyntax) **   <a name="Backup-ListBackupPlanVersions-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_ListBackupPlanVersions_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

 ** 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_ListBackupPlanVersions_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/ListBackupPlanVersions) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupPlanVersions) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupPlanVersions) 

# ListBackupSelections
<a name="API_ListBackupSelections"></a>

Retorna uma matriz contendo metadados dos recursos associados ao plano de backup de destino.

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

```
GET /backup/plans/backupPlanId/selections/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [backupPlanId](#API_ListBackupSelections_RequestSyntax) **   <a name="Backup-ListBackupSelections-request-uri-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Obrigatório: Sim

 ** [MaxResults](#API_ListBackupSelections_RequestSyntax) **   <a name="Backup-ListBackupSelections-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_ListBackupSelections_RequestSyntax) **   <a name="Backup-ListBackupSelections-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_ListBackupSelections_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "BackupSelectionsList": [ 
      { 
         "BackupPlanId": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "IamRoleArn": "string",
         "SelectionId": "string",
         "SelectionName": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [BackupSelectionsList](#API_ListBackupSelections_ResponseSyntax) **   <a name="Backup-ListBackupSelections-response-BackupSelectionsList"></a>
Uma matriz de itens da lista de seleção de backup contendo metadados sobre cada recurso na lista.  
Tipo: matriz de objetos [BackupSelectionsListMember](API_BackupSelectionsListMember.md)

 ** [NextToken](#API_ListBackupSelections_ResponseSyntax) **   <a name="Backup-ListBackupSelections-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_ListBackupSelections_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

 ** 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_ListBackupSelections_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/ListBackupSelections) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupSelections) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupSelections) 

# ListBackupVaults
<a name="API_ListBackupVaults"></a>

Retorna uma lista de contêineres de armazenamento de pontos de recuperação junto com informações sobre eles.

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

```
GET /backup-vaults/?maxResults=MaxResults&nextToken=NextToken&shared=ByShared&vaultType=ByVaultType HTTP/1.1
```

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

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

 ** [ByShared](#API_ListBackupVaults_RequestSyntax) **   <a name="Backup-ListBackupVaults-request-uri-ByShared"></a>
Esse parâmetro classificará a lista de cofres por cofres compartilhados.

 ** [ByVaultType](#API_ListBackupVaults_RequestSyntax) **   <a name="Backup-ListBackupVaults-request-uri-ByVaultType"></a>
Esse parâmetro classificará a lista de cofres por tipo de cofre.  
Valores válidos: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT` 

 ** [MaxResults](#API_ListBackupVaults_RequestSyntax) **   <a name="Backup-ListBackupVaults-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_ListBackupVaults_RequestSyntax) **   <a name="Backup-ListBackupVaults-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_ListBackupVaults_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "BackupVaultList": [ 
      { 
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CreationDate": number,
         "CreatorRequestId": "string",
         "EncryptionKeyArn": "string",
         "EncryptionKeyType": "string",
         "LockDate": number,
         "Locked": boolean,
         "MaxRetentionDays": number,
         "MinRetentionDays": number,
         "NumberOfRecoveryPoints": number,
         "VaultState": "string",
         "VaultType": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [BackupVaultList](#API_ListBackupVaults_ResponseSyntax) **   <a name="Backup-ListBackupVaults-response-BackupVaultList"></a>
Uma matriz de membros da lista de cofres de backup contendo metadados do cofre, incluindo o Nome do recurso da Amazon (ARN), o nome de exibição, a data de criação, o número de pontos de recuperação salvos e informações de criptografia se os recursos salvos no cofre de backup estiverem criptografados.  
Tipo: matriz de objetos [BackupVaultListMember](API_BackupVaultListMember.md)

 ** [NextToken](#API_ListBackupVaults_ResponseSyntax) **   <a name="Backup-ListBackupVaults-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_ListBackupVaults_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

 ** 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_ListBackupVaults_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/ListBackupVaults) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListBackupVaults) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListBackupVaults) 

# ListCopyJobs
<a name="API_ListCopyJobs"></a>

Retorna metadados sobre seus trabalhos de cópia.

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

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

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

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

 ** [ByAccountId](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByAccountId"></a>
O ID da conta a partir da qual listar os trabalhos. Retorna somente os trabalhos de cópia associados ao ID da conta especificada.  
Padrão: `^[0-9]{12}$` 

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

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

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

 ** [ByCreatedBefore](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByCreatedBefore"></a>
Retorna somente os trabalhos de cópia que foram criados antes da data especificada.

 ** [ByDestinationVaultArn](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByDestinationVaultArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`. 

 ** [ByMessageCategory](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-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) para conferir uma lista de strings aceitas.  
O valor ANY 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_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByParentJobId"></a>
Isso é um filtro para listar os trabalhos filho (aninhados) com base no ID do trabalho pai.

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

 ** [ByResourceType](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-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}$` 

 ** [BySourceRecoveryPointArn](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-BySourceRecoveryPointArn"></a>
Filtra as tarefas de cópia pelo ARN do ponto de recuperação de origem especificado.

 ** [ByState](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-request-uri-ByState"></a>
Retorna somente os trabalhos de cópia que estão no estado especificado.  
Valores válidos: `CREATED | RUNNING | COMPLETED | FAILED | PARTIAL` 

 ** [MaxResults](#API_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-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_ListCopyJobs_RequestSyntax) **   <a name="Backup-ListCopyJobs-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 devolver o MaxResults número de NextToken itens, você poderá devolver mais itens em sua lista começando pelo local apontado pelo próximo token. 

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

Essa solicitação não tem corpo.

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

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

{
   "CopyJobs": [ 
      { 
         "AccountId": "string",
         "BackupSizeInBytes": number,
         "ChildJobsInState": { 
            "string" : number 
         },
         "CompletionDate": number,
         "CompositeMemberIdentifier": "string",
         "CopyJobId": "string",
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanName": "string",
            "BackupPlanVersion": "string",
            "BackupRuleCron": "string",
            "BackupRuleId": "string",
            "BackupRuleName": "string",
            "BackupRuleTimezone": "string"
         },
         "CreatedByBackupJobId": "string",
         "CreationDate": number,
         "DestinationBackupVaultArn": "string",
         "DestinationEncryptionKeyArn": "string",
         "DestinationRecoveryPointArn": "string",
         "DestinationRecoveryPointLifecycle": { 
            "DeleteAfterDays": number,
            "DeleteAfterEvent": "string",
            "MoveToColdStorageAfterDays": number,
            "OptInToArchiveForSupportedResources": boolean
         },
         "DestinationVaultLockState": "string",
         "DestinationVaultType": "string",
         "IamRoleArn": "string",
         "IsParent": boolean,
         "MessageCategory": "string",
         "NumberOfChildJobs": number,
         "ParentJobId": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "SourceBackupVaultArn": "string",
         "SourceRecoveryPointArn": "string",
         "State": "string",
         "StatusMessage": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [CopyJobs](#API_ListCopyJobs_ResponseSyntax) **   <a name="Backup-ListCopyJobs-response-CopyJobs"></a>
Uma matriz de estruturas contendo metadados sobre seus trabalhos de cópia retornados no formato JSON.   
Tipo: matriz de objetos [CopyJob](API_CopyJob.md)

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

## Erros
<a name="API_ListCopyJobs_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_ListCopyJobs_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/ListCopyJobs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListCopyJobs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListCopyJobs) 

# ListCopyJobSummaries
<a name="API_ListCopyJobSummaries"></a>

Essa solicitação obtém uma lista dos trabalhos de cópia criados ou em execução nos últimos 30 dias. Você pode incluir os parâmetros AccountId, State,,, ResourceType, MessageCategory AggregationPeriod MaxResults, NextToken ou para filtrar os resultados.

Essa solicitação retorna um resumo que contém Região, Conta, Estado, RestourceType, MessageCategory, StartTime EndTime, e Contagem dos trabalhos incluídos.

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

```
GET /audit/copy-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```

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

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

 ** [AccountId](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-AccountId"></a>
Retorna a contagem de trabalhos para a conta especificada.  
Se a solicitação for enviada de uma conta de membro ou de uma conta que não faz parte de AWS Organizations, os trabalhos na conta do solicitante serão devolvidos.  
As contas raiz, de administrador e de administrador delegado podem usar o valor ANY para retornar as contagens de trabalhos de todas as contas da organização.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos de todas as contas da organização autenticada e retorna a soma.  
Padrão: `^[0-9]{12}$` 

 ** [AggregationPeriod](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-AggregationPeriod"></a>
O período para os resultados retornados.  
+  `ONE_DAY`: A contagem diária de trabalhos dos últimos 14 dias.
+  `SEVEN_DAYS`: A contagem agregada de trabalhos dos últimos 7 dias.
+  `FOURTEEN_DAYS`: A contagem agregada de trabalhos dos últimos 14 dias.
Valores válidos: `ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS` 

 ** [MaxResults](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-MaxResults"></a>
Esse parâmetro define o número máximo de itens a serem retornados.  
O valor é um inteiro. O intervalo de valores aceitos é de 1 a 500.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [MessageCategory](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-MessageCategory"></a>
Esse parâmetro retorna a contagem de trabalhos para a categoria de mensagem especificada.  
Exemplos de strings aceitas incluem `AccessDenied`, `Success` e `InvalidParameters`. Consulte [Monitoramento](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) para obter uma lista de MessageCategory sequências de caracteres aceitas.  
O valor ANY 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.

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

 ** [ResourceType](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-ResourceType"></a>
Retorna a contagem de trabalhos para o tipo de recurso especificado. Use a solicitação `GetSupportedResourceTypes` a fim de obter as strings para os tipos de recurso compatíveis.  
O valor ANY retorna a contagem de todos os tipos de recurso.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos para todos os tipos de recurso e retorna a soma.  
O tipo de AWS recurso a ser copiado; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS).  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [State](#API_ListCopyJobSummaries_RequestSyntax) **   <a name="Backup-ListCopyJobSummaries-request-uri-State"></a>
Esse parâmetro retorna a contagem dos trabalhos que estão no estado especificado.  
O valor ANY retorna a contagem de todos os estados.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos para todos os estados e retorna a soma.  
Valores válidos: `CREATED | RUNNING | ABORTING | ABORTED | COMPLETING | COMPLETED | FAILING | FAILED | PARTIAL | AGGREGATE_ALL | ANY` 

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

Essa solicitação não tem corpo.

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

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

{
   "AggregationPeriod": "string",
   "CopyJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MessageCategory": "string",
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [AggregationPeriod](#API_ListCopyJobSummaries_ResponseSyntax) **   <a name="Backup-ListCopyJobSummaries-response-AggregationPeriod"></a>
O período para os resultados retornados.  
+  `ONE_DAY`: A contagem diária de trabalhos dos últimos 14 dias.
+  `SEVEN_DAYS`: A contagem agregada de trabalhos dos últimos 7 dias.
+  `FOURTEEN_DAYS`: A contagem agregada de trabalhos dos últimos 14 dias.
Tipo: string

 ** [CopyJobSummaries](#API_ListCopyJobSummaries_ResponseSyntax) **   <a name="Backup-ListCopyJobSummaries-response-CopyJobSummaries"></a>
Essa devolução mostra um resumo que contém região, conta, estado ResourceType, MessageCategory, StartTime, EndTime, e contagem de trabalhos incluídos.  
Tipo: matriz de objetos [CopyJobSummary](API_CopyJobSummary.md)

 ** [NextToken](#API_ListCopyJobSummaries_ResponseSyntax) **   <a name="Backup-ListCopyJobSummaries-response-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `MaxResults` de recursos, 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_ListCopyJobSummaries_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_ListCopyJobSummaries_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/ListCopyJobSummaries) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListCopyJobSummaries) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListCopyJobSummaries) 

# ListFrameworks
<a name="API_ListFrameworks"></a>

Retorna uma lista de todas as estruturas de um Conta da AWS e. Região da AWS

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

```
GET /audit/frameworks?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

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

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

 ** [MaxResults](#API_ListFrameworks_RequestSyntax) **   <a name="Backup-ListFrameworks-request-uri-MaxResults"></a>
O número de resultados desejados de 1 a 1.000. Opcional. Se não for especificado, a consulta retornará 1 MB de dados.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListFrameworks_RequestSyntax) **   <a name="Backup-ListFrameworks-request-uri-NextToken"></a>
Um identificador que foi retornado da chamada anterior para essa operação, que pode ser usado para retornar o próximo conjunto de itens na lista.

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

Essa solicitação não tem corpo.

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

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

{
   "Frameworks": [ 
      { 
         "CreationTime": number,
         "DeploymentStatus": "string",
         "FrameworkArn": "string",
         "FrameworkDescription": "string",
         "FrameworkName": "string",
         "NumberOfControls": number
      }
   ],
   "NextToken": "string"
}
```

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

 ** [Frameworks](#API_ListFrameworks_ResponseSyntax) **   <a name="Backup-ListFrameworks-response-Frameworks"></a>
Os frameworks com detalhes de cada framework, incluindo o nome do framework, o nome do recurso da Amazon (ARN), a descrição, o número de controles, o horário de criação e o status da implantação.  
Tipo: matriz de objetos [Framework](API_Framework.md)

 ** [NextToken](#API_ListFrameworks_ResponseSyntax) **   <a name="Backup-ListFrameworks-response-NextToken"></a>
Um identificador que foi retornado da chamada anterior para essa operação, que pode ser usado para retornar o próximo conjunto de itens na lista.  
Tipo: string

## Erros
<a name="API_ListFrameworks_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_ListFrameworks_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/ListFrameworks) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListFrameworks) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListFrameworks) 

# ListIndexedRecoveryPoints
<a name="API_ListIndexedRecoveryPoints"></a>

Essa operação retorna uma lista de pontos de recuperação que têm um índice associado, pertencente à conta especificada.

Os parâmetros opcionais que você pode incluir são: MaxResults NextToken SourceResourceArns;; CreatedBefore; CreatedAfter;; ResourceType e.

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

```
GET /indexes/recovery-point/?createdAfter=CreatedAfter&createdBefore=CreatedBefore&indexStatus=IndexStatus&maxResults=MaxResults&nextToken=NextToken&resourceType=ResourceType&sourceResourceArn=SourceResourceArn HTTP/1.1
```

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

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

 ** [CreatedAfter](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-CreatedAfter"></a>
Retorna somente os pontos de recuperação indexados que foram criados depois da data especificada.

 ** [CreatedBefore](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-CreatedBefore"></a>
Retorna somente os pontos de recuperação indexados que foram criados antes da data especificada.

 ** [IndexStatus](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-IndexStatus"></a>
Inclua esse parâmetro para filtrar a lista retornada pelos status indicados.  
Valores aceitos: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
Um ponto de recuperação com um índice que possui o status de `ACTIVE` pode ser incluído em uma pesquisa.  
Valores válidos: `PENDING | ACTIVE | FAILED | DELETING` 

 ** [MaxResults](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-MaxResults"></a>
O número máximo de itens da lista de recursos a serem retornados.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

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

 ** [ResourceType](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-ResourceType"></a>
Retorna uma lista de pontos de recuperação indexados para os tipos de recurso especificados.  
Os valores aceitos são:  
+  `EBS` para Amazon Elastic Block Store
+  `S3` para Amazon Simple Storage Service (Amazon S3)
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [SourceResourceArn](#API_ListIndexedRecoveryPoints_RequestSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-request-uri-SourceResourceArn"></a>
Uma string do nome do recurso da Amazon (ARN) que identifica de forma exclusiva um recurso de origem.

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

Essa solicitação não tem corpo.

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

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

{
   "IndexedRecoveryPoints": [ 
      { 
         "BackupCreationDate": number,
         "BackupVaultArn": "string",
         "IamRoleArn": "string",
         "IndexCreationDate": number,
         "IndexStatus": "string",
         "IndexStatusMessage": "string",
         "RecoveryPointArn": "string",
         "ResourceType": "string",
         "SourceResourceArn": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [IndexedRecoveryPoints](#API_ListIndexedRecoveryPoints_ResponseSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-response-IndexedRecoveryPoints"></a>
Essa é uma lista de pontos de recuperação que têm um índice associado, pertencente à conta especificada.  
Tipo: matriz de objetos [IndexedRecoveryPoint](API_IndexedRecoveryPoint.md)

 ** [NextToken](#API_ListIndexedRecoveryPoints_ResponseSyntax) **   <a name="Backup-ListIndexedRecoveryPoints-response-NextToken"></a>
O próximo item após uma lista parcial dos pontos de recuperação retornados.  
Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de pontos de recuperação indexados, 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_ListIndexedRecoveryPoints_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

 ** 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_ListIndexedRecoveryPoints_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/ListIndexedRecoveryPoints) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListIndexedRecoveryPoints) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListIndexedRecoveryPoints) 

# ListLegalHolds
<a name="API_ListLegalHolds"></a>

Essa ação retorna metadados sobre retenções legais ativas e anteriores.

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

```
GET /legal-holds/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [MaxResults](#API_ListLegalHolds_RequestSyntax) **   <a name="Backup-ListLegalHolds-request-uri-MaxResults"></a>
O número máximo de itens da lista de recursos a serem retornados.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListLegalHolds_RequestSyntax) **   <a name="Backup-ListLegalHolds-request-uri-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `MaxResults` de recursos, 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_ListLegalHolds_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "LegalHolds": [ 
      { 
         "CancellationDate": number,
         "CreationDate": number,
         "Description": "string",
         "LegalHoldArn": "string",
         "LegalHoldId": "string",
         "Status": "string",
         "Title": "string"
      }
   ],
   "NextToken": "string"
}
```

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

 ** [LegalHolds](#API_ListLegalHolds_ResponseSyntax) **   <a name="Backup-ListLegalHolds-response-LegalHolds"></a>
Isso é uma matriz de retenções legais retornadas, tanto ativas quanto anteriores.  
Tipo: matriz de objetos [LegalHold](API_LegalHold.md)

 ** [NextToken](#API_ListLegalHolds_ResponseSyntax) **   <a name="Backup-ListLegalHolds-response-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `MaxResults` de recursos, 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_ListLegalHolds_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_ListLegalHolds_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/ListLegalHolds) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListLegalHolds) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListLegalHolds) 

# ListProtectedResources
<a name="API_ListProtectedResources"></a>

Retorna uma matriz de recursos com pontos de recuperação criados por AWS Backup (independentemente do [status](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_DescribeRecoveryPoint.html#Backup-DescribeRecoveryPoint-response-Status) do ponto de recuperação), incluindo a hora em que o recurso foi salvo, um nome de recurso da Amazon (ARN) do recurso e um tipo de recurso.

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

```
GET /resources/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [MaxResults](#API_ListProtectedResources_RequestSyntax) **   <a name="Backup-ListProtectedResources-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_ListProtectedResources_RequestSyntax) **   <a name="Backup-ListProtectedResources-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_ListProtectedResources_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "Results": [ 
      { 
         "LastBackupTime": number,
         "LastBackupVaultArn": "string",
         "LastRecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListProtectedResources_ResponseSyntax) **   <a name="Backup-ListProtectedResources-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

 ** [Results](#API_ListProtectedResources_ResponseSyntax) **   <a name="Backup-ListProtectedResources-response-Results"></a>
Um conjunto de recursos foi copiado com sucesso AWS Backup , incluindo o tempo em que o recurso foi salvo, um nome de recurso da Amazon (ARN) do recurso e um tipo de recurso.  
Tipo: matriz de objetos [ProtectedResource](API_ProtectedResource.md)

## Erros
<a name="API_ListProtectedResources_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_ListProtectedResources_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/ListProtectedResources) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListProtectedResources) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListProtectedResources) 

# ListProtectedResourcesByBackupVault
<a name="API_ListProtectedResourcesByBackupVault"></a>

Essa solicitação lista os recursos protegidos correspondentes a cada cofre de backup.

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

```
GET /backup-vaults/backupVaultName/resources/?backupVaultAccountId=BackupVaultAccountId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [BackupVaultAccountId](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-BackupVaultAccountId"></a>
A lista de recursos protegidos pelo cofre de backup dentro do(s) cofre(s) especificado(s) por ID de conta.  
Padrão: `^[0-9]{12}$` 

 ** [backupVaultName](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-request-uri-BackupVaultName"></a>
A lista de recursos protegidos pelo cofre de backup dentro do(s) cofre(s) especificado(s) por nome.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [MaxResults](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-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_ListProtectedResourcesByBackupVault_RequestSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-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_ListProtectedResourcesByBackupVault_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "Results": [ 
      { 
         "LastBackupTime": number,
         "LastBackupVaultArn": "string",
         "LastRecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListProtectedResourcesByBackupVault_ResponseSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-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

 ** [Results](#API_ListProtectedResourcesByBackupVault_ResponseSyntax) **   <a name="Backup-ListProtectedResourcesByBackupVault-response-Results"></a>
Esses são os resultados retornados para a solicitação ListProtectedResourcesByBackupVault.  
Tipo: matriz de objetos [ProtectedResource](API_ProtectedResource.md)

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

 ** 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_ListProtectedResourcesByBackupVault_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/ListProtectedResourcesByBackupVault) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListProtectedResourcesByBackupVault) 

# ListRecoveryPointsByBackupVault
<a name="API_ListRecoveryPointsByBackupVault"></a>

Retorna informações detalhadas sobre os pontos de recuperação armazenados em um cofre de backup.

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

```
GET /backup-vaults/backupVaultName/recovery-points/?backupPlanId=ByBackupPlanId&backupVaultAccountId=BackupVaultAccountId&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&parentRecoveryPointArn=ByParentRecoveryPointArn&resourceArn=ByResourceArn&resourceType=ByResourceType HTTP/1.1
```

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

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

 ** [BackupVaultAccountId](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-BackupVaultAccountId"></a>
Esse parâmetro classificará a lista de pontos de recuperação por ID de conta.  
Padrão: `^[0-9]{12}$` 

 ** [backupVaultName](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-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.  
O nome do cofre de backup pode não estar disponível quando um serviço compatível cria o backup.
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [ByBackupPlanId](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByBackupPlanId"></a>
Retorna somente os pontos de recuperação que correspondam ao ID do plano de backup especificado.

 ** [ByCreatedAfter](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByCreatedAfter"></a>
Retorna somente os pontos de recuperação que foram criados após o timestamp especificado.

 ** [ByCreatedBefore](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByCreatedBefore"></a>
Retorna somente os pontos de recuperação que foram criados antes do timestamp especificado.

 ** [ByParentRecoveryPointArn](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByParentRecoveryPointArn"></a>
Isso retorna somente os pontos de recuperação que correspondem ao Nome do recurso da Amazon (ARN) do ponto de recuperação pai (composto) especificado.

 ** [ByResourceArn](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByResourceArn"></a>
Retorna somente os pontos de recuperação que correspondem ao Nome do recurso da Amazon (ARN) do recurso especificado.

 ** [ByResourceType](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-request-uri-ByResourceType"></a>
Retorna somente os pontos de recuperação que correspondem aos tipos de recurso 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}$` 

 ** [MaxResults](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-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_ListRecoveryPointsByBackupVault_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-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_ListRecoveryPointsByBackupVault_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "RecoveryPoints": [ 
      { 
         "AggregatedScanResult": { 
            "FailedScan": boolean,
            "Findings": [ "string" ],
            "LastComputed": number
         },
         "BackupSizeInBytes": number,
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CalculatedLifecycle": { 
            "DeleteAt": number,
            "MoveToColdStorageAt": number
         },
         "CompletionDate": number,
         "CompositeMemberIdentifier": "string",
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanName": "string",
            "BackupPlanVersion": "string",
            "BackupRuleCron": "string",
            "BackupRuleId": "string",
            "BackupRuleName": "string",
            "BackupRuleTimezone": "string"
         },
         "CreationDate": number,
         "EncryptionKeyArn": "string",
         "EncryptionKeyType": "string",
         "IamRoleArn": "string",
         "IndexStatus": "string",
         "IndexStatusMessage": "string",
         "InitiationDate": number,
         "IsEncrypted": boolean,
         "IsParent": boolean,
         "LastRestoreTime": number,
         "Lifecycle": { 
            "DeleteAfterDays": number,
            "DeleteAfterEvent": "string",
            "MoveToColdStorageAfterDays": number,
            "OptInToArchiveForSupportedResources": boolean
         },
         "ParentRecoveryPointArn": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "SourceBackupVaultArn": "string",
         "Status": "string",
         "StatusMessage": "string",
         "VaultType": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListRecoveryPointsByBackupVault_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-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

 ** [RecoveryPoints](#API_ListRecoveryPointsByBackupVault_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByBackupVault-response-RecoveryPoints"></a>
Uma matriz de objetos que contém informações detalhadas sobre os pontos de recuperação salvos em um cofre de backup.  
Tipo: matriz de objetos [RecoveryPointByBackupVault](API_RecoveryPointByBackupVault.md)

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

 ** 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_ListRecoveryPointsByBackupVault_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/ListRecoveryPointsByBackupVault) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRecoveryPointsByBackupVault) 

# ListRecoveryPointsByLegalHold
<a name="API_ListRecoveryPointsByLegalHold"></a>

Essa ação retorna o ponto de recuperação ARNs (Amazon Resource Names) da retenção legal especificada.

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

```
GET /legal-holds/legalHoldId/recovery-points?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [legalHoldId](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-request-uri-LegalHoldId"></a>
O ID da retenção legal.  
Obrigatório: Sim

 ** [MaxResults](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-request-uri-MaxResults"></a>
O número máximo de itens da lista de recursos a serem retornados.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-request-uri-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `MaxResults` de recursos, 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_ListRecoveryPointsByLegalHold_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "RecoveryPoints": [ 
      { 
         "BackupVaultName": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceType": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListRecoveryPointsByLegalHold_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-response-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados.  
Tipo: string

 ** [RecoveryPoints](#API_ListRecoveryPointsByLegalHold_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByLegalHold-response-RecoveryPoints"></a>
Os pontos de recuperação.  
Tipo: matriz de objetos [RecoveryPointMember](API_RecoveryPointMember.md)

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

 ** MissingParameterValueException **   
Indica que um parâmetro necessário está ausente.    
 ** 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_ListRecoveryPointsByLegalHold_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/ListRecoveryPointsByLegalHold) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRecoveryPointsByLegalHold) 

# ListRecoveryPointsByResource
<a name="API_ListRecoveryPointsByResource"></a>

As informações sobre os pontos de recuperação do tipo especificado pelo nome do recurso da Amazon (ARN) de um recurso.

**nota**  
Para o Amazon EFS e a Amazon EC2, essa ação lista somente os pontos de recuperação criados por AWS Backup.

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

```
GET /resources/resourceArn/recovery-points/?managedByAWSBackupOnly=ManagedByAWSBackupOnly&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [ManagedByAWSBackupOnly](#API_ListRecoveryPointsByResource_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByResource-request-uri-ManagedByAWSBackupOnly"></a>
Esse atributo filtra os pontos de recuperação com base na propriedade.  
Se estiver definido como `TRUE`, a resposta conterá pontos de recuperação associados aos recursos selecionados que são gerenciados pelo AWS Backup.  
Se estiver definido como `FALSE`, a resposta conterá todos os pontos de recuperação associados ao recurso selecionado.  
Tipo: booliano

 ** [MaxResults](#API_ListRecoveryPointsByResource_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByResource-request-uri-MaxResults"></a>
O número máximo de itens a serem retornados.  
O Amazon RDS exige um valor de pelo menos 20.
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListRecoveryPointsByResource_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByResource-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.

 ** [resourceArn](#API_ListRecoveryPointsByResource_RequestSyntax) **   <a name="Backup-ListRecoveryPointsByResource-request-uri-ResourceArn"></a>
Um ARN que identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "RecoveryPoints": [ 
      { 
         "AggregatedScanResult": { 
            "FailedScan": boolean,
            "Findings": [ "string" ],
            "LastComputed": number
         },
         "BackupSizeBytes": number,
         "BackupVaultName": "string",
         "CreationDate": number,
         "EncryptionKeyArn": "string",
         "EncryptionKeyType": "string",
         "IndexStatus": "string",
         "IndexStatusMessage": "string",
         "IsParent": boolean,
         "ParentRecoveryPointArn": "string",
         "RecoveryPointArn": "string",
         "ResourceName": "string",
         "Status": "string",
         "StatusMessage": "string",
         "VaultType": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListRecoveryPointsByResource_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByResource-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

 ** [RecoveryPoints](#API_ListRecoveryPointsByResource_ResponseSyntax) **   <a name="Backup-ListRecoveryPointsByResource-response-RecoveryPoints"></a>
Uma matriz de objetos que contém informações detalhadas sobre os pontos de recuperação do tipo de recurso especificado.  
Somente o Amazon EFS e os pontos EC2 de recuperação da Amazon retornam BackupVaultName.
Tipo: matriz de objetos [RecoveryPointByResource](API_RecoveryPointByResource.md)

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

 ** 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_ListRecoveryPointsByResource_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/ListRecoveryPointsByResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRecoveryPointsByResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRecoveryPointsByResource) 

# ListReportJobs
<a name="API_ListReportJobs"></a>

Retorna detalhes sobre seus trabalhos de relatório.

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

```
GET /audit/report-jobs?CreationAfter=ByCreationAfter&CreationBefore=ByCreationBefore&MaxResults=MaxResults&NextToken=NextToken&ReportPlanName=ByReportPlanName&Status=ByStatus HTTP/1.1
```

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

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

 ** [ByCreationAfter](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByCreationAfter"></a>
Retorna somente trabalhos de relatório que foram criados após a data e hora especificadas em formato Unix e Tempo Universal Coordenado (UTC). Por exemplo, o valor 1516925490 representa sexta-feira, 26 de janeiro de 2018, 0:11:30.

 ** [ByCreationBefore](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByCreationBefore"></a>
A data e hora em que um trabalho de restauração foi criado, em formato Unix e Tempo Universal Coordenado (UTC). Por exemplo, o valor 1516925490 representa sexta-feira, 26 de janeiro de 2018, 0:11:30.

 ** [ByReportPlanName](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByReportPlanName"></a>
Retorna somente trabalhos de relatório com o nome do plano de relatório especificado.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*` 

 ** [ByStatus](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-ByStatus"></a>
Retorna somente trabalhos de relatório que estejam no status especificado. Os status são:  
 `CREATED | RUNNING | COMPLETED | FAILED | COMPLETED_WITH_ISSUES`   
 Observe que somente os trabalhos de digitalização terminam com o estado concluído com problemas. Para trabalhos de backup, essa é uma interpretação de console de um trabalho que termina no estado concluído e tem uma mensagem de status.

 ** [MaxResults](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-MaxResults"></a>
O número de resultados desejados de 1 a 1.000. Opcional. Se não for especificado, a consulta retornará 1 MB de dados.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListReportJobs_RequestSyntax) **   <a name="Backup-ListReportJobs-request-uri-NextToken"></a>
Um identificador que foi retornado da chamada anterior para essa operação, que pode ser usado para retornar o próximo conjunto de itens na lista.

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

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "ReportJobs": [ 
      { 
         "CompletionTime": number,
         "CreationTime": number,
         "ReportDestination": { 
            "S3BucketName": "string",
            "S3Keys": [ "string" ]
         },
         "ReportJobId": "string",
         "ReportPlanArn": "string",
         "ReportTemplate": "string",
         "Status": "string",
         "StatusMessage": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListReportJobs_ResponseSyntax) **   <a name="Backup-ListReportJobs-response-NextToken"></a>
Um identificador que foi retornado da chamada anterior para essa operação, que pode ser usado para retornar o próximo conjunto de itens na lista.  
Tipo: string

 ** [ReportJobs](#API_ListReportJobs_ResponseSyntax) **   <a name="Backup-ListReportJobs-response-ReportJobs"></a>
Os detalhes sobre seus trabalhos de relatório em formato JSON.  
Tipo: matriz de objetos [ReportJob](API_ReportJob.md)

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

 ** 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_ListReportJobs_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/ListReportJobs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListReportJobs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListReportJobs) 

# ListReportPlans
<a name="API_ListReportPlans"></a>

Retorna uma lista de seus planos de relatório. Para obter informações detalhadas sobre um único plano de relatório, use `DescribeReportPlan`.

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

```
GET /audit/report-plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

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

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

 ** [MaxResults](#API_ListReportPlans_RequestSyntax) **   <a name="Backup-ListReportPlans-request-uri-MaxResults"></a>
O número de resultados desejados de 1 a 1.000. Opcional. Se não for especificado, a consulta retornará 1 MB de dados.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListReportPlans_RequestSyntax) **   <a name="Backup-ListReportPlans-request-uri-NextToken"></a>
Um identificador que foi retornado da chamada anterior para essa operação, que pode ser usado para retornar o próximo conjunto de itens na lista.

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

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "ReportPlans": [ 
      { 
         "CreationTime": number,
         "DeploymentStatus": "string",
         "LastAttemptedExecutionTime": number,
         "LastSuccessfulExecutionTime": number,
         "ReportDeliveryChannel": { 
            "Formats": [ "string" ],
            "S3BucketName": "string",
            "S3KeyPrefix": "string"
         },
         "ReportPlanArn": "string",
         "ReportPlanDescription": "string",
         "ReportPlanName": "string",
         "ReportSetting": { 
            "Accounts": [ "string" ],
            "FrameworkArns": [ "string" ],
            "NumberOfFrameworks": number,
            "OrganizationUnits": [ "string" ],
            "Regions": [ "string" ],
            "ReportTemplate": "string"
         }
      }
   ]
}
```

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

 ** [NextToken](#API_ListReportPlans_ResponseSyntax) **   <a name="Backup-ListReportPlans-response-NextToken"></a>
Um identificador que foi retornado da chamada anterior para essa operação, que pode ser usado para retornar o próximo conjunto de itens na lista.  
Tipo: string

 ** [ReportPlans](#API_ListReportPlans_ResponseSyntax) **   <a name="Backup-ListReportPlans-response-ReportPlans"></a>
Os planos de relatório com informações detalhadas para cada plano. Essas informações incluem o Nome do recurso da Amazon (ARN), o nome do plano de relatório, a descrição, as configurações, o canal de entrega, o status da implantação, a hora de criação e as últimas vezes em que o plano de relatório tentou e foi executado com êxito.  
Tipo: matriz de objetos [ReportPlan](API_ReportPlan.md)

## Erros
<a name="API_ListReportPlans_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_ListReportPlans_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/ListReportPlans) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListReportPlans) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListReportPlans) 

# ListRestoreAccessBackupVaults
<a name="API_ListRestoreAccessBackupVaults"></a>

Retorna uma lista de cofres de backup de acesso à restauração associados a um cofre de backup especificado.

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

```
GET /logically-air-gapped-backup-vaults/backupVaultName/restore-access-backup-vaults/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [backupVaultName](#API_ListRestoreAccessBackupVaults_RequestSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-request-uri-BackupVaultName"></a>
O nome do cofre de backup do qual listar os cofres de backup de acesso de restauração associados.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [MaxResults](#API_ListRestoreAccessBackupVaults_RequestSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-request-uri-MaxResults"></a>
O número máximo de itens a exibir na resposta.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListRestoreAccessBackupVaults_RequestSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-request-uri-NextToken"></a>
O token de paginação de uma solicitação anterior para recuperar o próximo conjunto de resultados.

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

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "RestoreAccessBackupVaults": [ 
      { 
         "ApprovalDate": number,
         "CreationDate": number,
         "LatestRevokeRequest": { 
            "ExpiryDate": number,
            "InitiationDate": number,
            "MpaSessionArn": "string",
            "Status": "string",
            "StatusMessage": "string"
         },
         "RestoreAccessBackupVaultArn": "string",
         "VaultState": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListRestoreAccessBackupVaults_ResponseSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-response-NextToken"></a>
O token de paginação para usar em uma solicitação posterior para recuperar o próximo conjunto de resultados.  
Tipo: string

 ** [RestoreAccessBackupVaults](#API_ListRestoreAccessBackupVaults_ResponseSyntax) **   <a name="Backup-ListRestoreAccessBackupVaults-response-RestoreAccessBackupVaults"></a>
Uma lista de cofres de backup de acesso à restauração associados ao cofre de backup especificado.  
Tipo: matriz de objetos [RestoreAccessBackupVaultListMember](API_RestoreAccessBackupVaultListMember.md)

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

 ** 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_ListRestoreAccessBackupVaults_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/ListRestoreAccessBackupVaults) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreAccessBackupVaults) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreAccessBackupVaults) 

# ListRestoreJobs
<a name="API_ListRestoreJobs"></a>

Retorna uma lista de trabalhos AWS Backup iniciados para restaurar um recurso salvo, incluindo detalhes sobre o processo de recuperação.

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

```
GET /restore-jobs/?accountId=ByAccountId&completeAfter=ByCompleteAfter&completeBefore=ByCompleteBefore&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&parentJobId=ByParentJobId&resourceType=ByResourceType&restoreTestingPlanArn=ByRestoreTestingPlanArn&status=ByStatus HTTP/1.1
```

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

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

 ** [ByAccountId](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByAccountId"></a>
O ID da conta a partir da qual listar os trabalhos. Retorna somente trabalhos de restauração associados ao ID da conta especificada.  
Padrão: `^[0-9]{12}$` 

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

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

 ** [ByCreatedAfter](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByCreatedAfter"></a>
Retorna somente trabalhos de restauração que foram criados após a data especificada.

 ** [ByCreatedBefore](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByCreatedBefore"></a>
Retorna somente trabalhos de restauração que foram criados antes da data especificada.

 ** [ByParentJobId](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByParentJobId"></a>
Esse é um filtro para listar os trabalhos de restauração secundários (aninhados) com base no ID do trabalho de restauração principal.

 ** [ByResourceType](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByResourceType"></a>
Inclua esse parâmetro para retornar somente trabalhos de restauração 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}$` 

 ** [ByRestoreTestingPlanArn](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByRestoreTestingPlanArn"></a>
Isso retorna somente os trabalhos de testes de restauração que correspondem ao nome do recurso da Amazon (ARN) especificado.

 ** [ByStatus](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-request-uri-ByStatus"></a>
Retorna somente trabalhos de restauração associados ao status do trabalho especificado.  
Valores válidos: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED` 

 ** [MaxResults](#API_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-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_ListRestoreJobs_RequestSyntax) **   <a name="Backup-ListRestoreJobs-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_ListRestoreJobs_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "RestoreJobs": [ 
      { 
         "AccountId": "string",
         "BackupSizeInBytes": number,
         "BackupVaultArn": "string",
         "CompletionDate": number,
         "CreatedBy": { 
            "RestoreTestingPlanArn": "string"
         },
         "CreatedResourceArn": "string",
         "CreationDate": number,
         "DeletionStatus": "string",
         "DeletionStatusMessage": "string",
         "ExpectedCompletionTimeMinutes": number,
         "IamRoleArn": "string",
         "IsParent": boolean,
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointCreationDate": number,
         "ResourceType": "string",
         "RestoreJobId": "string",
         "SourceResourceArn": "string",
         "Status": "string",
         "StatusMessage": "string",
         "ValidationStatus": "string",
         "ValidationStatusMessage": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListRestoreJobs_ResponseSyntax) **   <a name="Backup-ListRestoreJobs-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

 ** [RestoreJobs](#API_ListRestoreJobs_ResponseSyntax) **   <a name="Backup-ListRestoreJobs-response-RestoreJobs"></a>
Uma matriz de objetos que contém informações detalhadas sobre trabalhos para restaurar recursos salvos.  
Tipo: matriz de objetos [RestoreJobsListMember](API_RestoreJobsListMember.md)

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

 ** 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_ListRestoreJobs_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/ListRestoreJobs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreJobs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreJobs) 

# ListRestoreJobsByProtectedResource
<a name="API_ListRestoreJobsByProtectedResource"></a>

Isso retorna os trabalhos de restauração que contêm o recurso protegido especificado.

Você deve incluir `ResourceArn`. Você também pode incluir `NextToken`, `ByStatus`, `MaxResults`, `ByRecoveryPointCreationDateAfter` e `ByRecoveryPointCreationDateBefore`.

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

```
GET /resources/resourceArn/restore-jobs/?maxResults=MaxResults&nextToken=NextToken&recoveryPointCreationDateAfter=ByRecoveryPointCreationDateAfter&recoveryPointCreationDateBefore=ByRecoveryPointCreationDateBefore&status=ByStatus HTTP/1.1
```

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

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

 ** [ByRecoveryPointCreationDateAfter](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-ByRecoveryPointCreationDateAfter"></a>
Retorna somente os trabalhos de restauração de pontos de recuperação que foram criados após a data especificada.

 ** [ByRecoveryPointCreationDateBefore](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-ByRecoveryPointCreationDateBefore"></a>
Retorna somente os trabalhos de restauração de pontos de recuperação que foram criados antes da data especificada.

 ** [ByStatus](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-ByStatus"></a>
Retorna somente trabalhos de restauração associados ao status do trabalho especificado.  
Valores válidos: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED` 

 ** [MaxResults](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-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_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-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 a quantidade `MaxResults` de itens, `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.

 ** [resourceArn](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-request-uri-ResourceArn"></a>
Retorna somente os trabalhos de restauração que correspondem ao nome do recurso da Amazon (ARN) especificado.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "RestoreJobs": [ 
      { 
         "AccountId": "string",
         "BackupSizeInBytes": number,
         "BackupVaultArn": "string",
         "CompletionDate": number,
         "CreatedBy": { 
            "RestoreTestingPlanArn": "string"
         },
         "CreatedResourceArn": "string",
         "CreationDate": number,
         "DeletionStatus": "string",
         "DeletionStatusMessage": "string",
         "ExpectedCompletionTimeMinutes": number,
         "IamRoleArn": "string",
         "IsParent": boolean,
         "ParentJobId": "string",
         "PercentDone": "string",
         "RecoveryPointArn": "string",
         "RecoveryPointCreationDate": number,
         "ResourceType": "string",
         "RestoreJobId": "string",
         "SourceResourceArn": "string",
         "Status": "string",
         "StatusMessage": "string",
         "ValidationStatus": "string",
         "ValidationStatusMessage": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListRestoreJobsByProtectedResource_ResponseSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-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 a quantidade `MaxResults` de itens, `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string

 ** [RestoreJobs](#API_ListRestoreJobsByProtectedResource_ResponseSyntax) **   <a name="Backup-ListRestoreJobsByProtectedResource-response-RestoreJobs"></a>
Uma matriz de objetos que contêm informações detalhadas sobre trabalhos para restaurar recursos salvos.  
Tipo: matriz de objetos [RestoreJobsListMember](API_RestoreJobsListMember.md)

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

 ** 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_ListRestoreJobsByProtectedResource_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/ListRestoreJobsByProtectedResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreJobsByProtectedResource) 

# ListRestoreJobSummaries
<a name="API_ListRestoreJobSummaries"></a>

Essa solicitação obtém um resumo dos trabalhos de restauração criados ou em execução nos últimos 30 dias. Você pode incluir os parâmetros AccountId, State,,, ResourceType AggregationPeriod MaxResults, NextToken ou para filtrar os resultados.

Essa solicitação retorna um resumo que contém Região, Conta, Estado, RestourceType, MessageCategory, StartTime EndTime, e Contagem dos trabalhos incluídos.

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

```
GET /audit/restore-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
```

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

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

 ** [AccountId](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-AccountId"></a>
Retorna a contagem de trabalhos para a conta especificada.  
Se a solicitação for enviada de uma conta de membro ou de uma conta que não faz parte de AWS Organizations, os trabalhos na conta do solicitante serão devolvidos.  
As contas raiz, de administrador e de administrador delegado podem usar o valor ANY para retornar as contagens de trabalhos de todas as contas da organização.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos de todas as contas da organização autenticada e retorna a soma.  
Padrão: `^[0-9]{12}$` 

 ** [AggregationPeriod](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-AggregationPeriod"></a>
O período para os resultados retornados.  
+  `ONE_DAY`: A contagem diária de trabalhos dos últimos 14 dias.
+  `SEVEN_DAYS`: A contagem agregada de trabalhos dos últimos 7 dias.
+  `FOURTEEN_DAYS`: A contagem agregada de trabalhos dos últimos 14 dias.
Valores válidos: `ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS` 

 ** [MaxResults](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-MaxResults"></a>
Esse parâmetro define o número máximo de itens a serem retornados.  
O valor é um inteiro. O intervalo de valores aceitos é de 1 a 500.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

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

 ** [ResourceType](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-ResourceType"></a>
Retorna a contagem de trabalhos para o tipo de recurso especificado. Use a solicitação `GetSupportedResourceTypes` a fim de obter as strings para os tipos de recurso compatíveis.  
O valor ANY retorna a contagem de todos os tipos de recurso.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos para todos os tipos de recurso e retorna a soma.  
O tipo de AWS recurso a ser copiado; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS).  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [State](#API_ListRestoreJobSummaries_RequestSyntax) **   <a name="Backup-ListRestoreJobSummaries-request-uri-State"></a>
Esse parâmetro retorna a contagem dos trabalhos que estão no estado especificado.  
O valor ANY retorna a contagem de todos os estados.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos para todos os estados e retorna a soma.  
Valores válidos: `CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | AGGREGATE_ALL | ANY` 

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

Essa solicitação não tem corpo.

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

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

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "RestoreJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "Region": "string",
         "ResourceType": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}
```

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

 ** [AggregationPeriod](#API_ListRestoreJobSummaries_ResponseSyntax) **   <a name="Backup-ListRestoreJobSummaries-response-AggregationPeriod"></a>
O período para os resultados retornados.  
+  `ONE_DAY`: A contagem diária de trabalhos dos últimos 14 dias.
+  `SEVEN_DAYS`: A contagem agregada de trabalhos dos últimos 7 dias.
+  `FOURTEEN_DAYS`: A contagem agregada de trabalhos dos últimos 14 dias.
Tipo: string

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

 ** [RestoreJobSummaries](#API_ListRestoreJobSummaries_ResponseSyntax) **   <a name="Backup-ListRestoreJobSummaries-response-RestoreJobSummaries"></a>
Essa devolução contém um resumo que contém região, conta, estado ResourceType, MessageCategory, StartTime, EndTime, e contagem de trabalhos incluídos.  
Tipo: matriz de objetos [RestoreJobSummary](API_RestoreJobSummary.md)

## Erros
<a name="API_ListRestoreJobSummaries_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_ListRestoreJobSummaries_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/ListRestoreJobSummaries) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreJobSummaries) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreJobSummaries) 

# ListRestoreTestingPlans
<a name="API_ListRestoreTestingPlans"></a>

Retorna uma lista de planos de testes de restauração.

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

```
GET /restore-testing/plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

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

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

 ** [MaxResults](#API_ListRestoreTestingPlans_RequestSyntax) **   <a name="Backup-ListRestoreTestingPlans-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_ListRestoreTestingPlans_RequestSyntax) **   <a name="Backup-ListRestoreTestingPlans-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 a quantidade `MaxResults` de itens, `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_ListRestoreTestingPlans_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "RestoreTestingPlans": [ 
      { 
         "CreationTime": number,
         "LastExecutionTime": number,
         "LastUpdateTime": number,
         "RestoreTestingPlanArn": "string",
         "RestoreTestingPlanName": "string",
         "ScheduleExpression": "string",
         "ScheduleExpressionTimezone": "string",
         "StartWindowHours": number
      }
   ]
}
```

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

 ** [NextToken](#API_ListRestoreTestingPlans_ResponseSyntax) **   <a name="Backup-ListRestoreTestingPlans-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 a quantidade `MaxResults` de itens, `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string

 ** [RestoreTestingPlans](#API_ListRestoreTestingPlans_ResponseSyntax) **   <a name="Backup-ListRestoreTestingPlans-response-RestoreTestingPlans"></a>
Essa é uma lista retornada de planos de testes de restauração.  
Tipo: matriz de objetos [RestoreTestingPlanForList](API_RestoreTestingPlanForList.md)

## Erros
<a name="API_ListRestoreTestingPlans_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_ListRestoreTestingPlans_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/ListRestoreTestingPlans) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreTestingPlans) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreTestingPlans) 

# ListRestoreTestingSelections
<a name="API_ListRestoreTestingSelections"></a>

Retorna uma lista de seleções de testes de restauração. Pode ser filtrada por `MaxResults` e `RestoreTestingPlanName`.

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

```
GET /restore-testing/plans/RestoreTestingPlanName/selections?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

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

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

 ** [MaxResults](#API_ListRestoreTestingSelections_RequestSyntax) **   <a name="Backup-ListRestoreTestingSelections-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_ListRestoreTestingSelections_RequestSyntax) **   <a name="Backup-ListRestoreTestingSelections-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 a quantidade `MaxResults` de itens, `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.

 ** [RestoreTestingPlanName](#API_ListRestoreTestingSelections_RequestSyntax) **   <a name="Backup-ListRestoreTestingSelections-request-uri-RestoreTestingPlanName"></a>
Retorna as seleções de testes de restauração pelo nome do plano de testes de restauração especificado.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "RestoreTestingSelections": [ 
      { 
         "CreationTime": number,
         "IamRoleArn": "string",
         "ProtectedResourceType": "string",
         "RestoreTestingPlanName": "string",
         "RestoreTestingSelectionName": "string",
         "ValidationWindowHours": number
      }
   ]
}
```

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

 ** [NextToken](#API_ListRestoreTestingSelections_ResponseSyntax) **   <a name="Backup-ListRestoreTestingSelections-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 a quantidade `MaxResults` de itens, `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string

 ** [RestoreTestingSelections](#API_ListRestoreTestingSelections_ResponseSyntax) **   <a name="Backup-ListRestoreTestingSelections-response-RestoreTestingSelections"></a>
Retorna as seleções de testes de restauração associadas ao plano de testes de restauração.  
Tipo: matriz de objetos [RestoreTestingSelectionForList](API_RestoreTestingSelectionForList.md)

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

 ** 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_ListRestoreTestingSelections_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/ListRestoreTestingSelections) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListRestoreTestingSelections) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListRestoreTestingSelections) 

# ListScanJobs
<a name="API_ListScanJobs"></a>

Retorna uma lista dos trabalhos de digitalização existentes para uma conta autenticada nos últimos 30 dias.

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

```
GET /scan/jobs?ByAccountId=ByAccountId&ByBackupVaultName=ByBackupVaultName&ByCompleteAfter=ByCompleteAfter&ByCompleteBefore=ByCompleteBefore&ByMalwareScanner=ByMalwareScanner&ByRecoveryPointArn=ByRecoveryPointArn&ByResourceArn=ByResourceArn&ByResourceType=ByResourceType&ByScanResultStatus=ByScanResultStatus&ByState=ByState&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```

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

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

 ** [ByAccountId](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-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 de gerenciamento da AWS Organizations, o passe `*` retorna todos os trabalhos em toda a organização.  
Padrão: `^[0-9]{12}$` 

 ** [ByBackupVaultName](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByBackupVaultName"></a>
Retorna somente trabalhos de digitalização que serão armazenados no cofre de backup especificado. Os cofres de backup são identificados por nomes exclusivos da conta usada para criá-los e da AWS região em que foram criados.  
Padrão: `^[a-zA-Z0-9\-\_\.]{2,50}$` 

 ** [ByCompleteAfter](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByCompleteAfter"></a>
Retorna somente trabalhos de digitalização concluídos após uma data expressa no formato Unix e no Tempo Universal Coordenado (UTC).

 ** [ByCompleteBefore](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-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).

 ** [ByMalwareScanner](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByMalwareScanner"></a>
Retorna somente os trabalhos de verificação do verificador de malware especificado. No momento, oferece suporte apenas a `GUARDDUTY`.  
Valores válidos: `GUARDDUTY` 

 ** [ByRecoveryPointArn](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByRecoveryPointArn"></a>
Retorna somente os trabalhos de digitalização executados no ponto de recuperação especificado.

 ** [ByResourceArn](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByResourceArn"></a>
Retorna somente trabalhos de digitalização que correspondam ao recurso Amazon Resource Name (ARN) especificado.

 ** [ByResourceType](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByResourceType"></a>
Retorna as seleções de testes de restauração pelo nome do plano de testes de restauração especificado.  
+  `EBS`para Amazon Elastic Block Store
+  `EC2`para Amazon Elastic Compute Cloud
+  `S3`para o Amazon Simple Storage Service (Amazon S3)
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
Valores válidos: `EBS | EC2 | S3` 

 ** [ByScanResultStatus](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByScanResultStatus"></a>
Retorna somente os trabalhos de escaneamento para os resultados de escaneamento especificados:  
+  `THREATS_FOUND` 
+  `NO_THREATS_FOUND` 
Valores válidos: `NO_THREATS_FOUND | THREATS_FOUND` 

 ** [ByState](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-request-uri-ByState"></a>
Retorna somente os trabalhos de digitalização para o estado do trabalho de digitalização especificado.  
Valores válidos: `CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING` 

 ** [MaxResults](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-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.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListScanJobs_RequestSyntax) **   <a name="Backup-ListScanJobs-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_ListScanJobs_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "ScanJobs": [ 
      { 
         "AccountId": "string",
         "BackupVaultArn": "string",
         "BackupVaultName": "string",
         "CompletionDate": number,
         "CreatedBy": { 
            "BackupPlanArn": "string",
            "BackupPlanId": "string",
            "BackupPlanVersion": "string",
            "BackupRuleId": "string"
         },
         "CreationDate": number,
         "IamRoleArn": "string",
         "MalwareScanner": "string",
         "RecoveryPointArn": "string",
         "ResourceArn": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "ScanBaseRecoveryPointArn": "string",
         "ScanId": "string",
         "ScanJobId": "string",
         "ScanMode": "string",
         "ScannerRoleArn": "string",
         "ScanResult": { 
            "ScanResultStatus": "string"
         },
         "State": "string",
         "StatusMessage": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListScanJobs_ResponseSyntax) **   <a name="Backup-ListScanJobs-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

 ** [ScanJobs](#API_ListScanJobs_ResponseSyntax) **   <a name="Backup-ListScanJobs-response-ScanJobs"></a>
Uma matriz de estruturas contendo metadados sobre seus trabalhos de digitalização retornados no formato JSON.  
Tipo: matriz de objetos [ScanJob](API_ScanJob.md)

## Erros
<a name="API_ListScanJobs_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_ListScanJobs_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/ListScanJobs) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListScanJobs) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListScanJobs) 

# ListScanJobSummaries
<a name="API_ListScanJobSummaries"></a>

Essa é uma solicitação para um resumo dos trabalhos de verificação criados ou em execução nos últimos 30 dias.

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

```
GET /audit/scan-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MalwareScanner=MalwareScanner&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&ScanResultStatus=ScanResultStatus&State=State HTTP/1.1
```

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

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

 ** [AccountId](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-AccountId"></a>
Retorna a contagem de trabalhos para a conta especificada.  
Se a solicitação for enviada de uma conta de membro ou de uma conta que não faz parte de AWS Organizations, os trabalhos na conta do solicitante serão devolvidos.  
As contas raiz, de administrador e de administrador delegado podem usar o valor `ANY` para retornar as contagens de trabalhos de todas as contas da organização.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos de todas as contas da organização autenticada e retorna a soma.  
Padrão: `^[0-9]{12}$` 

 ** [AggregationPeriod](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-AggregationPeriod"></a>
O período para os resultados retornados.  
+  `ONE_DAY`A contagem diária de trabalhos do primeiro dia anterior.
+  `SEVEN_DAYS`A contagem diária de trabalhos dos 7 dias anteriores.
+  `FOURTEEN_DAYS`A contagem diária de trabalhos dos 14 dias anteriores.
Valores válidos: `ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS` 

 ** [MalwareScanner](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-MalwareScanner"></a>
Retorna somente os trabalhos de verificação do verificador de malware especificado. Atualmente, o único MalwareScanner é`GUARDDUTY`. Mas o campo também apóia `ANY` `AGGREGATE_ALL` e.  
Valores válidos: `GUARDDUTY` 

 ** [MaxResults](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-MaxResults"></a>
O número máximo de itens a serem retornados.  
O valor é um inteiro. O intervalo de valores aceitos é de 1 a 500.  
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.

 ** [NextToken](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-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.

 ** [ResourceType](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-ResourceType"></a>
Retorna a contagem de trabalhos para o tipo de recurso especificado. Use a solicitação `GetSupportedResourceTypes` a fim de obter as strings para os tipos de recurso compatíveis.  
Em seguida, o valor `ANY` retorna a contagem de todos os tipos de recursos.  
 `AGGREGATE_ALL` agrega as contagens de trabalhos para todos os tipos de recurso e retorna a soma.  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$` 

 ** [ScanResultStatus](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-ScanResultStatus"></a>
Retorna somente os trabalhos de escaneamento para os resultados de escaneamento especificados.  
Valores válidos: `NO_THREATS_FOUND | THREATS_FOUND` 

 ** [State](#API_ListScanJobSummaries_RequestSyntax) **   <a name="Backup-ListScanJobSummaries-request-uri-State"></a>
Retorna somente os trabalhos de digitalização para o estado do trabalho de digitalização especificado.  
Valores válidos: `CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY` 

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

Essa solicitação não tem corpo.

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

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

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "ScanJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MalwareScanner": "string",
         "Region": "string",
         "ResourceType": "string",
         "ScanResultStatus": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}
```

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

 ** [AggregationPeriod](#API_ListScanJobSummaries_ResponseSyntax) **   <a name="Backup-ListScanJobSummaries-response-AggregationPeriod"></a>
O período para os resultados retornados.  
+  `ONE_DAY`A contagem diária de trabalhos do primeiro dia anterior.
+  `SEVEN_DAYS`A contagem diária de trabalhos dos 7 dias anteriores.
+  `FOURTEEN_DAYS`A contagem diária de trabalhos dos 14 dias anteriores.
Valores válidos: `'ONE_DAY'` \$1 `'SEVEN_DAYS'` \$1 `'FOURTEEN_DAYS'`   
Tipo: string

 ** [NextToken](#API_ListScanJobSummaries_ResponseSyntax) **   <a name="Backup-ListScanJobSummaries-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

 ** [ScanJobSummaries](#API_ListScanJobSummaries_ResponseSyntax) **   <a name="Backup-ListScanJobSummaries-response-ScanJobSummaries"></a>
As informações resumidas.  
Tipo: matriz de objetos [ScanJobSummary](API_ScanJobSummary.md)

## Erros
<a name="API_ListScanJobSummaries_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_ListScanJobSummaries_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/ListScanJobSummaries) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListScanJobSummaries) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListScanJobSummaries) 

# ListTags
<a name="API_ListTags"></a>

Retorna as tags atribuídas ao recurso, como ponto de recuperação, plano de backup ou cofre de backup de destino.

Essa operação retorna resultados dependendo do tipo de recurso usado no valor de `resourceArn`. Por exemplo, pontos de recuperação do Amazon DynamoDB com configurações avançadas têm um ARN (nome do recurso da Amazon) que começa com `arn:aws:backup`. Os pontos de recuperação (backups) do DynamoDB sem as configurações avançadas habilitadas têm um ARN que começa com `arn:aws:dynamodb`.

Quando essa operação é chamada e quando você inclui valores de `resourceArn` que têm um ARN diferente de `arn:aws:backup`, ela pode retornar uma das exceções listadas abaixo. Para evitar essa exceção, inclua somente valores representando tipos de recursos totalmente gerenciados pelo AWS Backup. Eles têm um ARN que começa com `arn:aws:backup` e são anotados na tabela [Disponibilidade de atributos por recurso](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource).

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

```
GET /tags/resourceArn/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [MaxResults](#API_ListTags_RequestSyntax) **   <a name="Backup-ListTags-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_ListTags_RequestSyntax) **   <a name="Backup-ListTags-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.

 ** [resourceArn](#API_ListTags_RequestSyntax) **   <a name="Backup-ListTags-request-uri-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. Os destinos válidos para `ListTags` são pontos de recuperação, planos de backup e cofres de backup.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

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

 ** [NextToken](#API_ListTags_ResponseSyntax) **   <a name="Backup-ListTags-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

 ** [Tags](#API_ListTags_ResponseSyntax) **   <a name="Backup-ListTags-response-Tags"></a>
Informações sobre as tags.  
Tipo: mapa de string para string

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

 ** 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_ListTags_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/ListTags) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListTags) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListTags) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListTags) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListTags) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListTags) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListTags) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListTags) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListTags) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListTags) 

# ListTieringConfigurations
<a name="API_ListTieringConfigurations"></a>

Retorna uma lista de configurações de camadas.

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

```
GET /tiering-configurations/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

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

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

 ** [MaxResults](#API_ListTieringConfigurations_RequestSyntax) **   <a name="Backup-ListTieringConfigurations-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_ListTieringConfigurations_RequestSyntax) **   <a name="Backup-ListTieringConfigurations-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_ListTieringConfigurations_RequestBody"></a>

Essa solicitação não tem corpo.

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

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

{
   "NextToken": "string",
   "TieringConfigurations": [ 
      { 
         "BackupVaultName": "string",
         "CreationTime": number,
         "LastUpdatedTime": number,
         "TieringConfigurationArn": "string",
         "TieringConfigurationName": "string"
      }
   ]
}
```

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

 ** [NextToken](#API_ListTieringConfigurations_ResponseSyntax) **   <a name="Backup-ListTieringConfigurations-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

 ** [TieringConfigurations](#API_ListTieringConfigurations_ResponseSyntax) **   <a name="Backup-ListTieringConfigurations-response-TieringConfigurations"></a>
Uma série de configurações de hierarquização retornadas pela `ListTieringConfigurations` chamada.  
Tipo: matriz de objetos [TieringConfigurationsListMember](API_TieringConfigurationsListMember.md)

## Erros
<a name="API_ListTieringConfigurations_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_ListTieringConfigurations_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/ListTieringConfigurations) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/ListTieringConfigurations) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ListTieringConfigurations) 

# PutBackupVaultAccessPolicy
<a name="API_PutBackupVaultAccessPolicy"></a>

Define uma política baseada em recurso usada para gerenciar as permissões de acesso ao cofre de backup de destino. Requer um nome de cofre de backup e um documento de política de acesso no formato JSON.

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

```
PUT /backup-vaults/backupVaultName/access-policy HTTP/1.1
Content-type: application/json

{
   "Policy": "string"
}
```

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

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

 ** [backupVaultName](#API_PutBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-PutBackupVaultAccessPolicy-request-uri-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.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

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

 ** [Policy](#API_PutBackupVaultAccessPolicy_RequestSyntax) **   <a name="Backup-PutBackupVaultAccessPolicy-request-Policy"></a>
O documento da política de acesso ao cofre de backup no formato JSON.  
Tipo: string  
Obrigatório: não

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_PutBackupVaultAccessPolicy_ResponseElements"></a>

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

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

 ** 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_PutBackupVaultAccessPolicy_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/PutBackupVaultAccessPolicy) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutBackupVaultAccessPolicy) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutBackupVaultAccessPolicy) 

# PutBackupVaultLockConfiguration
<a name="API_PutBackupVaultLockConfiguration"></a>

Aplica o AWS Backup Vault Lock a um cofre de backup, evitando tentativas de excluir qualquer ponto de recuperação armazenado ou criado em um cofre de backup. O Vault Lock também impede tentativas de atualizar a política de ciclo de vida que controla o período de retenção de qualquer ponto de recuperação atualmente armazenado em um cofre de backup. Se especificado, o Vault Lock impõe um período mínimo e máximo de retenção para futuros trabalhos de backup e de cópia destinados a um cofre de backup.

**nota**  
 AWS Backup O Vault Lock foi avaliado pela Cohasset Associates para uso em ambientes sujeitos às regulamentações SEC 17a-4, CFTC e FINRA. Para obter mais informações sobre como o AWS Backup Vault Lock se relaciona com esses regulamentos, consulte a Avaliação de conformidade da [Cohasset Associates](https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip). 

Para obter mais informações, consulte [Vault Lock do AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html).

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

```
PUT /backup-vaults/backupVaultName/vault-lock HTTP/1.1
Content-type: application/json

{
   "ChangeableForDays": number,
   "MaxRetentionDays": number,
   "MinRetentionDays": number
}
```

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

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

 ** [backupVaultName](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-uri-BackupVaultName"></a>
A configuração do AWS Backup Vault Lock que especifica o nome do cofre de backup que ele protege.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

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

 ** [ChangeableForDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-ChangeableForDays"></a>
A configuração do AWS Backup Vault Lock que especifica o número de dias antes da data do bloqueio. Por exemplo, definindo `ChangeableForDays` para 30 em 1º de janeiro de 2022 às 20h UTC definirá a data de bloqueio para 31 de janeiro de 2022 às 20h UTC.  
 AWS Backup impõe um período de reflexão de 72 horas antes que o Vault Lock entre em vigor e se torne imutável. Portanto, você deve definir o `ChangeableForDays` para 3 ou mais.  
O valor máximo que você pode especificar é 36.500 dias (aproximadamente 100 anos).  
Antes da data de bloqueio, você pode excluir o Vault Lock do cofre usando`DeleteBackupVaultLockConfiguration` ou alterar a configuração do Vault Lock usando `PutBackupVaultLockConfiguration`. Na data de bloqueio e após essa data, o Vault Lock se tornará imutável e não poderá ser alterado ou excluído.  
Se esse parâmetro não for especificado, você poderá excluir o Vault Lock do cofre usando `DeleteBackupVaultLockConfiguration` ou alterar a configuração do Vault Lock usando `PutBackupVaultLockConfiguration` a qualquer momento.  
Tipo: longo  
Obrigatório: não

 ** [MaxRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-MaxRetentionDays"></a>
A configuração do AWS Backup Vault Lock que especifica o período máximo de retenção em que o cofre retém seus pontos de recuperação. Essa configuração pode ser útil se, por exemplo, as políticas da sua organização exigirem que você destrua determinados dados depois de retê-los por quatro anos (1460 dias).  
Se esse parâmetro não estiver incluído, o Vault Lock não aplicará um período máximo de retenção nos pontos de recuperação no cofre. Se esse parâmetro for incluído sem um valor, o Vault Lock não aplicará um período máximo de retenção.  
Se esse parâmetro for especificado, qualquer tarefa de backup ou cópia para o cofre deverá ter uma política de ciclo de vida com um período de retenção igual ou inferior ao período máximo de retenção. Se o período de retenção do trabalho for maior do que o período máximo de retenção, o cofre falhará no trabalho de backup ou cópia e você deverá modificar as configurações do ciclo de vida ou usar um cofre diferente. O período máximo de retenção mais longo que pode ser especificado é de 36.500 dias (aproximadamente 100 anos). Os pontos de recuperação já salvos no cofre antes do Vault Lock não serão afetados.  
Tipo: longo  
Obrigatório: não

 ** [MinRetentionDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **   <a name="Backup-PutBackupVaultLockConfiguration-request-MinRetentionDays"></a>
A configuração do AWS Backup Vault Lock que especifica o período mínimo de retenção em que o cofre retém seus pontos de recuperação. Essa configuração pode ser útil se, por exemplo, as políticas da sua organização exigirem que você retenha determinados dados por pelo menos sete anos (2555 dias).  
Esse parâmetro é necessário quando um bloqueio de cofre é criado por meio de AWS CloudFormation; caso contrário, esse parâmetro é opcional. Se esse parâmetro não for especificado, o Vault Lock não aplicará um período mínimo de retenção.  
Se esse parâmetro for especificado, qualquer tarefa de backup ou cópia para o cofre deverá ter uma política de ciclo de vida com um período de retenção igual ou superior ao período mínimo de retenção. Se o período de retenção do trabalho for mais curto do que o período mínimo de retenção, o cofre falhará no trabalho de backup ou cópia e você deverá modificar as configurações do ciclo de vida ou usar um cofre diferente. O período mínimo de retenção mais curto que você ser especificado é de 1 dia. Os pontos de recuperação já salvos no cofre antes do Vault Lock não serão afetados.  
Tipo: longo  
Obrigatório: não

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_PutBackupVaultLockConfiguration_ResponseElements"></a>

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

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

 ** 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_PutBackupVaultLockConfiguration_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/PutBackupVaultLockConfiguration) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutBackupVaultLockConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutBackupVaultLockConfiguration) 

# PutBackupVaultNotifications
<a name="API_PutBackupVaultNotifications"></a>

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

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

```
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 name="API_PutBackupVaultNotifications_RequestParameters"></a>

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

 ** [backupVaultName](#API_PutBackupVaultNotifications_RequestSyntax) **   <a name="Backup-PutBackupVaultNotifications-request-uri-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.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

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

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

 ** [BackupVaultEvents](#API_PutBackupVaultNotifications_RequestSyntax) **   <a name="Backup-PutBackupVaultNotifications-request-BackupVaultEvents"></a>
Uma matriz de eventos que indicam o status de trabalhos para recursos de backup para o cofre de backup. Para ver a lista de eventos compatíveis, casos de uso comuns e exemplos de código, consulte [Opções de notificação com AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-notifications.html).  
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.
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 | CONTINUOUS_BACKUP_INTERRUPTED | RECOVERY_POINT_INDEX_COMPLETED | RECOVERY_POINT_INDEX_DELETED | RECOVERY_POINT_INDEXING_FAILED`   
Obrigatório: Sim

 ** [SNSTopicArn](#API_PutBackupVaultNotifications_RequestSyntax) **   <a name="Backup-PutBackupVaultNotifications-request-SNSTopicArn"></a>
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
<a name="API_PutBackupVaultNotifications_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_PutBackupVaultNotifications_ResponseElements"></a>

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

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

 ** 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_PutBackupVaultNotifications_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/PutBackupVaultNotifications) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutBackupVaultNotifications) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutBackupVaultNotifications) 

# PutRestoreValidationResult
<a name="API_PutRestoreValidationResult"></a>

Essa solicitação permite que você envie os resultados de validação do teste de restauração de execução própria e independente. `RestoreJobId` e `ValidationStatus` são obrigatórios. Você também pode inserir um `ValidationStatusMessage`.

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

```
PUT /restore-jobs/restoreJobId/validations HTTP/1.1
Content-type: application/json

{
   "ValidationStatus": "string",
   "ValidationStatusMessage": "string"
}
```

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

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

 ** [restoreJobId](#API_PutRestoreValidationResult_RequestSyntax) **   <a name="Backup-PutRestoreValidationResult-request-uri-RestoreJobId"></a>
Esse é um identificador exclusivo de um trabalho de restauração interno AWS Backup.  
Obrigatório: Sim

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

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

 ** [ValidationStatus](#API_PutRestoreValidationResult_RequestSyntax) **   <a name="Backup-PutRestoreValidationResult-request-ValidationStatus"></a>
O status da validação da sua restauração.  
Tipo: string  
Valores válidos: `FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING`   
Obrigatório: Sim

 ** [ValidationStatusMessage](#API_PutRestoreValidationResult_RequestSyntax) **   <a name="Backup-PutRestoreValidationResult-request-ValidationStatusMessage"></a>
Essa é uma string de mensagem opcional que você pode inserir para descrever o status da validação do teste de restauração.  
Tipo: string  
Obrigatório: não

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

```
HTTP/1.1 204
```

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

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

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

 ** 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_PutRestoreValidationResult_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/PutRestoreValidationResult) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/PutRestoreValidationResult) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/PutRestoreValidationResult) 

# RevokeRestoreAccessBackupVault
<a name="API_RevokeRestoreAccessBackupVault"></a>

Revoga o acesso a um cofre de backup de acesso para restauração, eliminando a capacidade de restauração de seus pontos de recuperação e excluindo o cofre permanentemente.

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

```
DELETE /logically-air-gapped-backup-vaults/backupVaultName/restore-access-backup-vaults/restoreAccessBackupVaultArn?requesterComment=RequesterComment HTTP/1.1
```

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

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

 ** [backupVaultName](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-RevokeRestoreAccessBackupVault-request-uri-BackupVaultName"></a>
O nome do cofre de backup de origem associado ao cofre de backup de acesso para restauração que deve ser revogado.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [RequesterComment](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-RevokeRestoreAccessBackupVault-request-uri-RequesterComment"></a>
Um comentário explicando o motivo da revogação do acesso ao cofre de backup de acesso para restauração.

 ** [restoreAccessBackupVaultArn](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **   <a name="Backup-RevokeRestoreAccessBackupVault-request-uri-RestoreAccessBackupVaultArn"></a>
O ARN do cofre de backup de acesso para restauração que deve ser revogado.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_RevokeRestoreAccessBackupVault_ResponseElements"></a>

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

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

 ** 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_RevokeRestoreAccessBackupVault_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/RevokeRestoreAccessBackupVault) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RevokeRestoreAccessBackupVault) 

# 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) 

# StartCopyJob
<a name="API_StartCopyJob"></a>

Inicia um trabalho para criar uma cópia única do recurso especificado.

Essa operação não é compatível com backups contínuos.

Consulte [Tentativa de tarefa de cópia](https://docs.aws.amazon.com/aws-backup/latest/devguide/recov-point-create-a-copy.html#backup-copy-retry) para obter informações sobre como AWS Backup repetir as operações de tarefa de cópia.

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

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

{
   "DestinationBackupVaultArn": "string",
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "RecoveryPointArn": "string",
   "SourceBackupVaultName": "string"
}
```

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

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

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

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

 ** [DestinationBackupVaultArn](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-DestinationBackupVaultArn"></a>
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup de destino. Por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: String  
Obrigatório: Sim

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

 ** [IdempotencyToken](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-IdempotencyToken"></a>
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas a `StartCopyJob`. 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](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-Lifecycle"></a>
Especifica o período, em dias, antes de um ponto de recuperação fazer a transição para o armazenamento a frio, ou seja excluído.  
Os backups transferidos para o armazenamento refrigerado devem ser armazenados em armazenamento refrigerado por no mínimo 90 dias. Portanto, no console, a configuração de retenção deve ser 90 dias a mais do que a transição para frio após a configuração de dias. A transição para frio após a configuração de dias não poderá ser alterada depois que um backup for transferido para 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.  
Para remover o ciclo de vida e os períodos de retenção existentes e manter seus pontos de recuperação indefinidamente, especifique -1 para `MoveToColdStorageAfterDays` e `DeleteAfterDays`.  
Tipo: objeto [Lifecycle](API_Lifecycle.md)  
Obrigatório: não

 ** [RecoveryPointArn](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-RecoveryPointArn"></a>
Um ARN que identifica de forma exclusiva um ponto de recuperação a ser usado na tarefa de cópia; por exemplo, arn:aws:backup:us-east- 1:123456789012:recovery-point:1 B5E7-9EB0-435A-A80B-108B488B0D45. EB3   
Tipo: String  
Obrigatório: Sim

 ** [SourceBackupVaultName](#API_StartCopyJob_RequestSyntax) **   <a name="Backup-StartCopyJob-request-SourceBackupVaultName"></a>
O nome de um contêiner lógico de origem em que os backups são armazenados. Os cofres de backup são identificados por nomes exclusivos da conta usada para criá-los e da AWS região em que foram criados.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: sim

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

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

{
   "CopyJobId": "string",
   "CreationDate": number,
   "IsParent": boolean
}
```

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

 ** [CopyJobId](#API_StartCopyJob_ResponseSyntax) **   <a name="Backup-StartCopyJob-response-CopyJobId"></a>
Identifica de forma exclusiva um trabalho de cópia.  
Tipo: string

 ** [CreationDate](#API_StartCopyJob_ResponseSyntax) **   <a name="Backup-StartCopyJob-response-CreationDate"></a>
A data e a hora em que um trabalho de cópia 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_StartCopyJob_ResponseSyntax) **   <a name="Backup-StartCopyJob-response-IsParent"></a>
Isso um valor booliano retornado que indica que se trata de um trabalho de cópia pai (composto).  
Tipo: booliano

## Erros
<a name="API_StartCopyJob_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_StartCopyJob_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/StartCopyJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartCopyJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartCopyJob) 

# StartReportJob
<a name="API_StartReportJob"></a>

Inicia um trabalho de relatório sob demanda para o plano de relatório especificado.

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

```
POST /audit/report-jobs/reportPlanName HTTP/1.1
Content-type: application/json

{
   "IdempotencyToken": "string"
}
```

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

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

 ** [reportPlanName](#API_StartReportJob_RequestSyntax) **   <a name="Backup-StartReportJob-request-uri-ReportPlanName"></a>
O nome exclusivo de um plano de relatório.  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

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

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

 ** [IdempotencyToken](#API_StartReportJob_RequestSyntax) **   <a name="Backup-StartReportJob-request-IdempotencyToken"></a>
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas para `StartReportJobInput`. 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

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

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

{
   "ReportJobId": "string"
}
```

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

 ** [ReportJobId](#API_StartReportJob_ResponseSyntax) **   <a name="Backup-StartReportJob-response-ReportJobId"></a>
O identificador do trabalho de relatório. Uma string Unicode exclusiva, gerada aleatoriamente, codificada em UTF-8, com, no máximo, 1.024 bytes. Não é possível editar o ID do trabalho de relatório.  
Tipo: string

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

 ** 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_StartReportJob_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/StartReportJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartReportJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartReportJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartReportJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartReportJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartReportJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartReportJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartReportJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartReportJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartReportJob) 

# StartRestoreJob
<a name="API_StartRestoreJob"></a>

Recupera o recurso salvo identificado por um Nome do recurso da Amazon (ARN).

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

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

{
   "CopySourceTagsToRestoredResource": boolean,
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "Metadata": { 
      "string" : "string" 
   },
   "RecoveryPointArn": "string",
   "ResourceType": "string"
}
```

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

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

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

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

 ** [CopySourceTagsToRestoredResource](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-CopySourceTagsToRestoredResource"></a>
Esse parâmetro é opcional. Se isso for igual a `True`, as tags incluídas no backup serão copiadas para o recurso restaurado.  
Isso só pode ser aplicado aos backups criados por meio de AWS Backup.  
Tipo: booliano  
Obrigatório: não

 ** [IamRoleArn](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-IamRoleArn"></a>
O Amazon Resource Name (ARN) da função do IAM AWS Backup usada para criar o recurso de destino; por exemplo:. `arn:aws:iam::123456789012:role/S3Access`  
Tipo: string  
Obrigatório: não

 ** [IdempotencyToken](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-IdempotencyToken"></a>
Uma string escolhida pelo cliente que você pode usar para distinguir entre chamadas idênticas para `StartRestoreJob`. 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

 ** [Metadata](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-Metadata"></a>
Um conjunto de pares de chave/valor de metadados.  
É possível obter metadados de configuração sobre um recurso no momento em que o backup foi feito por meio de uma chamada a `GetRecoveryPointRestoreMetadata`. No entanto, valores além dos fornecidos por `GetRecoveryPointRestoreMetadata` podem ser necessários para restaurar um recurso. Por exemplo, talvez seja necessário fornecer um novo nome de recurso caso o original já exista.  
Para obter mais informações sobre os metadados para cada recurso, consulte:  
+  [Metadados para Amazon Aurora](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli) 
+  [Metadados para for Amazon DocumentDB](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli) 
+  [Metadados para AWS CloudFormation](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli) 
+  [Metadados para o Amazon DynamoDB](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli) 
+  [ Metadados para Amazon EBS](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli) 
+  [Metadados para Amazon EC2](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli) 
+  [Metadados para Amazon EFS](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli) 
+  [Metadados para Amazon EKS](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-eks.html#eks-restore-backup-section) 
+  [Metadados para Amazon FSx](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli) 
+  [Metadados para o Amazon Neptune](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli) 
+  [Metadados para Amazon RDS](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli) 
+  [Metadados para o Amazon Redshift](https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api) 
+  [Metadados para AWS Storage Gateway](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli) 
+  [Metadados para o Amazon S3](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli) 
+  [Metadados para Amazon Timestream](https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api) 
+  [Metadados para máquinas virtuais](https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli) 
Tipo: mapa de string para string  
Obrigatório: Sim

 ** [RecoveryPointArn](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-RecoveryPointArn"></a>
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  
Obrigatório: Sim

 ** [ResourceType](#API_StartRestoreJob_RequestSyntax) **   <a name="Backup-StartRestoreJob-request-ResourceType"></a>
Inicia um trabalho para restaurar um ponto de recuperação para um dos seguintes recursos:  
+  `Aurora`: Amazon Aurora
+  `DocumentDB`: Amazon DocumentDB
+  `CloudFormation` - AWS CloudFormation 
+  `DynamoDB`: Amazon DynamoDB
+  `EBS`: Amazon Elastic Block Store
+  `EC2`: Amazon Elastic Compute Cloud
+  `EFS`: Amazon Elastic File System
+  `EKS`- Amazon Elastic Kubernetes Service
+  `FSx`- Amazon FSx
+  `Neptune`: Amazon Neptune
+  `RDS`: Amazon Relational Database Service
+  `Redshift`: Amazon Redshift
+  `Storage Gateway` - AWS Storage Gateway 
+  `S3`: Amazon Simple Storage Service
+  `Timestream`: Amazon Timestream
+  `VirtualMachine`: Máquinas virtuais
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
Obrigatório: Não

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

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

{
   "RestoreJobId": "string"
}
```

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

 ** [RestoreJobId](#API_StartRestoreJob_ResponseSyntax) **   <a name="Backup-StartRestoreJob-response-RestoreJobId"></a>
Identifica de forma exclusiva o trabalho que restaura um ponto de recuperação.  
Tipo: string

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

 ** 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_StartRestoreJob_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/StartRestoreJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartRestoreJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartRestoreJob) 

# StartScanJob
<a name="API_StartScanJob"></a>

Inicia trabalhos de varredura em busca de recursos específicos.

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

```
PUT /scan/job HTTP/1.1
Content-type: application/json

{
   "BackupVaultName": "string",
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "MalwareScanner": "string",
   "RecoveryPointArn": "string",
   "ScanBaseRecoveryPointArn": "string",
   "ScanMode": "string",
   "ScannerRoleArn": "string"
}
```

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

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

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

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

 ** [BackupVaultName](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-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 exclusivos da conta usada para criá-los e da AWS região em que foram criados.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Tipo: String  
Obrigatório: Sim

 ** [IamRoleArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-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_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-IdempotencyToken"></a>
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas a `StartScanJob`. 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

 ** [MalwareScanner](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-MalwareScanner"></a>
Especifica o verificador de malware usado durante o trabalho de verificação. No momento, oferece suporte apenas a `GUARDDUTY`.  
Tipo: string  
Valores válidos: `GUARDDUTY`   
Obrigatório: Sim

 ** [RecoveryPointArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-RecoveryPointArn"></a>
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva um ponto de recuperação. Este é o ponto de recuperação de destino para uma verificação completa. Se você estiver executando uma verificação incremental, esse será o ponto de recuperação criado após a seleção do ponto de recuperação básico.  
Tipo: String  
Obrigatório: Sim

 ** [ScanBaseRecoveryPointArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-ScanBaseRecoveryPointArn"></a>
Um ARN que identifica de forma exclusiva o ponto de recuperação básico a ser usado para varredura incremental.  
Tipo: string  
Obrigatório: não

 ** [ScanMode](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-ScanMode"></a>
Especifica o tipo de escaneamento usado para o trabalho de escaneamento.  
Inclui:  
+  `FULL_SCAN`digitalizará toda a linhagem de dados dentro do backup.
+  `INCREMENTAL_SCAN`examinará a diferença de dados entre o ponto de recuperação de destino e o ARN do ponto de recuperação básico.
Tipo: string  
Valores válidos: `FULL_SCAN | INCREMENTAL_SCAN`   
Obrigatório: Sim

 ** [ScannerRoleArn](#API_StartScanJob_RequestSyntax) **   <a name="Backup-StartScanJob-request-ScannerRoleArn"></a>
Especificou o ARN da função do scanner do IAM.  
Tipo: String  
Obrigatório: sim

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

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

{
   "CreationDate": number,
   "ScanJobId": "string"
}
```

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

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

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

 ** [CreationDate](#API_StartScanJob_ResponseSyntax) **   <a name="Backup-StartScanJob-response-CreationDate"></a>
A data e hora em que o trabalho de backup foi criado, em formato de hora 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

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

## Erros
<a name="API_StartScanJob_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_StartScanJob_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/StartScanJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StartScanJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StartScanJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StartScanJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StartScanJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StartScanJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StartScanJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StartScanJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StartScanJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StartScanJob) 

# StopBackupJob
<a name="API_StopBackupJob"></a>

Tenta cancelar um trabalho para criar um backup único de um recurso.

Essa ação não é compatível com os seguintes serviços:
+ Amazon Aurora
+ Amazon DocumentDB (compatível com MongoDB)
+ Amazon FSx para Lustre
+ Amazon FSx para NetApp ONTAP
+ Amazon FSx para OpenZFS
+ Servidor FSx de arquivos Amazon para Windows
+ Amazon Neptune
+ Bancos de dados SAP HANA em instâncias da Amazon EC2 
+ Amazon RDS

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

```
POST /backup-jobs/backupJobId HTTP/1.1
```

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

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

 ** [backupJobId](#API_StopBackupJob_RequestSyntax) **   <a name="Backup-StopBackupJob-request-uri-BackupJobId"></a>
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_StopBackupJob_ResponseElements"></a>

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

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

 ** 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_StopBackupJob_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/StopBackupJob) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/StopBackupJob) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/StopBackupJob) 

# TagResource
<a name="API_TagResource"></a>

Atribui um conjunto de pares de chave-valor a um recurso.

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

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

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

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

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="Backup-TagResource-request-uri-ResourceArn"></a>
O ARN identifica de forma exclusiva o recurso.  
Obrigatório: Sim

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

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

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="Backup-TagResource-request-Tags"></a>
Os pares de chave/valor que são usados para ajudar a organizar seus recursos. É possível atribuir seus próprios metadados aos recursos que você criar. Para maior clareza, esta é a estrutura para atribuir tags: `[{"Key":"string","Value":"string"}]`.  
Tipo: mapa de string para string  
Obrigatório: sim

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_TagResource_ResponseElements"></a>

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

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

 ** 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_TagResource_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/TagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/TagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/TagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/TagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/TagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/TagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/TagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Remove um conjunto de pares de chave/valor de um ponto de recuperação, plano de backup ou cofre de backup identificado por um Nome do recurso da Amazon (ARN)

Essa API não é compatível com pontos de recuperação de tipos de recursos, incluindo Aurora e Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune e Amazon RDS.

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

```
POST /untag/resourceArn HTTP/1.1
Content-type: application/json

{
   "TagKeyList": [ "string" ]
}
```

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

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

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="Backup-UntagResource-request-uri-ResourceArn"></a>
Um ARN identifica de forma exclusiva um recurso. O formato do ARN depende do tipo do recurso marcado.  
ARNs que não incluem `backup` são incompatíveis com a marcação. `TagResource`e `UntagResource` com inválido ARNs resultará em um erro. O conteúdo de ARN aceitável pode incluir `arn:aws:backup:us-east`. O conteúdo de ARN inválido pode parecer assim `arn:aws:ec2:us-east`.  
Obrigatório: Sim

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

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

 ** [TagKeyList](#API_UntagResource_RequestSyntax) **   <a name="Backup-UntagResource-request-TagKeyList"></a>
A lista de chaves para identificar quais tags de chave/valor serão removidas de um recurso.  
Tipo: matriz de strings  
Obrigatório: sim

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_UntagResource_ResponseElements"></a>

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

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

 ** 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_UntagResource_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/UntagResource) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UntagResource) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UntagResource) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UntagResource) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UntagResource) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UntagResource) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UntagResource) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UntagResource) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UntagResource) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UntagResource) 

# UpdateBackupPlan
<a name="API_UpdateBackupPlan"></a>

Atualiza o plano de backup especificado. A nova versão é identificada de forma exclusiva pelo ID.

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

```
POST /backup/plans/backupPlanId HTTP/1.1
Content-type: application/json

{
   "BackupPlan": { 
      "AdvancedBackupSettings": [ 
         { 
            "BackupOptions": { 
               "string" : "string" 
            },
            "ResourceType": "string"
         }
      ],
      "BackupPlanName": "string",
      "Rules": [ 
         { 
            "CompletionWindowMinutes": number,
            "CopyActions": [ 
               { 
                  "DestinationBackupVaultArn": "string",
                  "Lifecycle": { 
                     "DeleteAfterDays": number,
                     "DeleteAfterEvent": "string",
                     "MoveToColdStorageAfterDays": number,
                     "OptInToArchiveForSupportedResources": boolean
                  }
               }
            ],
            "EnableContinuousBackup": boolean,
            "IndexActions": [ 
               { 
                  "ResourceTypes": [ "string" ]
               }
            ],
            "Lifecycle": { 
               "DeleteAfterDays": number,
               "DeleteAfterEvent": "string",
               "MoveToColdStorageAfterDays": number,
               "OptInToArchiveForSupportedResources": boolean
            },
            "RecoveryPointTags": { 
               "string" : "string" 
            },
            "RuleName": "string",
            "ScanActions": [ 
               { 
                  "MalwareScanner": "string",
                  "ScanMode": "string"
               }
            ],
            "ScheduleExpression": "string",
            "ScheduleExpressionTimezone": "string",
            "StartWindowMinutes": number,
            "TargetBackupVaultName": "string",
            "TargetLogicallyAirGappedBackupVaultArn": "string"
         }
      ],
      "ScanSettings": [ 
         { 
            "MalwareScanner": "string",
            "ResourceTypes": [ "string" ],
            "ScannerRoleArn": "string"
         }
      ]
   }
}
```

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

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

 ** [backupPlanId](#API_UpdateBackupPlan_RequestSyntax) **   <a name="Backup-UpdateBackupPlan-request-uri-BackupPlanId"></a>
O ID do plano de backup.  
Obrigatório: Sim

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

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

 ** [BackupPlan](#API_UpdateBackupPlan_RequestSyntax) **   <a name="Backup-UpdateBackupPlan-request-BackupPlan"></a>
O corpo de um plano de backup. Inclui um `BackupPlanName` e um ou mais conjuntos de `Rules`.  
Tipo: objeto [BackupPlanInput](API_BackupPlanInput.md)  
Obrigatório: sim

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

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

{
   "AdvancedBackupSettings": [ 
      { 
         "BackupOptions": { 
            "string" : "string" 
         },
         "ResourceType": "string"
      }
   ],
   "BackupPlanArn": "string",
   "BackupPlanId": "string",
   "CreationDate": number,
   "ScanSettings": [ 
      { 
         "MalwareScanner": "string",
         "ResourceTypes": [ "string" ],
         "ScannerRoleArn": "string"
      }
   ],
   "VersionId": "string"
}
```

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

 ** [AdvancedBackupSettings](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-AdvancedBackupSettings"></a>
Contém uma lista de `BackupOptions` para cada tipo de recurso.  
Tipo: matriz de objetos [AdvancedBackupSetting](API_AdvancedBackupSetting.md)

 ** [BackupPlanArn](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-BackupPlanArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um plano de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50`.  
Tipo: string

 ** [BackupPlanId](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-BackupPlanId"></a>
Identifica de forma exclusiva um plano de backup.  
Tipo: string

 ** [CreationDate](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-CreationDate"></a>
A data e hora em que um plano de backup foi criada, 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

 ** [ScanSettings](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-ScanSettings"></a>
Contém sua configuração de escaneamento para o plano de backup e inclui o verificador de malware, seus recursos selecionados e a função de scanner.  
Tipo: matriz de objetos [ScanSetting](API_ScanSetting.md)

 ** [VersionId](#API_UpdateBackupPlan_ResponseSyntax) **   <a name="Backup-UpdateBackupPlan-response-VersionId"></a>
Strings Unicode exclusivas geradas aleatoriamente, codificadas em UTF-8 que têm no máximo 1.024 bytes. IDs de versão não podem ser editados.  
Tipo: string

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

 ** 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_UpdateBackupPlan_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/UpdateBackupPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateBackupPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateBackupPlan) 

# UpdateFramework
<a name="API_UpdateFramework"></a>

Atualiza o framework especificada.

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

```
PUT /audit/frameworks/frameworkName HTTP/1.1
Content-type: application/json

{
   "FrameworkControls": [ 
      { 
         "ControlInputParameters": [ 
            { 
               "ParameterName": "string",
               "ParameterValue": "string"
            }
         ],
         "ControlName": "string",
         "ControlScope": { 
            "ComplianceResourceIds": [ "string" ],
            "ComplianceResourceTypes": [ "string" ],
            "Tags": { 
               "string" : "string" 
            }
         }
      }
   ],
   "FrameworkDescription": "string",
   "IdempotencyToken": "string"
}
```

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

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

 ** [frameworkName](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-uri-FrameworkName"></a>
O nome exclusivo de uma framework. Esse nome tem entre 1 e 256 caracteres, começando com uma letra, e consiste em letras (a-z, A-Z), números (0-9) e sublinhados (\$1).  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

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

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

 ** [FrameworkControls](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-FrameworkControls"></a>
Os controles que compõem o framework. Cada controle na lista tem um nome, parâmetros de entrada e escopo.  
Tipo: matriz de objetos [FrameworkControl](API_FrameworkControl.md)  
Obrigatório: não

 ** [FrameworkDescription](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-FrameworkDescription"></a>
Uma descrição opcional da framework com no máximo 1.024 caracteres.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.  
Padrão: `.*\S.*`   
Obrigatório: não

 ** [IdempotencyToken](#API_UpdateFramework_RequestSyntax) **   <a name="Backup-UpdateFramework-request-IdempotencyToken"></a>
Uma string escolhida pelo cliente que você pode usar para distinguir entre chamadas idênticas para `UpdateFrameworkInput`. 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

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

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

{
   "CreationTime": number,
   "FrameworkArn": "string",
   "FrameworkName": "string"
}
```

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

 ** [CreationTime](#API_UpdateFramework_ResponseSyntax) **   <a name="Backup-UpdateFramework-response-CreationTime"></a>
A data e a hora em que a framework é criada, na representação ISO 8601. O valor de `CreationTime` tem precisão de milissegundos. Por exemplo, 2020-07-10T15:00:00.000-08:00 representa o dia 10 de julho de 2020 às 15:00, 8 horas antes do UTC.  
Tipo: Timestamp

 ** [FrameworkArn](#API_UpdateFramework_ResponseSyntax) **   <a name="Backup-UpdateFramework-response-FrameworkArn"></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

 ** [FrameworkName](#API_UpdateFramework_ResponseSyntax) **   <a name="Backup-UpdateFramework-response-FrameworkName"></a>
O nome exclusivo de uma framework. Esse nome tem entre 1 e 256 caracteres, começando com uma letra, e consiste em letras (a-z, A-Z), números (0-9) e sublinhados (\$1).  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*` 

## Erros
<a name="API_UpdateFramework_Errors"></a>

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

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** ConflictException **   
 AWS Backup não pode realizar a ação que você solicitou até que termine de executar uma ação anterior. Tente novamente mais tarde.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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_UpdateFramework_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/UpdateFramework) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateFramework) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateFramework) 

# UpdateGlobalSettings
<a name="API_UpdateGlobalSettings"></a>

Atualiza se a AWS conta ativou diferentes opções de gerenciamento entre contas, incluindo backup entre contas, aprovação de várias partes e administrador delegado. Retorna um erro se a conta não for uma conta de gerenciamento do Organizations. Use a API `DescribeGlobalSettings` para determinar as configurações atuais.

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

```
PUT /global-settings HTTP/1.1
Content-type: application/json

{
   "GlobalSettings": { 
      "string" : "string" 
   }
}
```

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

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

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

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

 ** [GlobalSettings](#API_UpdateGlobalSettings_RequestSyntax) **   <a name="Backup-UpdateGlobalSettings-request-GlobalSettings"></a>
As entradas podem incluir:  
Um valor para`isCrossAccountBackupEnabled`. Os valores podem ser true (verdadeiro) ou false (falso). Exemplo: `update-global-settings --global-settings isCrossAccountBackupEnabled=false`.  
Um valor para aprovação multipartidária, denominado como. `isMpaEnabled` Os valores podem ser true (verdadeiro) ou false (falso). Exemplo: `update-global-settings --global-settings isMpaEnabled=false`.  
Um valor para a criação da função vinculada ao serviço de backup, denominado como. `isDelegatedAdministratorEnabled` Os valores podem ser true (verdadeiro) ou false (falso). Exemplo: `update-global-settings --global-settings isDelegatedAdministratorEnabled=false`.  
Tipo: mapa de string para string  
Obrigatório: Não

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

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_UpdateGlobalSettings_ResponseElements"></a>

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

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

 ** MissingParameterValueException **   
Indica que um parâmetro necessário está ausente.    
 ** 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_UpdateGlobalSettings_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/UpdateGlobalSettings) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateGlobalSettings) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateGlobalSettings) 

# UpdateRecoveryPointIndexSettings
<a name="API_UpdateRecoveryPointIndexSettings"></a>

Essa operação atualiza as configurações de um índice de ponto de recuperação.

Obrigatório: BackupVaultName, RecoveryPointArn, e IAMRole Arn

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

```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/index HTTP/1.1
Content-type: application/json

{
   "IamRoleArn": "string",
   "Index": "string"
}
```

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

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

 ** [backupVaultName](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-uri-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 em que são criados.  
Os caracteres aceitos incluem letras minúsculas, números e hifens.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [recoveryPointArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-uri-RecoveryPointArn"></a>
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`.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_UpdateRecoveryPointIndexSettings_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [IamRoleArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-IamRoleArn"></a>
Isso especifica o ARN do perfil do IAM usado para essa operação.  
Por exemplo, arn:aws:iam::123456789012:role/S3Access  
Tipo: string  
Obrigatório: não

 ** [Index](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-request-Index"></a>
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: sim

## Sintaxe da resposta
<a name="API_UpdateRecoveryPointIndexSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupVaultName": "string",
   "Index": "string",
   "IndexStatus": "string",
   "RecoveryPointArn": "string"
}
```

## Elementos de resposta
<a name="API_UpdateRecoveryPointIndexSettings_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.

 ** [BackupVaultName](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-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 em que são criados.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$` 

 ** [Index](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-Index"></a>
O índice pode ter 1 de 2 valores possíveis, `ENABLED` ou `DISABLED`.  
Um valor de `ENABLED` significa que um índice de backup para um ponto de recuperação `ACTIVE` elegível foi criado.  
Um valor de `DISABLED` significa que um índice de backup foi excluído.  
Tipo: string  
Valores válidos: `ENABLED | DISABLED` 

 ** [IndexStatus](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-IndexStatus"></a>
Esse é o status atual do índice de backup associado ao ponto de recuperação especificado.  
Os status são: `PENDING` \$1 `ACTIVE` \$1 `FAILED` \$1 `DELETING`   
Um ponto de recuperação com um índice que possui o status de `ACTIVE` pode ser incluído em uma pesquisa.  
Tipo: string  
Valores válidos: `PENDING | ACTIVE | FAILED | DELETING` 

 ** [RecoveryPointArn](#API_UpdateRecoveryPointIndexSettings_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointIndexSettings-response-RecoveryPointArn"></a>
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_UpdateRecoveryPointIndexSettings_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

 ** 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_UpdateRecoveryPointIndexSettings_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/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRecoveryPointIndexSettings) 

# UpdateRecoveryPointLifecycle
<a name="API_UpdateRecoveryPointLifecycle"></a>

Define o ciclo de vida de transição de um ponto de recuperação.

O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup faz a transição e expira os backups automaticamente de acordo com o ciclo de vida definido por você.

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.

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.

**Importante**  
Se seu ciclo de vida atualmente usa os parâmetros `DeleteAfterDays` e `MoveToColdStorageAfterDays`, inclua esses parâmetros e seus valores ao chamar essa operação. Não incluí-los pode resultar na atualização do seu plano com valores nulos.

Essa operação não é compatível com backups contínuos.

## Sintaxe da Solicitação
<a name="API_UpdateRecoveryPointLifecycle_RequestSyntax"></a>

```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1
Content-type: application/json

{
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   }
}
```

## Parâmetros da Solicitação de URI
<a name="API_UpdateRecoveryPointLifecycle_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [backupVaultName](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-request-uri-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.  
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`   
Obrigatório: Sim

 ** [recoveryPointArn](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-request-uri-RecoveryPointArn"></a>
Um Nome do recurso da Amazon (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`.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_UpdateRecoveryPointLifecycle_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [Lifecycle](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-request-Lifecycle"></a>
O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup faz a transição e expira os backups automaticamente de acordo com o ciclo de vida definido por você.   
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.   
Tipo: objeto [Lifecycle](API_Lifecycle.md)  
Obrigatório: não

## Sintaxe da resposta
<a name="API_UpdateRecoveryPointLifecycle_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "BackupVaultArn": "string",
   "CalculatedLifecycle": { 
      "DeleteAt": number,
      "MoveToColdStorageAt": number
   },
   "Lifecycle": { 
      "DeleteAfterDays": number,
      "DeleteAfterEvent": "string",
      "MoveToColdStorageAfterDays": number,
      "OptInToArchiveForSupportedResources": boolean
   },
   "RecoveryPointArn": "string"
}
```

## Elementos de resposta
<a name="API_UpdateRecoveryPointLifecycle_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.

 ** [BackupVaultArn](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-response-BackupVaultArn"></a>
Um ARN que identifica de forma exclusiva um cofre de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: string

 ** [CalculatedLifecycle](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-response-CalculatedLifecycle"></a>
Um objeto `CalculatedLifecycle` que contém os timestamps `MoveToColdStorageAt` e `DeleteAt`.  
Tipo: objeto [CalculatedLifecycle](API_CalculatedLifecycle.md)

 ** [Lifecycle](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-response-Lifecycle"></a>
O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup faz a transição e expira os backups automaticamente de acordo com o ciclo de vida definido por você.  
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.  
Tipo: objeto [Lifecycle](API_Lifecycle.md)

 ** [RecoveryPointArn](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **   <a name="Backup-UpdateRecoveryPointLifecycle-response-RecoveryPointArn"></a>
Um Nome do recurso da Amazon (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_UpdateRecoveryPointLifecycle_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

 ** 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_UpdateRecoveryPointLifecycle_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/UpdateRecoveryPointLifecycle) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRecoveryPointLifecycle) 

# UpdateRegionSettings
<a name="API_UpdateRegionSettings"></a>

Atualiza as configurações atuais de inclusão do serviço para a região.

Use a API `DescribeRegionSettings` para determinar os tipos de recursos compatíveis.

## Sintaxe da Solicitação
<a name="API_UpdateRegionSettings_RequestSyntax"></a>

```
PUT /account-settings HTTP/1.1
Content-type: application/json

{
   "ResourceTypeManagementPreference": { 
      "string" : boolean 
   },
   "ResourceTypeOptInPreference": { 
      "string" : boolean 
   }
}
```

## Parâmetros da solicitação de URI
<a name="API_UpdateRegionSettings_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_UpdateRegionSettings_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [ResourceTypeManagementPreference](#API_UpdateRegionSettings_RequestSyntax) **   <a name="Backup-UpdateRegionSettings-request-ResourceTypeManagementPreference"></a>
Ativa ou desativa o AWS Backup gerenciamento completo de backups para um tipo de recurso. [Para habilitar o AWS Backup gerenciamento completo do DynamoDB junto com os recursos [avançados de backup AWS Backup do DynamoDB, siga o procedimento para habilitar programaticamente o backup avançado do DynamoDB](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html).](https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli)  
Tipo: mapa de string para booliano  
Padrão da chave: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
Obrigatório: não

 ** [ResourceTypeOptInPreference](#API_UpdateRegionSettings_RequestSyntax) **   <a name="Backup-UpdateRegionSettings-request-ResourceTypeOptInPreference"></a>
Atualiza a lista de serviços junto com as preferências de inclusão para a região.  
Se as atribuições de recursos forem baseadas somente em tags, as configurações de inclusão do serviço serão aplicadas. Se um tipo de recurso for explicitamente atribuído a um plano de backup, como Amazon S3, Amazon ou EC2 Amazon RDS, ele será incluído no backup mesmo que o opt-in não esteja habilitado para esse serviço específico. Se o tipo de recurso e as tags forem especificados em uma atribuição de recurso, o tipo de recurso especificado no plano de backup terá prioridade sobre a condição da tag. As configurações de inclusão do serviço serão desconsideradas nessa situação.  
Tipo: mapa de string para booliano  
Padrão da chave: `^[a-zA-Z0-9\-\_\.]{1,50}$`   
Obrigatório: não

## Sintaxe da resposta
<a name="API_UpdateRegionSettings_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_UpdateRegionSettings_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

## Erros
<a name="API_UpdateRegionSettings_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

 ** MissingParameterValueException **   
Indica que um parâmetro necessário está ausente.    
 ** 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_UpdateRegionSettings_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/UpdateRegionSettings) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRegionSettings) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRegionSettings) 

# UpdateReportPlan
<a name="API_UpdateReportPlan"></a>

Atualiza o plano de relatório especificado.

## Sintaxe da Solicitação
<a name="API_UpdateReportPlan_RequestSyntax"></a>

```
PUT /audit/report-plans/reportPlanName HTTP/1.1
Content-type: application/json

{
   "IdempotencyToken": "string",
   "ReportDeliveryChannel": { 
      "Formats": [ "string" ],
      "S3BucketName": "string",
      "S3KeyPrefix": "string"
   },
   "ReportPlanDescription": "string",
   "ReportSetting": { 
      "Accounts": [ "string" ],
      "FrameworkArns": [ "string" ],
      "NumberOfFrameworks": number,
      "OrganizationUnits": [ "string" ],
      "Regions": [ "string" ],
      "ReportTemplate": "string"
   }
}
```

## Parâmetros da Solicitação de URI
<a name="API_UpdateReportPlan_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [reportPlanName](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-uri-ReportPlanName"></a>
O nome exclusivo do plano de relatório. Esse nome tem entre 1 e 256 caracteres, começando com uma letra, e consiste em letras (a-z, A-Z), números (0-9) e sublinhados (\$1).  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*`   
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_UpdateReportPlan_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [IdempotencyToken](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-IdempotencyToken"></a>
Uma string escolhida pelo cliente que pode ser usada para distinguir entre chamadas idênticas para `UpdateReportPlanInput`. 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

 ** [ReportDeliveryChannel](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-ReportDeliveryChannel"></a>
Contém informações sobre onde e como entregar seus relatórios, especificamente o nome do bucket do Amazon S3, o prefixo de chave do S3 e os formatos dos relatórios.  
Tipo: objeto [ReportDeliveryChannel](API_ReportDeliveryChannel.md)  
Obrigatório: não

 ** [ReportPlanDescription](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-ReportPlanDescription"></a>
Uma descrição opcional do plano de relatório com no máximo 1.024 caracteres.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.  
Padrão: `.*\S.*`   
Obrigatório: não

 ** [ReportSetting](#API_UpdateReportPlan_RequestSyntax) **   <a name="Backup-UpdateReportPlan-request-ReportSetting"></a>
O modelo do relatório. Relatórios são criados utilizando um modelo de relatório. Os modelos de relatório são:  
 `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`   
Se o modelo de relatório for `RESOURCE_COMPLIANCE_REPORT` ou`CONTROL_COMPLIANCE_REPORT`, esse recurso de API também descreve a cobertura do relatório por Regiões da AWS estruturas.  
Tipo: objeto [ReportSetting](API_ReportSetting.md)  
Obrigatório: não

## Sintaxe da resposta
<a name="API_UpdateReportPlan_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "ReportPlanArn": "string",
   "ReportPlanName": "string"
}
```

## Elementos de resposta
<a name="API_UpdateReportPlan_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.

 ** [CreationTime](#API_UpdateReportPlan_ResponseSyntax) **   <a name="Backup-UpdateReportPlan-response-CreationTime"></a>
A data e hora em que um plano de relatório foi criado, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CreationTime` 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

 ** [ReportPlanArn](#API_UpdateReportPlan_ResponseSyntax) **   <a name="Backup-UpdateReportPlan-response-ReportPlanArn"></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

 ** [ReportPlanName](#API_UpdateReportPlan_ResponseSyntax) **   <a name="Backup-UpdateReportPlan-response-ReportPlanName"></a>
O nome exclusivo do plano de relatório.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z][_a-zA-Z0-9]*` 

## Erros
<a name="API_UpdateReportPlan_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** ConflictException **   
 AWS Backup não pode realizar a ação que você solicitou até que ela termine de executar uma ação anterior. Tente novamente mais tarde.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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_UpdateReportPlan_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/UpdateReportPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateReportPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateReportPlan) 

# UpdateRestoreTestingPlan
<a name="API_UpdateRestoreTestingPlan"></a>

Essa solicitação enviará alterações ao plano de testes de restauração especificado. `RestoreTestingPlanName` não pode ser atualizado após a criação.

 `RecoveryPointSelection` pode conter:
+  `Algorithm` 
+  `ExcludeVaults` 
+  `IncludeVaults` 
+  `RecoveryPointTypes` 
+  `SelectionWindowDays` 

## Sintaxe da Solicitação
<a name="API_UpdateRestoreTestingPlan_RequestSyntax"></a>

```
PUT /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
Content-type: application/json

{
   "RestoreTestingPlan": { 
      "RecoveryPointSelection": { 
         "Algorithm": "string",
         "ExcludeVaults": [ "string" ],
         "IncludeVaults": [ "string" ],
         "RecoveryPointTypes": [ "string" ],
         "SelectionWindowDays": number
      },
      "ScheduleExpression": "string",
      "ScheduleExpressionTimezone": "string",
      "StartWindowHours": number
   }
}
```

## Parâmetros da Solicitação de URI
<a name="API_UpdateRestoreTestingPlan_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-request-uri-RestoreTestingPlanName"></a>
O nome do plano de teste de restauração.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_UpdateRestoreTestingPlan_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [RestoreTestingPlan](#API_UpdateRestoreTestingPlan_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-request-RestoreTestingPlan"></a>
Especifica o corpo de um plano de testes de restauração.  
Tipo: objeto [RestoreTestingPlanForUpdate](API_RestoreTestingPlanForUpdate.md)  
Obrigatório: sim

## Sintaxe da resposta
<a name="API_UpdateRestoreTestingPlan_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "RestoreTestingPlanArn": "string",
   "RestoreTestingPlanName": "string",
   "UpdateTime": number
}
```

## Elementos de resposta
<a name="API_UpdateRestoreTestingPlan_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.

 ** [CreationTime](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-CreationTime"></a>
A hora em que o plano de teste de restauração foi criado.  
Tipo: Timestamp

 ** [RestoreTestingPlanArn](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-RestoreTestingPlanArn"></a>
ARN (nome do recurso da Amazon) exclusivo do plano de testes de restauração.  
Tipo: string

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-RestoreTestingPlanName"></a>
O nome não poderá ser alterado após a criação. Ele só pode conter caracteres alfanuméricos e sublinhados. O tamanho máximo é 50.  
Tipo: string

 ** [UpdateTime](#API_UpdateRestoreTestingPlan_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingPlan-response-UpdateTime"></a>
A hora em que a atualização do plano de teste de restauração foi concluída.  
Tipo: Timestamp

## Erros
<a name="API_UpdateRestoreTestingPlan_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** ConflictException **   
 AWS Backup não pode realizar a ação que você solicitou até que termine de executar uma ação anterior. Tente novamente mais tarde.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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_UpdateRestoreTestingPlan_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/UpdateRestoreTestingPlan) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRestoreTestingPlan) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRestoreTestingPlan) 

# UpdateRestoreTestingSelection
<a name="API_UpdateRestoreTestingSelection"></a>

Atualiza a seleção de teste de restauração especificada.

A maioria dos elementos, exceto `RestoreTestingSelectionName`, pode ser atualizada com essa solicitação.

Você pode usar um recurso ARNs ou condições protegidas, mas não ambos.

## Sintaxe da Solicitação
<a name="API_UpdateRestoreTestingSelection_RequestSyntax"></a>

```
PUT /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
Content-type: application/json

{
   "RestoreTestingSelection": { 
      "IamRoleArn": "string",
      "ProtectedResourceArns": [ "string" ],
      "ProtectedResourceConditions": { 
         "StringEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "StringNotEquals": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      },
      "RestoreMetadataOverrides": { 
         "string" : "string" 
      },
      "ValidationWindowHours": number
   }
}
```

## Parâmetros da Solicitação de URI
<a name="API_UpdateRestoreTestingSelection_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-request-uri-RestoreTestingPlanName"></a>
O nome do plano de testes de restauração é necessário para atualizar o plano de testes indicado.  
Obrigatório: Sim

 ** [RestoreTestingSelectionName](#API_UpdateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-request-uri-RestoreTestingSelectionName"></a>
O nome necessário da seleção de teste de restauração que você deseja atualizar.  
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_UpdateRestoreTestingSelection_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [RestoreTestingSelection](#API_UpdateRestoreTestingSelection_RequestSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-request-RestoreTestingSelection"></a>
Para atualizar sua seleção de testes de restauração, você pode usar recursos ARNs ou condições protegidos, mas não ambos. Ou seja, se a sua seleção tiver `ProtectedResourceArns`, a solicitação de uma atualização com o parâmetro `ProtectedResourceConditions` não será bem-sucedida.  
Tipo: objeto [RestoreTestingSelectionForUpdate](API_RestoreTestingSelectionForUpdate.md)  
Obrigatório: sim

## Sintaxe da resposta
<a name="API_UpdateRestoreTestingSelection_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "RestoreTestingPlanArn": "string",
   "RestoreTestingPlanName": "string",
   "RestoreTestingSelectionName": "string",
   "UpdateTime": number
}
```

## Elementos de resposta
<a name="API_UpdateRestoreTestingSelection_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.

 ** [CreationTime](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-CreationTime"></a>
A hora em que a seleção de testes de recursos foi atualizada com sucesso.  
Tipo: Timestamp

 ** [RestoreTestingPlanArn](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-RestoreTestingPlanArn"></a>
Essa string exclusiva é o nome do plano de testes de restauração.  
Tipo: string

 ** [RestoreTestingPlanName](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-RestoreTestingPlanName"></a>
O plano de teste de restauração ao qual a seleção de teste de restauração atualizada está associada.  
Tipo: string

 ** [RestoreTestingSelectionName](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-RestoreTestingSelectionName"></a>
O nome da seleção de teste de restauração retornado.  
Tipo: string

 ** [UpdateTime](#API_UpdateRestoreTestingSelection_ResponseSyntax) **   <a name="Backup-UpdateRestoreTestingSelection-response-UpdateTime"></a>
A hora em que a atualização foi concluída para a seleção de teste de restauração.  
Tipo: Timestamp

## Erros
<a name="API_UpdateRestoreTestingSelection_Errors"></a>

Para informações sobre os erros comuns retornados pelas ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** ConflictException **   
 AWS Backup não pode realizar a ação que você solicitou até que termine de executar uma ação anterior. Tente novamente mais tarde.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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_UpdateRestoreTestingSelection_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/UpdateRestoreTestingSelection) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateRestoreTestingSelection) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateRestoreTestingSelection) 

# UpdateTieringConfiguration
<a name="API_UpdateTieringConfiguration"></a>

Essa solicitação enviará alterações na configuração de classificação por níveis especificada. `TieringConfigurationName`não pode ser atualizado após sua criação.

 `ResourceSelection` pode conter:
+  `Resources` 
+  `TieringDownSettingsInDays` 
+  `ResourceType` 

## Sintaxe da Solicitação
<a name="API_UpdateTieringConfiguration_RequestSyntax"></a>

```
PUT /tiering-configurations/tieringConfigurationName HTTP/1.1
Content-type: application/json

{
   "TieringConfiguration": { 
      "BackupVaultName": "string",
      "ResourceSelection": [ 
         { 
            "Resources": [ "string" ],
            "ResourceType": "string",
            "TieringDownSettingsInDays": number
         }
      ]
   }
}
```

## Parâmetros da Solicitação de URI
<a name="API_UpdateTieringConfiguration_RequestParameters"></a>

A solicitação usa os seguintes parâmetros de URI:

 ** [tieringConfigurationName](#API_UpdateTieringConfiguration_RequestSyntax) **   <a name="Backup-UpdateTieringConfiguration-request-uri-TieringConfigurationName"></a>
O nome de uma configuração hierárquica a ser atualizada.  
Padrão: `^[a-zA-Z0-9_]{1,200}$`   
Obrigatório: Sim

## Corpo da Solicitação
<a name="API_UpdateTieringConfiguration_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [TieringConfiguration](#API_UpdateTieringConfiguration_RequestSyntax) **   <a name="Backup-UpdateTieringConfiguration-request-TieringConfiguration"></a>
Especifica o corpo de uma configuração de camadas.  
Tipo: objeto [TieringConfigurationInputForUpdate](API_TieringConfigurationInputForUpdate.md)  
Obrigatório: sim

## Sintaxe da resposta
<a name="API_UpdateTieringConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreationTime": number,
   "LastUpdatedTime": number,
   "TieringConfigurationArn": "string",
   "TieringConfigurationName": "string"
}
```

## Elementos de resposta
<a name="API_UpdateTieringConfiguration_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.

 ** [CreationTime](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-CreationTime"></a>
A data e a hora em que uma configuração de camadas foi criada, no formato Unix e no Tempo Universal Coordenado (UTC). O valor de `CreationTime` 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

 ** [LastUpdatedTime](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-LastUpdatedTime"></a>
A data e a hora em que uma configuração de camadas foi atualizada, no formato Unix e no Horário Universal Coordenado (UTC). O valor de `LastUpdatedTime` 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

 ** [TieringConfigurationArn](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-TieringConfigurationArn"></a>
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva a configuração de classificação por níveis atualizada.  
Tipo: string

 ** [TieringConfigurationName](#API_UpdateTieringConfiguration_ResponseSyntax) **   <a name="Backup-UpdateTieringConfiguration-response-TieringConfigurationName"></a>
Essa sequência de caracteres exclusiva é o nome da configuração de camadas.  
Tipo: sequência  
Padrão: `^[a-zA-Z0-9_]{1,200}$` 

## Erros
<a name="API_UpdateTieringConfiguration_Errors"></a>

Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** AlreadyExistsException **   
O recurso necessário já existe.    
 ** Arn **   
  
 ** Context **   
  
 ** CreatorRequestId **   
  
 ** Type **   

Código de status HTTP: 400

 ** ConflictException **   
 AWS Backup não pode realizar a ação que você solicitou até que termine de executar uma ação anterior. Tente novamente mais tarde.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

 ** 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

 ** 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_UpdateTieringConfiguration_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/UpdateTieringConfiguration) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/UpdateTieringConfiguration) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/UpdateTieringConfiguration) 