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á.
# API do AWS Backup
Além de usar o console, você pode usar a API do AWS Backup para configurar e gerenciar o AWS Backup e seus recursos de forma programática. Esta seção descreve ações e tipos de dados do AWS Backup. Ele contém a referência da API para o AWS Backup.
**AWS Backup API do**
+ [Ações do AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_Operations.html)
+ [Tipos de dados do AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_Types.html)
# Ações
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)
As seguintes ações são apoiadas por AWS Backup gateway:
+ [AssociateGatewayToServer](API_BGW_AssociateGatewayToServer.md)
+ [CreateGateway](API_BGW_CreateGateway.md)
+ [DeleteGateway](API_BGW_DeleteGateway.md)
+ [DeleteHypervisor](API_BGW_DeleteHypervisor.md)
+ [DisassociateGatewayFromServer](API_BGW_DisassociateGatewayFromServer.md)
+ [GetBandwidthRateLimitSchedule](API_BGW_GetBandwidthRateLimitSchedule.md)
+ [GetGateway](API_BGW_GetGateway.md)
+ [GetHypervisor](API_BGW_GetHypervisor.md)
+ [GetHypervisorPropertyMappings](API_BGW_GetHypervisorPropertyMappings.md)
+ [GetVirtualMachine](API_BGW_GetVirtualMachine.md)
+ [ImportHypervisorConfiguration](API_BGW_ImportHypervisorConfiguration.md)
+ [ListGateways](API_BGW_ListGateways.md)
+ [ListHypervisors](API_BGW_ListHypervisors.md)
+ [ListTagsForResource](API_BGW_ListTagsForResource.md)
+ [ListVirtualMachines](API_BGW_ListVirtualMachines.md)
+ [PutBandwidthRateLimitSchedule](API_BGW_PutBandwidthRateLimitSchedule.md)
+ [PutHypervisorPropertyMappings](API_BGW_PutHypervisorPropertyMappings.md)
+ [PutMaintenanceStartTime](API_BGW_PutMaintenanceStartTime.md)
+ [StartVirtualMachinesMetadataSync](API_BGW_StartVirtualMachinesMetadataSync.md)
+ [TagResource](API_BGW_TagResource.md)
+ [TestHypervisorConfiguration](API_BGW_TestHypervisorConfiguration.md)
+ [UntagResource](API_BGW_UntagResource.md)
+ [UpdateGatewayInformation](API_BGW_UpdateGatewayInformation.md)
+ [UpdateGatewaySoftwareNow](API_BGW_UpdateGatewaySoftwareNow.md)
+ [UpdateHypervisor](API_BGW_UpdateHypervisor.md)
As seguintes ações são apoiadas por Pesquisa do AWS Backup:
+ [GetSearchJob](API_BKS_GetSearchJob.md)
+ [GetSearchResultExportJob](API_BKS_GetSearchResultExportJob.md)
+ [ListSearchJobBackups](API_BKS_ListSearchJobBackups.md)
+ [ListSearchJobResults](API_BKS_ListSearchJobResults.md)
+ [ListSearchJobs](API_BKS_ListSearchJobs.md)
+ [ListSearchResultExportJobs](API_BKS_ListSearchResultExportJobs.md)
+ [ListTagsForResource](API_BKS_ListTagsForResource.md)
+ [StartSearchJob](API_BKS_StartSearchJob.md)
+ [StartSearchResultExportJob](API_BKS_StartSearchResultExportJob.md)
+ [StopSearchJob](API_BKS_StopSearchJob.md)
+ [TagResource](API_BKS_TagResource.md)
+ [UntagResource](API_BKS_UntagResource.md)
# AWS Backup
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
Associa uma equipe de aprovação MPA a um cofre de backup.
## Sintaxe da Solicitação
```
PUT /backup-vaults/backupVaultName/mpaApprovalTeam HTTP/1.1
Content-type: application/json
{
"MpaApprovalTeamArn": "string",
"RequesterComment": "string"
}
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [MpaApprovalTeamArn](#API_AssociateBackupVaultMpaApprovalTeam_RequestSyntax) **
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) **
Um comentário fornecido pelo solicitante explicando a solicitação de associação.
Tipo: string
Obrigatório: não
## Sintaxe da resposta
```
HTTP/1.1 204
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.
## Erros
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
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
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
```
DELETE /legal-holds/legalHoldId?cancelDescription=CancelDescription&retainRecordInDays=RetainRecordInDays HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [CancelDescription](#API_CancelLegalHold_RequestSyntax) **
Uma string que descreve o motivo da remoção da retenção legal.
Obrigatório: Sim
** [legalHoldId](#API_CancelLegalHold_RequestSyntax) **
O ID da retenção legal.
Obrigatório: Sim
** [RetainRecordInDays](#API_CancelLegalHold_RequestSyntax) **
O valor inteiro, em dias, após o qual deve ser removida a retenção legal.
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 201
```
## Elementos de resposta
Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 201 com um corpo HTTP vazio.
## Erros
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
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
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
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [BackupPlan](#API_CreateBackupPlan_RequestSyntax) **
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) **
As tags a serem atribuídas ao plano de backup.
Tipo: mapa de string para string
Obrigatório: não
** [CreatorRequestId](#API_CreateBackupPlan_RequestSyntax) **
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
```
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
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) **
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) **
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) **
O ID do plano de backup.
Tipo: string
** [CreationDate](#API_CreateBackupPlan_ResponseSyntax) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [backupPlanId](#API_CreateBackupSelection_RequestSyntax) **
O ID do plano de backup.
Obrigatório: Sim
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [BackupSelection](#API_CreateBackupSelection_RequestSyntax) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPlanId": "string",
"CreationDate": number,
"SelectionId": "string"
}
```
## Elementos de resposta
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) **
O ID do plano de backup.
Tipo: string
** [CreationDate](#API_CreateBackupSelection_ResponseSyntax) **
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) **
Identifica de forma exclusiva o corpo de uma solicitação para atribuir um conjunto de recursos a um plano de backup.
Tipo: string
## Erros
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_CreateBackupVault_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [BackupVaultTags](#API_CreateBackupVault_RequestSyntax) **
As tags a serem atribuídas ao cofre de backup.
Tipo: mapa de string para string
Obrigatório: não
** [CreatorRequestId](#API_CreateBackupVault_RequestSyntax) **
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 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
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CreationDate": number
}
```
## Elementos de resposta
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) **
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) **
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 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
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
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
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
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [FrameworkControls](#API_CreateFramework_RequestSyntax) **
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) **
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) **
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) **
As tags a serem atribuídas à framework.
Tipo: mapa de string para string
Obrigatório: não
** [IdempotencyToken](#API_CreateFramework_RequestSyntax) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"FrameworkArn": "string",
"FrameworkName": "string"
}
```
## Elementos de resposta
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) **
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) **
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
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
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
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
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [Description](#API_CreateLegalHold_RequestSyntax) **
A descrição da string da retenção legal.
Tipo: String
Obrigatório: Sim
** [IdempotencyToken](#API_CreateLegalHold_RequestSyntax) **
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) **
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) **
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) **
O título da retenção legal.
Tipo: String
Obrigatório: sim
## Sintaxe da resposta
```
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
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 hora em que a retenção legal foi criada.
Tipo: Timestamp
** [Description](#API_CreateLegalHold_ResponseSyntax) **
A descrição da string da retenção legal.
Tipo: string
** [LegalHoldArn](#API_CreateLegalHold_ResponseSyntax) **
O nome do recurso da Amazon (ARN) da retenção legal.
Tipo: string
** [LegalHoldId](#API_CreateLegalHold_ResponseSyntax) **
O ID da retenção legal.
Tipo: string
** [RecoveryPointSelection](#API_CreateLegalHold_ResponseSyntax) **
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) **
O status da retenção legal.
Tipo: string
Valores válidos: `CREATING | ACTIVE | CANCELING | CANCELED`
** [Title](#API_CreateLegalHold_ResponseSyntax) **
O título da retenção legal.
Tipo: string
## Erros
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [BackupVaultTags](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **
As tags a serem atribuídas ao cofre.
Tipo: mapa de string para string
Obrigatório: não
** [CreatorRequestId](#API_CreateLogicallyAirGappedBackupVault_RequestSyntax) **
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) **
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) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CreationDate": number,
"VaultState": "string"
}
```
## Elementos de resposta
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) **
O nome do recurso da Amazon (ARN) do cofre.
Tipo: string
** [BackupVaultName](#API_CreateLogicallyAirGappedBackupVault_ResponseSyntax) **
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 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) **
O estado atual do cofre.
Tipo: string
Valores válidos: `CREATING | AVAILABLE | FAILED`
## Erros
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
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
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
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [IdempotencyToken](#API_CreateReportPlan_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"ReportPlanArn": "string",
"ReportPlanName": "string"
}
```
## Elementos de resposta
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 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) **
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) **
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
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
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
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
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [BackupVaultName](#API_CreateRestoreAccessBackupVault_RequestSyntax) **
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) **
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) **
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) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"CreationDate": number,
"RestoreAccessBackupVaultArn": "string",
"RestoreAccessBackupVaultName": "string",
"VaultState": "string"
}
```
## Elementos de resposta
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 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) **
O ARN que identifica de forma exclusiva o cofre de backup do acesso à restauração criado.
Tipo: string
** [RestoreAccessBackupVaultName](#API_CreateRestoreAccessBackupVault_ResponseSyntax) **
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) **
O estado atual do cofre de backup de acesso para restauração.
Tipo: string
Valores válidos: `CREATING | AVAILABLE | FAILED`
## Erros
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
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
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
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [CreatorRequestId](#API_CreateRestoreTestingPlan_RequestSyntax) **
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) **
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) **
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
```
HTTP/1.1 201
Content-type: application/json
{
"CreationTime": number,
"RestoreTestingPlanArn": "string",
"RestoreTestingPlanName": "string"
}
```
## Elementos de resposta
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 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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [RestoreTestingPlanName](#API_CreateRestoreTestingSelection_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [CreatorRequestId](#API_CreateRestoreTestingSelection_RequestSyntax) **
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) **
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
```
HTTP/1.1 201
Content-type: application/json
{
"CreationTime": number,
"RestoreTestingPlanArn": "string",
"RestoreTestingPlanName": "string",
"RestoreTestingSelectionName": "string"
}
```
## Elementos de resposta
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 hora em que a seleção de testes de recursos foi criada.
Tipo: Timestamp
** [RestoreTestingPlanArn](#API_CreateRestoreTestingSelection_ResponseSyntax) **
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) **
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) **
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
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
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
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
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [CreatorRequestId](#API_CreateTieringConfiguration_RequestSyntax) **
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) **
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) **
As tags a serem atribuídas à configuração de camadas.
Tipo: mapa de string para string
Obrigatório: Não
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"TieringConfigurationArn": "string",
"TieringConfigurationName": "string"
}
```
## Elementos de resposta
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 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) **
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva a configuração de camadas criada.
Tipo: string
** [TieringConfigurationName](#API_CreateTieringConfiguration_ResponseSyntax) **
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
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
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
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
```
DELETE /backup/plans/backupPlanId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupPlanId](#API_DeleteBackupPlan_RequestSyntax) **
Identifica de forma exclusiva um plano de backup.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPlanArn": "string",
"BackupPlanId": "string",
"DeletionDate": number,
"VersionId": "string"
}
```
## Elementos de resposta
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) **
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) **
Identifica de forma exclusiva um plano de backup.
Tipo: string
** [DeletionDate](#API_DeleteBackupPlan_ResponseSyntax) **
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) **
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
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
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
Exclui a seleção de recursos associada a um plano de backup especificado pelo `SelectionId`.
## Sintaxe da Solicitação
```
DELETE /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupPlanId](#API_DeleteBackupSelection_RequestSyntax) **
Identifica de forma exclusiva um plano de backup.
Obrigatório: Sim
** [selectionId](#API_DeleteBackupSelection_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Exclui o cofre de backup identificado por seu nome. Só será possível excluir um cofre se ele estiver vazio.
## Sintaxe da Solicitação
```
DELETE /backup-vaults/backupVaultName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_DeleteBackupVault_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Exclui o documento de política que gerencia as permissões em um cofre de backup.
## Sintaxe da Solicitação
```
DELETE /backup-vaults/backupVaultName/access-policy HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_DeleteBackupVaultAccessPolicy_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
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
```
DELETE /backup-vaults/backupVaultName/vault-lock HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_DeleteBackupVaultLockConfiguration_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Exclui as notificações de eventos para o cofre de backup especificado.
## Sintaxe da Solicitação
```
DELETE /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_DeleteBackupVaultNotifications_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Exclui a framework especificada por um nome de framework.
## Sintaxe da Solicitação
```
DELETE /audit/frameworks/frameworkName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [frameworkName](#API_DeleteFramework_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para 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
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
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
```
DELETE /backup-vaults/backupVaultName/recovery-points/recoveryPointArn HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_DeleteRecoveryPoint_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Exclui o plano de relatório especificado por um nome de plano de relatório.
## Sintaxe da Solicitação
```
DELETE /audit/report-plans/reportPlanName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [reportPlanName](#API_DeleteReportPlan_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para 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
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
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
```
DELETE /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [RestoreTestingPlanName](#API_DeleteRestoreTestingPlan_RequestSyntax) **
Nome exclusivo obrigatório do plano de testes de restauração que você deseja excluir.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 204
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.
## Erros
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
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
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
```
DELETE /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [RestoreTestingPlanName](#API_DeleteRestoreTestingSelection_RequestSyntax) **
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) **
Nome exclusivo obrigatório da seleção de testes de restauração que você deseja excluir.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 204
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.
## Erros
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
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
Exclui a configuração de camadas especificada por um nome de configuração de camadas.
## Sintaxe da Solicitação
```
DELETE /tiering-configurations/tieringConfigurationName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [tieringConfigurationName](#API_DeleteTieringConfiguration_RequestSyntax) **
O nome exclusivo de uma configuração hierárquica.
Padrão: `^[a-zA-Z0-9_]{1,200}$`
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Retorna os detalhes do trabalho de backup para o `BackupJobId` especificado.
## Sintaxe da Solicitação
```
GET /backup-jobs/backupJobId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupJobId](#API_DescribeBackupJob_RequestSyntax) **
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
Retorna o ID da conta que é proprietária do trabalho de backup.
Tipo: sequência
Padrão: `^[0-9]{12}$`
** [BackupJobId](#API_DescribeBackupJob_ResponseSyntax) **
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.
Tipo: string
** [BackupOptions](#API_DescribeBackupJob_ResponseSyntax) **
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) **
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) **
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) **
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) **
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) **
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) **
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 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) **
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 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) **
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 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) **
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 data em que um trabalho de backup foi iniciado.
Tipo: Timestamp
** [IsEncrypted](#API_DescribeBackupJob_ResponseSyntax) **
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) **
Isso retorna o valor booliano de que um trabalho de backup é um trabalho pai (composto).
Tipo: booliano
** [MessageCategory](#API_DescribeBackupJob_ResponseSyntax) **
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) **
Isso retorna o número de trabalhos de backup filho (aninhados).
Tipo: longo
** [ParentJobId](#API_DescribeBackupJob_ResponseSyntax) **
Isso retorna o ID do trabalho de backup do recurso pai (composto).
Tipo: string
** [PercentDone](#API_DescribeBackupJob_ResponseSyntax) **
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) **
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) **
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) **
Um ARN identifica de forma exclusiva um recurso salvo. O formato do ARN depende do tipo de recurso.
Tipo: string
** [ResourceName](#API_DescribeBackupJob_ResponseSyntax) **
O nome não exclusivo do recurso que pertence ao backup especificado.
Tipo: string
** [ResourceType](#API_DescribeBackupJob_ResponseSyntax) **
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) **
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) **
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) **
Uma mensagem detalhada explicando o status do trabalho para fazer backup de um recurso.
Tipo: string
** [VaultLockState](#API_DescribeBackupJob_ResponseSyntax) **
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) **
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
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
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
Retorna metadados sobre um cofre de backup especificado por seu nome.
## Sintaxe da Solicitação
```
GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [BackupVaultAccountId](#API_DescribeBackupVault_RequestSyntax) **
O ID da conta do cofre de backup especificado.
** [backupVaultName](#API_DescribeBackupVault_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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 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) **
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 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) **
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) **
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 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) **
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 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 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) **
O ARN da equipe de aprovação MPA associada a esse cofre de backup.
Tipo: string
** [MpaSessionArn](#API_DescribeBackupVault_ResponseSyntax) **
O ARN da sessão de MPA associada a esse cofre de backup.
Tipo: string
** [NumberOfRecoveryPoints](#API_DescribeBackupVault_ResponseSyntax) **
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) **
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) **
O estado atual do cofre.->
Tipo: string
Valores válidos: `CREATING | AVAILABLE | FAILED`
** [VaultType](#API_DescribeBackupVault_ResponseSyntax) **
O tipo de cofre descrito.
Tipo: string
Valores válidos: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT`
## Erros
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
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
Retorna os metadados associados à criação de uma cópia de um recurso.
## Sintaxe da Solicitação
```
GET /copy-jobs/copyJobId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [copyJobId](#API_DescribeCopyJob_RequestSyntax) **
Identifica de forma exclusiva um trabalho de cópia.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
Contém informações detalhadas sobre um trabalho de cópia.
Tipo: objeto [CopyJob](API_CopyJob.md)
## Erros
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
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
Retorna os detalhes da framework para o `FrameworkName` especificado.
## Sintaxe da Solicitação
```
GET /audit/frameworks/frameworkName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [frameworkName](#API_DescribeFramework_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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 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) **
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) **
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) **
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) **
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) **
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) **
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) **
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
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
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
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
```
GET /global-settings HTTP/1.1
```
## Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"GlobalSettings": {
"string" : "string"
},
"LastUpdateTime": number
}
```
## Elementos de resposta
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) **
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 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
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
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
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
```
GET /resources/resourceArn HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [resourceArn](#API_DescribeProtectedResource_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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 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) **
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) **
O ARN (Nome do recurso da Amazon) do ponto de recuperação mais recente.
Tipo: string
** [LatestRestoreExecutionTimeMinutes](#API_DescribeProtectedResource_ResponseSyntax) **
O tempo, em minutos, que o trabalho de restauração mais recente levou para ser concluído.
Tipo: longo
** [LatestRestoreJobCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **
A data de criação do trabalho de restauração mais recente.
Tipo: Timestamp
** [LatestRestoreRecoveryPointCreationDate](#API_DescribeProtectedResource_ResponseSyntax) **
A data em que o ponto de recuperação mais recente foi criado.
Tipo: Timestamp
** [ResourceArn](#API_DescribeProtectedResource_ResponseSyntax) **
Um ARN que identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.
Tipo: string
** [ResourceName](#API_DescribeProtectedResource_ResponseSyntax) **
O nome do recurso que pertence ao backup especificado.
Tipo: string
** [ResourceType](#API_DescribeProtectedResource_ResponseSyntax) **
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
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
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
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
```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [BackupVaultAccountId](#API_DescribeRecoveryPoint_RequestSyntax) **
O ID da conta do cofre de backup especificado.
Padrão: `^[0-9]{12}$`
** [backupVaultName](#API_DescribeRecoveryPoint_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
O tamanho de um backup, em bytes.
Tipo: longo
** [BackupVaultArn](#API_DescribeRecoveryPoint_ResponseSyntax) **
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) **
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) **
Um objeto `CalculatedLifecycle` contendo timestamps `DeleteAt` e `MoveToColdStorageAt`.
Tipo: objeto [CalculatedLifecycle](API_CalculatedLifecycle.md)
** [CompletionDate](#API_DescribeRecoveryPoint_ResponseSyntax) **
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) **
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) **
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 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 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) **
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) **
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) **
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) **
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 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) **
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) **
Isso retorna o valor booliano de que um ponto de recuperação é um trabalho pai (composto).
Tipo: booliano
** [LastRestoreTime](#API_DescribeRecoveryPoint_ResponseSyntax) **
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) **
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) **
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) **
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) **
Um ARN identifica de forma exclusiva um recurso salvo. O formato do ARN depende do tipo de recurso.
Tipo: string
** [ResourceName](#API_DescribeRecoveryPoint_ResponseSyntax) **
O nome do recurso que pertence ao backup especificado.
Tipo: string
** [ResourceType](#API_DescribeRecoveryPoint_ResponseSyntax) **
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) **
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) **
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) **
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) **
Uma mensagem de status explicando o status do ponto de recuperação.
Tipo: string
** [StorageClass](#API_DescribeRecoveryPoint_ResponseSyntax) **
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) **
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
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
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
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
```
GET /account-settings HTTP/1.1
```
## Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"ResourceTypeManagementPreference": {
"string" : boolean
},
"ResourceTypeOptInPreference": {
"string" : boolean
}
}
```
## Elementos de resposta
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) **
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) **
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
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
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
Retorna os detalhes associados à criação de um relatório conforme especificado por seu `ReportJobId`.
## Sintaxe da Solicitação
```
GET /audit/report-jobs/reportJobId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [reportJobId](#API_DescribeReportJob_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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
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
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
Retorna uma lista de todos os planos de relatório para um Conta da AWS Região da AWS e.
## Sintaxe da Solicitação
```
GET /audit/report-plans/reportPlanName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [reportPlanName](#API_DescribeReportPlan_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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
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
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
Retorna metadados associados a um trabalho de restauração especificado por um ID de trabalho.
## Sintaxe da Solicitação
```
GET /restore-jobs/restoreJobId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [restoreJobId](#API_DescribeRestoreJob_RequestSyntax) **
Identifica de forma exclusiva o trabalho que restaura um ponto de recuperação.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
O tamanho, em bytes, do recurso restaurado.
Tipo: longo
** [BackupVaultArn](#API_DescribeRestoreJob_ResponseSyntax) **
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 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) **
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) **
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 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) **
O status dos dados gerados pelo teste de restauração.
Tipo: string
Valores válidos: `DELETING | FAILED | SUCCESSFUL`
** [DeletionStatusMessage](#API_DescribeRestoreJob_ResponseSyntax) **
Isso descreve o status de exclusão do trabalho de restauração.
Tipo: string
** [ExpectedCompletionTimeMinutes](#API_DescribeRestoreJob_ResponseSyntax) **
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) **
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) **
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) **
Esse é o identificador exclusivo da tarefa de restauração principal da tarefa de restauração selecionada.
Tipo: string
** [PercentDone](#API_DescribeRestoreJob_ResponseSyntax) **
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) **
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 data de criação do ponto de recuperação criado pelo trabalho de restauração especificado.
Tipo: Timestamp
** [ResourceType](#API_DescribeRestoreJob_ResponseSyntax) **
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) **
Identifica de forma exclusiva o trabalho que restaura um ponto de recuperação.
Tipo: string
** [SourceResourceArn](#API_DescribeRestoreJob_ResponseSyntax) **
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) **
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) **
Uma mensagem mostrando o status de um trabalho para restaurar um ponto de recuperação.
Tipo: string
** [ValidationStatus](#API_DescribeRestoreJob_ResponseSyntax) **
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 mensagem de status.
Tipo: string
## Erros
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
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
Retorna os detalhes do trabalho de digitalização para a ScanJob ID especificada.
## Sintaxe da Solicitação
```
GET /scan/jobs/ScanJobId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [ScanJobId](#API_DescribeScanJob_RequestSyntax) **
Identifica de forma exclusiva uma solicitação para AWS Backup escanear um recurso.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
Retorna o ID da conta que é proprietária do trabalho de digitalização.
Padrão: `^[0-9]{12}$`
Tipo: string
** [BackupVaultArn](#API_DescribeScanJob_ResponseSyntax) **
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) **
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 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) **
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 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) **
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) **
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) **
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) **
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) **
O nome não exclusivo do recurso que pertence ao backup especificado.
Tipo: string
** [ResourceType](#API_DescribeScanJob_ResponseSyntax) **
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) **
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) **
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) **
O ID do trabalho de digitalização que identificou de forma exclusiva a solicitação para. AWS Backup
Tipo: string
** [ScanMode](#API_DescribeScanJob_ResponseSyntax) **
Especifica o tipo de escaneamento usado para o trabalho de escaneamento.
Tipo: string
Valores válidos: `FULL_SCAN | INCREMENTAL_SCAN`
** [ScannerRoleArn](#API_DescribeScanJob_ResponseSyntax) **
Especifica a função do IAM do scanner que o ARN usa para o trabalho de digitalização.
Tipo: string
** [ScanResult](#API_DescribeScanJob_ResponseSyntax) **
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) **
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) **
Uma mensagem detalhada explicando o status do trabalho para fazer backup de um recurso.
Tipo: string
## Erros
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
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
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
```
POST /backup-vaults/backupVaultName/mpaApprovalTeam?delete HTTP/1.1
Content-type: application/json
{
"RequesterComment": "string"
}
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [RequesterComment](#API_DisassociateBackupVaultMpaApprovalTeam_RequestSyntax) **
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
```
HTTP/1.1 204
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.
## Erros
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
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
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
```
POST /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/disassociate HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_DisassociateRecoveryPoint_RequestSyntax) **
O nome exclusivo de um AWS Backup cofre.
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`
Obrigatório: Sim
** [recoveryPointArn](#API_DisassociateRecoveryPoint_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
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
```
DELETE /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/parentAssociation HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_DisassociateRecoveryPointFromParent_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 204
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.
## Erros
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
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
Retorna o plano de backup especificado pelo ID do plano como um modelo de backup.
## Sintaxe da Solicitação
```
GET /backup/plans/backupPlanId/toTemplate/ HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupPlanId](#API_ExportBackupPlanTemplate_RequestSyntax) **
Identifica de forma exclusiva um plano de backup.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPlanTemplateJson": "string"
}
```
## Elementos de resposta
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) **
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
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
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
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
```
GET /backup/plans/backupPlanId/?MaxScheduledRunsPreview=MaxScheduledRunsPreview&versionId=VersionId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupPlanId](#API_GetBackupPlan_RequestSyntax) **
Identifica de forma exclusiva um plano de backup.
Obrigatório: Sim
** [MaxScheduledRunsPreview](#API_GetBackupPlan_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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) **
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) **
Identifica de forma exclusiva um plano de backup.
Tipo: string
** [CreationDate](#API_GetBackupPlan_ResponseSyntax) **
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) **
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 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 ú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) **
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) **
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
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
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
Retorna um documento JSON válido especificando um plano de backup ou um erro.
## Sintaxe da Solicitação
```
POST /backup/template/json/toPlan HTTP/1.1
Content-type: application/json
{
"BackupPlanTemplateJson": "string"
}
```
## Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [BackupPlanTemplateJson](#API_GetBackupPlanFromJSON_RequestSyntax) **
Um documento de plano de backup fornecido pelo cliente no formato JSON.
Tipo: String
Obrigatório: sim
## Sintaxe da resposta
```
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
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) **
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
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
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
Retorna o modelo especificado por seu `templateId` como um plano de backup.
## Sintaxe da Solicitação
```
GET /backup/template/plans/templateId/toPlan HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [templateId](#API_GetBackupPlanFromTemplate_RequestSyntax) **
Identifica de forma exclusiva um modelo de plano de backup armazenado.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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
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
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
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
```
GET /backup/plans/backupPlanId/selections/selectionId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupPlanId](#API_GetBackupSelection_RequestSyntax) **
Identifica de forma exclusiva um plano de backup.
Obrigatório: Sim
** [selectionId](#API_GetBackupSelection_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
Identifica de forma exclusiva um plano de backup.
Tipo: string
** [BackupSelection](#API_GetBackupSelection_ResponseSyntax) **
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 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) **
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) **
Identifica de forma exclusiva uma solicitação para atribuir um conjunto de recursos a um plano de backup.
Tipo: string
## Erros
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
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
Retorna o documento de política de acesso associado ao cofre de backup nomeado.
## Sintaxe da Solicitação
```
GET /backup-vaults/backupVaultName/access-policy HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_GetBackupVaultAccessPolicy_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultName": "string",
"Policy": "string"
}
```
## Elementos de resposta
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) **
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) **
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) **
O documento da política de acesso ao cofre de backup no formato JSON.
Tipo: string
## Erros
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
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
Exclui as notificações de eventos para o cofre de backup especificado.
## Sintaxe da Solicitação
```
GET /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_GetBackupVaultNotifications_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"BackupVaultEvents": [ "string" ],
"BackupVaultName": "string",
"SNSTopicArn": "string"
}
```
## Elementos de resposta
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) **
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) **
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) **
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) **
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
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
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
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
```
GET /legal-holds/legalHoldId/ HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [legalHoldId](#API_GetLegalHold_RequestSyntax) **
O ID da retenção legal.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
O motivo da remoção da retenção legal.
Tipo: string
** [CancellationDate](#API_GetLegalHold_ResponseSyntax) **
Hora em formato numérico em que a retenção legal foi cancelada.
Tipo: Timestamp
** [CreationDate](#API_GetLegalHold_ResponseSyntax) **
A hora em que a retenção legal foi criada.
Tipo: Timestamp
** [Description](#API_GetLegalHold_ResponseSyntax) **
A descrição da string da retenção legal.
Tipo: string
** [LegalHoldArn](#API_GetLegalHold_ResponseSyntax) **
O ARN do framework da retenção legal especificada. O formato do ARN depende do tipo de recurso.
Tipo: string
** [LegalHoldId](#API_GetLegalHold_ResponseSyntax) **
O ID da retenção legal.
Tipo: string
** [RecoveryPointSelection](#API_GetLegalHold_ResponseSyntax) **
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 data e a hora até as quais o registro da retenção legal será retido.
Tipo: Timestamp
** [Status](#API_GetLegalHold_ResponseSyntax) **
O status da retenção legal.
Tipo: string
Valores válidos: `CREATING | ACTIVE | CANCELING | CANCELED`
** [Title](#API_GetLegalHold_ResponseSyntax) **
O título da retenção legal.
Tipo: string
## Erros
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
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
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
```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/index HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_GetRecoveryPointIndexDetails_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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 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 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 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) **
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) **
Uma mensagem detalhada explicando o status do índice de backup associado ao ponto de recuperação.
Tipo: string
** [RecoveryPointArn](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
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) **
Uma string do nome do recurso da Amazon (ARN) que identifica de forma exclusiva um recurso de origem.
Tipo: string
** [TotalItemsIndexed](#API_GetRecoveryPointIndexDetails_ResponseSyntax) **
Contagem de itens no índice de backup associado ao ponto de recuperação.
Tipo: longo
## Erros
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
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
Retorna um conjunto de pares de chave/valor de metadados que foram usados para criar o backup.
## Sintaxe da Solicitação
```
GET /backup-vaults/backupVaultName/recovery-points/recoveryPointArn/restore-metadata?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [BackupVaultAccountId](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **
O ID da conta do cofre de backup especificado.
Padrão: `^[0-9]{12}$`
** [backupVaultName](#API_GetRecoveryPointRestoreMetadata_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultArn": "string",
"RecoveryPointArn": "string",
"ResourceType": "string",
"RestoreMetadata": {
"string" : "string"
}
}
```
## Elementos de resposta
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) **
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) **
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) **
O tipo de recurso do ponto de recuperação.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
** [RestoreMetadata](#API_GetRecoveryPointRestoreMetadata_ResponseSyntax) **
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
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
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
Essa solicitação retorna os metadados do trabalho de restauração especificado.
## Sintaxe da Solicitação
```
GET /restore-jobs/restoreJobId/metadata HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [restoreJobId](#API_GetRestoreJobMetadata_RequestSyntax) **
Esse é um identificador exclusivo de um trabalho de restauração interno AWS Backup.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"Metadata": {
"string" : "string"
},
"RestoreJobId": "string"
}
```
## Elementos de resposta
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) **
Contém os metadados do trabalho de backup especificado.
Tipo: mapa de string para string
** [RestoreJobId](#API_GetRestoreJobMetadata_ResponseSyntax) **
Esse é um identificador exclusivo de um trabalho de restauração interno AWS Backup.
Tipo: string
## Erros
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
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
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
```
GET /restore-testing/inferred-metadata?BackupVaultAccountId=BackupVaultAccountId&BackupVaultName=BackupVaultName&RecoveryPointArn=RecoveryPointArn HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [BackupVaultAccountId](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **
O ID da conta do cofre de backup especificado.
** [BackupVaultName](#API_GetRestoreTestingInferredMetadata_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"InferredMetadata": {
"string" : "string"
}
}
```
## Elementos de resposta
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) **
Isso é um mapa de strings dos metadados inferidos da solicitação.
Tipo: mapa de string para string
## Erros
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
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
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
```
GET /restore-testing/plans/RestoreTestingPlanName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [RestoreTestingPlanName](#API_GetRestoreTestingPlan_RequestSyntax) **
Nome exclusivo obrigatório do plano de testes de restauração.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
Especifica o corpo de um plano de testes de restauração. Inclui `RestoreTestingPlanName`.
Tipo: objeto [RestoreTestingPlanForGet](API_RestoreTestingPlanForGet.md)
## Erros
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
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
Retorna RestoreTestingSelection, que exibe recursos e elementos do plano de teste de restauração.
## Sintaxe da Solicitação
```
GET /restore-testing/plans/RestoreTestingPlanName/selections/RestoreTestingSelectionName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [RestoreTestingPlanName](#API_GetRestoreTestingSelection_RequestSyntax) **
Nome exclusivo obrigatório do plano de testes de restauração.
Obrigatório: Sim
** [RestoreTestingSelectionName](#API_GetRestoreTestingSelection_RequestSyntax) **
Nome exclusivo obrigatório da seleção de testes de restauração.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
Nome exclusivo da seleção de testes de restauração.
Tipo: objeto [RestoreTestingSelectionForGet](API_RestoreTestingSelectionForGet.md)
## Erros
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
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
Retorna os tipos de AWS recursos suportados pelo AWS Backup.
## Sintaxe da Solicitação
```
GET /supported-resource-types HTTP/1.1
```
## Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"ResourceTypes": [ "string" ]
}
```
## Elementos de resposta
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) **
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
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
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
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
```
GET /tiering-configurations/tieringConfigurationName HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [tieringConfigurationName](#API_GetTieringConfiguration_RequestSyntax) **
O nome exclusivo de uma configuração hierárquica.
Padrão: `^[a-zA-Z0-9_]{1,200}$`
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
Especifica o corpo de uma configuração de camadas. Inclui `TieringConfigurationName`.
Tipo: objeto [TieringConfiguration](API_TieringConfiguration.md)
## Erros
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [ByAccountId](#API_ListBackupJobs_RequestSyntax) **
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) **
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) **
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) **
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) **
Retorna somente os trabalhos de backup que foram criados após a data especificada.
** [ByCreatedBefore](#API_ListBackupJobs_RequestSyntax) **
Retorna somente os trabalhos de backup que foram criados antes da data especificada.
** [ByMessageCategory](#API_ListBackupJobs_RequestSyntax) **
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) **
Isso é um filtro para listar os trabalhos filho (aninhados) com base no ID do trabalho pai.
** [ByResourceArn](#API_ListBackupJobs_RequestSyntax) **
Retorna somente os trabalhos de backup que correspondam ao Nome do recurso da Amazon (ARN) do recurso especificado.
** [ByResourceType](#API_ListBackupJobs_RequestSyntax) **
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) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [AccountId](#API_ListBackupJobSummaries_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
As informações resumidas.
Tipo: matriz de objetos [BackupJobSummary](API_BackupJobSummary.md)
** [NextToken](#API_ListBackupJobSummaries_ResponseSyntax) **
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
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
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
Lista os planos de backup ativos da conta.
## Sintaxe da Solicitação
```
GET /backup/plans/?includeDeleted=IncludeDeleted&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [IncludeDeleted](#API_ListBackupPlans_RequestSyntax) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
Informações sobre planos de backup.
Tipo: matriz de objetos [BackupPlansListMember](API_BackupPlansListMember.md)
** [NextToken](#API_ListBackupPlans_ResponseSyntax) **
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
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
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
Lista os modelos do plano de backup.
## Sintaxe da Solicitação
```
GET /backup/template/plans?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_ListBackupPlanTemplates_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPlanTemplatesList": [
{
"BackupPlanTemplateId": "string",
"BackupPlanTemplateName": "string"
}
],
"NextToken": "string"
}
```
## Elementos de resposta
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) **
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) **
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
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
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
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
```
GET /backup/plans/backupPlanId/versions/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupPlanId](#API_ListBackupPlanVersions_RequestSyntax) **
Identifica de forma exclusiva um plano de backup.
Obrigatório: Sim
** [MaxResults](#API_ListBackupPlanVersions_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
Retorna uma matriz contendo metadados dos recursos associados ao plano de backup de destino.
## Sintaxe da Solicitação
```
GET /backup/plans/backupPlanId/selections/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupPlanId](#API_ListBackupSelections_RequestSyntax) **
Identifica de forma exclusiva um plano de backup.
Obrigatório: Sim
** [MaxResults](#API_ListBackupSelections_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
Retorna uma lista de contêineres de armazenamento de pontos de recuperação junto com informações sobre eles.
## Sintaxe da Solicitação
```
GET /backup-vaults/?maxResults=MaxResults&nextToken=NextToken&shared=ByShared&vaultType=ByVaultType HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [ByShared](#API_ListBackupVaults_RequestSyntax) **
Esse parâmetro classificará a lista de cofres por cofres compartilhados.
** [ByVaultType](#API_ListBackupVaults_RequestSyntax) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
Retorna metadados sobre seus trabalhos de cópia.
## Sintaxe da Solicitação
```
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 solicitação usa os seguintes parâmetros de URI:
** [ByAccountId](#API_ListCopyJobs_RequestSyntax) **
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) **
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) **
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) **
Retorna somente os trabalhos de cópia que foram criados após a data especificada.
** [ByCreatedBefore](#API_ListCopyJobs_RequestSyntax) **
Retorna somente os trabalhos de cópia que foram criados antes da data especificada.
** [ByDestinationVaultArn](#API_ListCopyJobs_RequestSyntax) **
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) **
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) **
Isso é um filtro para listar os trabalhos filho (aninhados) com base no ID do trabalho pai.
** [ByResourceArn](#API_ListCopyJobs_RequestSyntax) **
Retorna somente os trabalhos de cópia que correspondam ao Nome do recurso da Amazon (ARN) especificado.
** [ByResourceType](#API_ListCopyJobs_RequestSyntax) **
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) **
Filtra as tarefas de cópia pelo ARN do ponto de recuperação de origem especificado.
** [ByState](#API_ListCopyJobs_RequestSyntax) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [AccountId](#API_ListCopyJobSummaries_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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) **
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
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
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
Retorna uma lista de todas as estruturas de um Conta da AWS e. Região da AWS
## Sintaxe da Solicitação
```
GET /audit/frameworks?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_ListFrameworks_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [CreatedAfter](#API_ListIndexedRecoveryPoints_RequestSyntax) **
Retorna somente os pontos de recuperação indexados que foram criados depois da data especificada.
** [CreatedBefore](#API_ListIndexedRecoveryPoints_RequestSyntax) **
Retorna somente os pontos de recuperação indexados que foram criados antes da data especificada.
** [IndexStatus](#API_ListIndexedRecoveryPoints_RequestSyntax) **
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) **
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) **
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) **
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) **
Uma string do nome do recurso da Amazon (ARN) que identifica de forma exclusiva um recurso de origem.
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
Essa ação retorna metadados sobre retenções legais ativas e anteriores.
## Sintaxe da Solicitação
```
GET /legal-holds/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_ListLegalHolds_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
Isso é uma matriz de retenções legais retornadas, tanto ativas quanto anteriores.
Tipo: matriz de objetos [LegalHold](API_LegalHold.md)
** [NextToken](#API_ListLegalHolds_ResponseSyntax) **
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
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
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
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
```
GET /resources/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_ListProtectedResources_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
Essa solicitação lista os recursos protegidos correspondentes a cada cofre de backup.
## Sintaxe da Solicitação
```
GET /backup-vaults/backupVaultName/resources/?backupVaultAccountId=BackupVaultAccountId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [BackupVaultAccountId](#API_ListProtectedResourcesByBackupVault_RequestSyntax) **
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 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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
Esses são os resultados retornados para a solicitação ListProtectedResourcesByBackupVault.
Tipo: matriz de objetos [ProtectedResource](API_ProtectedResource.md)
## Erros
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
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
Retorna informações detalhadas sobre os pontos de recuperação armazenados em um cofre de backup.
## Sintaxe da Solicitação
```
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 solicitação usa os seguintes parâmetros de URI:
** [BackupVaultAccountId](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
Esse parâmetro classificará a lista de pontos de recuperação por ID de conta.
Padrão: `^[0-9]{12}$`
** [backupVaultName](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
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) **
Retorna somente os pontos de recuperação que correspondam ao ID do plano de backup especificado.
** [ByCreatedAfter](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
Retorna somente os pontos de recuperação que foram criados após o timestamp especificado.
** [ByCreatedBefore](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
Retorna somente os pontos de recuperação que foram criados antes do timestamp especificado.
** [ByParentRecoveryPointArn](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
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) **
Retorna somente os pontos de recuperação que correspondem ao Nome do recurso da Amazon (ARN) do recurso especificado.
** [ByResourceType](#API_ListRecoveryPointsByBackupVault_RequestSyntax) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
Essa ação retorna o ponto de recuperação ARNs (Amazon Resource Names) da retenção legal especificada.
## Sintaxe da Solicitação
```
GET /legal-holds/legalHoldId/recovery-points?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [legalHoldId](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **
O ID da retenção legal.
Obrigatório: Sim
** [MaxResults](#API_ListRecoveryPointsByLegalHold_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"RecoveryPoints": [
{
"BackupVaultName": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceType": "string"
}
]
}
```
## Elementos de resposta
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) **
O próximo item após uma lista parcial dos recursos retornados.
Tipo: string
** [RecoveryPoints](#API_ListRecoveryPointsByLegalHold_ResponseSyntax) **
Os pontos de recuperação.
Tipo: matriz de objetos [RecoveryPointMember](API_RecoveryPointMember.md)
## Erros
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
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
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
```
GET /resources/resourceArn/recovery-points/?managedByAWSBackupOnly=ManagedByAWSBackupOnly&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [ManagedByAWSBackupOnly](#API_ListRecoveryPointsByResource_RequestSyntax) **
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) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
Retorna detalhes sobre seus trabalhos de relatório.
## Sintaxe da Solicitação
```
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 solicitação usa os seguintes parâmetros de URI:
** [ByCreationAfter](#API_ListReportJobs_RequestSyntax) **
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 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) **
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) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
Os detalhes sobre seus trabalhos de relatório em formato JSON.
Tipo: matriz de objetos [ReportJob](API_ReportJob.md)
## Erros
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
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
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
```
GET /audit/report-plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_ListReportPlans_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
Retorna uma lista de cofres de backup de acesso à restauração associados a um cofre de backup especificado.
## Sintaxe da Solicitação
```
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 solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_ListRestoreAccessBackupVaults_RequestSyntax) **
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) **
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) **
O token de paginação de uma solicitação anterior para recuperar o próximo conjunto de resultados.
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [ByAccountId](#API_ListRestoreJobs_RequestSyntax) **
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) **
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) **
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) **
Retorna somente trabalhos de restauração que foram criados após a data especificada.
** [ByCreatedBefore](#API_ListRestoreJobs_RequestSyntax) **
Retorna somente trabalhos de restauração que foram criados antes da data especificada.
** [ByParentJobId](#API_ListRestoreJobs_RequestSyntax) **
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) **
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) **
Isso retorna somente os trabalhos de testes de restauração que correspondem ao nome do recurso da Amazon (ARN) especificado.
** [ByStatus](#API_ListRestoreJobs_RequestSyntax) **
Retorna somente trabalhos de restauração associados ao status do trabalho especificado.
Valores válidos: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED`
** [MaxResults](#API_ListRestoreJobs_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [ByRecoveryPointCreationDateAfter](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
Retorna somente os trabalhos de restauração de pontos de recuperação que foram criados após a data especificada.
** [ByRecoveryPointCreationDateBefore](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
Retorna somente os trabalhos de restauração de pontos de recuperação que foram criados antes da data especificada.
** [ByStatus](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
Retorna somente trabalhos de restauração associados ao status do trabalho especificado.
Valores válidos: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED`
** [MaxResults](#API_ListRestoreJobsByProtectedResource_RequestSyntax) **
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) **
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) **
Retorna somente os trabalhos de restauração que correspondem ao nome do recurso da Amazon (ARN) especificado.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [AccountId](#API_ListRestoreJobSummaries_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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) **
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
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
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
Retorna uma lista de planos de testes de restauração.
## Sintaxe da Solicitação
```
GET /restore-testing/plans?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_ListRestoreTestingPlans_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
Essa é uma lista retornada de planos de testes de restauração.
Tipo: matriz de objetos [RestoreTestingPlanForList](API_RestoreTestingPlanForList.md)
## Erros
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
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
Retorna uma lista de seleções de testes de restauração. Pode ser filtrada por `MaxResults` e `RestoreTestingPlanName`.
## Sintaxe da Solicitação
```
GET /restore-testing/plans/RestoreTestingPlanName/selections?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_ListRestoreTestingSelections_RequestSyntax) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
Retorna uma lista dos trabalhos de digitalização existentes para uma conta autenticada nos últimos 30 dias.
## Sintaxe da Solicitação
```
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 solicitação usa os seguintes parâmetros de URI:
** [ByAccountId](#API_ListScanJobs_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
Retorna somente os trabalhos de digitalização executados no ponto de recuperação especificado.
** [ByResourceArn](#API_ListScanJobs_RequestSyntax) **
Retorna somente trabalhos de digitalização que correspondam ao recurso Amazon Resource Name (ARN) especificado.
** [ByResourceType](#API_ListScanJobs_RequestSyntax) **
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) **
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) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [AccountId](#API_ListScanJobSummaries_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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) **
Retorna somente os trabalhos de escaneamento para os resultados de escaneamento especificados.
Valores válidos: `NO_THREATS_FOUND | THREATS_FOUND`
** [State](#API_ListScanJobSummaries_RequestSyntax) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
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
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) **
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) **
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) **
As informações resumidas.
Tipo: matriz de objetos [ScanJobSummary](API_ScanJobSummary.md)
## Erros
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
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
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
```
GET /tags/resourceArn/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_ListTags_RequestSyntax) **
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) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Tags": {
"string" : "string"
}
}
```
## Elementos de resposta
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) **
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) **
Informações sobre as tags.
Tipo: mapa de string para string
## Erros
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
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
Retorna uma lista de configurações de camadas.
## Sintaxe da Solicitação
```
GET /tiering-configurations/?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_ListTieringConfigurations_RequestSyntax) **
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) **
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
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"TieringConfigurations": [
{
"BackupVaultName": "string",
"CreationTime": number,
"LastUpdatedTime": number,
"TieringConfigurationArn": "string",
"TieringConfigurationName": "string"
}
]
}
```
## Elementos de resposta
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) **
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) **
Uma série de configurações de hierarquização retornadas pela `ListTieringConfigurations` chamada.
Tipo: matriz de objetos [TieringConfigurationsListMember](API_TieringConfigurationsListMember.md)
## Erros
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
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
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
```
PUT /backup-vaults/backupVaultName/access-policy HTTP/1.1
Content-type: application/json
{
"Policy": "string"
}
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_PutBackupVaultAccessPolicy_RequestSyntax) **
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`
Obrigatório: Sim
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [Policy](#API_PutBackupVaultAccessPolicy_RequestSyntax) **
O documento da política de acesso ao cofre de backup no formato JSON.
Tipo: string
Obrigatório: não
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_PutBackupVaultLockConfiguration_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [ChangeableForDays](#API_PutBackupVaultLockConfiguration_RequestSyntax) **
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 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 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
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Ativa as notificações em um cofre de backup para o tópico e os eventos especificados.
## Sintaxe da Solicitação
```
PUT /backup-vaults/backupVaultName/notification-configuration HTTP/1.1
Content-type: application/json
{
"BackupVaultEvents": [ "string" ],
"SNSTopicArn": "string"
}
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_PutBackupVaultNotifications_RequestSyntax) **
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`
Obrigatório: Sim
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [BackupVaultEvents](#API_PutBackupVaultNotifications_RequestSyntax) **
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) **
O Nome do recurso da Amazon (ARN) que especifica o tópico dos eventos de um cofre de backup. Por exemplo, `arn:aws:sns:us-west-2:111122223333:MyVaultTopic`.
Tipo: String
Obrigatório: sim
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
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
```
PUT /restore-jobs/restoreJobId/validations HTTP/1.1
Content-type: application/json
{
"ValidationStatus": "string",
"ValidationStatusMessage": "string"
}
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [restoreJobId](#API_PutRestoreValidationResult_RequestSyntax) **
Esse é um identificador exclusivo de um trabalho de restauração interno AWS Backup.
Obrigatório: Sim
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [ValidationStatus](#API_PutRestoreValidationResult_RequestSyntax) **
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) **
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
```
HTTP/1.1 204
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 204 com um corpo HTTP vazio.
## Erros
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **
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) **
Um comentário explicando o motivo da revogação do acesso ao cofre de backup de acesso para restauração.
** [restoreAccessBackupVaultArn](#API_RevokeRestoreAccessBackupVault_RequestSyntax) **
O ARN do cofre de backup de acesso para restauração que deve ser revogado.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Iniciar um trabalho de backup sob demanda para o recurso especificado.
## Sintaxe da Solicitação
```
PUT /backup-jobs HTTP/1.1
Content-type: application/json
{
"BackupOptions": {
"string" : "string"
},
"BackupVaultName": "string",
"CompleteWindowMinutes": number,
"IamRoleArn": "string",
"IdempotencyToken": "string",
"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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [BackupOptions](#API_StartBackupJob_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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) **
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) **
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) **
As tags a serem atribuídas ao recurso.
Tipo: mapa de string para string
Obrigatório: não
** [ResourceArn](#API_StartBackupJob_RequestSyntax) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"BackupJobId": "string",
"CreationDate": number,
"IsParent": boolean,
"RecoveryPointArn": "string"
}
```
## Elementos de resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
** [BackupJobId](#API_StartBackupJob_ResponseSyntax) **
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.
Tipo: string
** [CreationDate](#API_StartBackupJob_ResponseSyntax) **
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) **
Isso é um valor booliano que indica que se trata de um trabalho de backup pai (composto).
Tipo: booliano
** [RecoveryPointArn](#API_StartBackupJob_ResponseSyntax) **
*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
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
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
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
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [DestinationBackupVaultArn](#API_StartCopyJob_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"CopyJobId": "string",
"CreationDate": number,
"IsParent": boolean
}
```
## Elementos de resposta
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) **
Identifica de forma exclusiva um trabalho de cópia.
Tipo: string
** [CreationDate](#API_StartCopyJob_ResponseSyntax) **
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) **
Isso um valor booliano retornado que indica que se trata de um trabalho de cópia pai (composto).
Tipo: booliano
## Erros
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
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
Inicia um trabalho de relatório sob demanda para o plano de relatório especificado.
## Sintaxe da Solicitação
```
POST /audit/report-jobs/reportPlanName HTTP/1.1
Content-type: application/json
{
"IdempotencyToken": "string"
}
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [reportPlanName](#API_StartReportJob_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [IdempotencyToken](#API_StartReportJob_RequestSyntax) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"ReportJobId": "string"
}
```
## Elementos de resposta
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) **
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
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
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
Recupera o recurso salvo identificado por um Nome do recurso da Amazon (ARN).
## Sintaxe da Solicitação
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [CopySourceTagsToRestoredResource](#API_StartRestoreJob_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"RestoreJobId": "string"
}
```
## Elementos de resposta
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) **
Identifica de forma exclusiva o trabalho que restaura um ponto de recuperação.
Tipo: string
## Erros
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
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
Inicia trabalhos de varredura em busca de recursos específicos.
## Sintaxe da Solicitação
```
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 solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [BackupVaultName](#API_StartScanJob_RequestSyntax) **
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) **
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) **
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) **
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) **
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) **
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) **
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) **
Especificou o ARN da função do scanner do IAM.
Tipo: String
Obrigatório: sim
## Sintaxe da resposta
```
HTTP/1.1 201
Content-type: application/json
{
"CreationDate": number,
"ScanJobId": "string"
}
```
## Elementos de resposta
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 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) **
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.
Tipo: string
## Erros
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
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
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
```
POST /backup-jobs/backupJobId HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [backupJobId](#API_StopBackupJob_RequestSyntax) **
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Atribui um conjunto de pares de chave-valor a um recurso.
## Sintaxe da Solicitação
```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [resourceArn](#API_TagResource_RequestSyntax) **
O ARN identifica de forma exclusiva o recurso.
Obrigatório: Sim
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [Tags](#API_TagResource_RequestSyntax) **
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
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
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
```
POST /untag/resourceArn HTTP/1.1
Content-type: application/json
{
"TagKeyList": [ "string" ]
}
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [resourceArn](#API_UntagResource_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [TagKeyList](#API_UntagResource_RequestSyntax) **
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
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Atualiza o plano de backup especificado. A nova versão é identificada de forma exclusiva pelo ID.
## Sintaxe da Solicitação
```
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 solicitação usa os seguintes parâmetros de URI:
** [backupPlanId](#API_UpdateBackupPlan_RequestSyntax) **
O ID do plano de backup.
Obrigatório: Sim
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [BackupPlan](#API_UpdateBackupPlan_RequestSyntax) **
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
```
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
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) **
Contém uma lista de `BackupOptions` para cada tipo de recurso.
Tipo: matriz de objetos [AdvancedBackupSetting](API_AdvancedBackupSetting.md)
** [BackupPlanArn](#API_UpdateBackupPlan_ResponseSyntax) **
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) **
Identifica de forma exclusiva um plano de backup.
Tipo: string
** [CreationDate](#API_UpdateBackupPlan_ResponseSyntax) **
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) **
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) **
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
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
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
Atualiza o framework especificada.
## Sintaxe da Solicitação
```
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 solicitação usa os seguintes parâmetros de URI:
** [frameworkName](#API_UpdateFramework_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [FrameworkControls](#API_UpdateFramework_RequestSyntax) **
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) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"FrameworkArn": "string",
"FrameworkName": "string"
}
```
## Elementos de resposta
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 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) **
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) **
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
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
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
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
```
PUT /global-settings HTTP/1.1
Content-type: application/json
{
"GlobalSettings": {
"string" : "string"
}
}
```
## Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [GlobalSettings](#API_UpdateGlobalSettings_RequestSyntax) **
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
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **
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) **
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 solicitação aceita os dados a seguir no formato JSON.
** [IamRoleArn](#API_UpdateRecoveryPointIndexSettings_RequestSyntax) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"BackupVaultName": "string",
"Index": "string",
"IndexStatus": "string",
"RecoveryPointArn": "string"
}
```
## Elementos de resposta
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) **
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) **
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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [backupVaultName](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **
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) **
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 solicitação aceita os dados a seguir no formato JSON.
** [Lifecycle](#API_UpdateRecoveryPointLifecycle_RequestSyntax) **
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
```
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
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) **
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) **
Um objeto `CalculatedLifecycle` que contém os timestamps `MoveToColdStorageAt` e `DeleteAt`.
Tipo: objeto [CalculatedLifecycle](API_CalculatedLifecycle.md)
** [Lifecycle](#API_UpdateRecoveryPointLifecycle_ResponseSyntax) **
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) **
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
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
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
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
```
PUT /account-settings HTTP/1.1
Content-type: application/json
{
"ResourceTypeManagementPreference": {
"string" : boolean
},
"ResourceTypeOptInPreference": {
"string" : boolean
}
}
```
## Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceTypeManagementPreference](#API_UpdateRegionSettings_RequestSyntax) **
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) **
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
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [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
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
Atualiza o plano de relatório especificado.
## Sintaxe da Solicitação
```
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 solicitação usa os seguintes parâmetros de URI:
** [reportPlanName](#API_UpdateReportPlan_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [IdempotencyToken](#API_UpdateReportPlan_RequestSyntax) **
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) **
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) **
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) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"ReportPlanArn": "string",
"ReportPlanName": "string"
}
```
## Elementos de resposta
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 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) **
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) **
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
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [RestoreTestingPlanName](#API_UpdateRestoreTestingPlan_RequestSyntax) **
O nome do plano de teste de restauração.
Obrigatório: Sim
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [RestoreTestingPlan](#API_UpdateRestoreTestingPlan_RequestSyntax) **
Especifica o corpo de um plano de testes de restauração.
Tipo: objeto [RestoreTestingPlanForUpdate](API_RestoreTestingPlanForUpdate.md)
Obrigatório: sim
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"RestoreTestingPlanArn": "string",
"RestoreTestingPlanName": "string",
"UpdateTime": number
}
```
## Elementos de resposta
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 hora em que o plano de teste de restauração foi criado.
Tipo: Timestamp
** [RestoreTestingPlanArn](#API_UpdateRestoreTestingPlan_ResponseSyntax) **
ARN (nome do recurso da Amazon) exclusivo do plano de testes de restauração.
Tipo: string
** [RestoreTestingPlanName](#API_UpdateRestoreTestingPlan_ResponseSyntax) **
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 hora em que a atualização do plano de teste de restauração foi concluída.
Tipo: Timestamp
## Erros
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [RestoreTestingPlanName](#API_UpdateRestoreTestingSelection_RequestSyntax) **
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) **
O nome necessário da seleção de teste de restauração que você deseja atualizar.
Obrigatório: Sim
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [RestoreTestingSelection](#API_UpdateRestoreTestingSelection_RequestSyntax) **
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
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"RestoreTestingPlanArn": "string",
"RestoreTestingPlanName": "string",
"RestoreTestingSelectionName": "string",
"UpdateTime": number
}
```
## Elementos de resposta
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 hora em que a seleção de testes de recursos foi atualizada com sucesso.
Tipo: Timestamp
** [RestoreTestingPlanArn](#API_UpdateRestoreTestingSelection_ResponseSyntax) **
Essa string exclusiva é o nome do plano de testes de restauração.
Tipo: string
** [RestoreTestingPlanName](#API_UpdateRestoreTestingSelection_ResponseSyntax) **
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) **
O nome da seleção de teste de restauração retornado.
Tipo: string
** [UpdateTime](#API_UpdateRestoreTestingSelection_ResponseSyntax) **
A hora em que a atualização foi concluída para a seleção de teste de restauração.
Tipo: Timestamp
## Erros
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
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
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
```
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 solicitação usa os seguintes parâmetros de URI:
** [tieringConfigurationName](#API_UpdateTieringConfiguration_RequestSyntax) **
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 solicitação aceita os dados a seguir no formato JSON.
** [TieringConfiguration](#API_UpdateTieringConfiguration_RequestSyntax) **
Especifica o corpo de uma configuração de camadas.
Tipo: objeto [TieringConfigurationInputForUpdate](API_TieringConfigurationInputForUpdate.md)
Obrigatório: sim
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"LastUpdatedTime": number,
"TieringConfigurationArn": "string",
"TieringConfigurationName": "string"
}
```
## Elementos de resposta
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 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 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) **
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) **
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
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
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)
# AWS Backup gateway
As seguintes ações são compatíveis com o AWS Backup gateway:
+ [AssociateGatewayToServer](API_BGW_AssociateGatewayToServer.md)
+ [CreateGateway](API_BGW_CreateGateway.md)
+ [DeleteGateway](API_BGW_DeleteGateway.md)
+ [DeleteHypervisor](API_BGW_DeleteHypervisor.md)
+ [DisassociateGatewayFromServer](API_BGW_DisassociateGatewayFromServer.md)
+ [GetBandwidthRateLimitSchedule](API_BGW_GetBandwidthRateLimitSchedule.md)
+ [GetGateway](API_BGW_GetGateway.md)
+ [GetHypervisor](API_BGW_GetHypervisor.md)
+ [GetHypervisorPropertyMappings](API_BGW_GetHypervisorPropertyMappings.md)
+ [GetVirtualMachine](API_BGW_GetVirtualMachine.md)
+ [ImportHypervisorConfiguration](API_BGW_ImportHypervisorConfiguration.md)
+ [ListGateways](API_BGW_ListGateways.md)
+ [ListHypervisors](API_BGW_ListHypervisors.md)
+ [ListTagsForResource](API_BGW_ListTagsForResource.md)
+ [ListVirtualMachines](API_BGW_ListVirtualMachines.md)
+ [PutBandwidthRateLimitSchedule](API_BGW_PutBandwidthRateLimitSchedule.md)
+ [PutHypervisorPropertyMappings](API_BGW_PutHypervisorPropertyMappings.md)
+ [PutMaintenanceStartTime](API_BGW_PutMaintenanceStartTime.md)
+ [StartVirtualMachinesMetadataSync](API_BGW_StartVirtualMachinesMetadataSync.md)
+ [TagResource](API_BGW_TagResource.md)
+ [TestHypervisorConfiguration](API_BGW_TestHypervisorConfiguration.md)
+ [UntagResource](API_BGW_UntagResource.md)
+ [UpdateGatewayInformation](API_BGW_UpdateGatewayInformation.md)
+ [UpdateGatewaySoftwareNow](API_BGW_UpdateGatewaySoftwareNow.md)
+ [UpdateHypervisor](API_BGW_UpdateHypervisor.md)
# AssociateGatewayToServer
Associa um gateway de backup ao seu servidor. Depois de concluir o processo de associação, você pode fazer backup e restaurar seu VMs por meio do gateway.
## Sintaxe da solicitação
```
{
"GatewayArn": "string",
"ServerArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [GatewayArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do gateway. Use a `ListGateways` operação para retornar uma lista de gateways para sua conta e. Região da AWS
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Sim
** [ServerArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do servidor que hospeda suas máquinas virtuais.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"GatewayArn": "string"
}
```
## Elementos de resposta
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.
** [GatewayArn](#API_BGW_AssociateGatewayToServer_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do gateway.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** ConflictException **
Não foi possível continuar a operação porque ela não é compatível.
** ErrorCode **
Uma descrição do motivo pelo qual a operação não é compatível.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/AssociateGatewayToServer)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/AssociateGatewayToServer)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/AssociateGatewayToServer)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/AssociateGatewayToServer)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/AssociateGatewayToServer)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/AssociateGatewayToServer)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/AssociateGatewayToServer)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/AssociateGatewayToServer)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/AssociateGatewayToServer)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/AssociateGatewayToServer)
# CreateGateway
Cria um gateway de backup. Depois de criar um gateway, você poderá associá-lo a um servidor usando a operação `AssociateGatewayToServer`.
## Sintaxe da solicitação
```
{
"ActivationKey": "string",
"GatewayDisplayName": "string",
"GatewayType": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ActivationKey](#API_BGW_CreateGateway_RequestSyntax) **
A chave de ativação do gateway criado.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Tamanho máximo de 50.
Padrão: `[0-9a-zA-Z\-]+`
Obrigatório: Sim
** [GatewayDisplayName](#API_BGW_CreateGateway_RequestSyntax) **
O nome de exibição do gateway criado.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[a-zA-Z0-9-]*`
Obrigatório: Sim
** [GatewayType](#API_BGW_CreateGateway_RequestSyntax) **
O tipo de gateway criado.
Tipo: string
Valores válidos: `BACKUP_VM`
Obrigatório: Sim
** [Tags](#API_BGW_CreateGateway_RequestSyntax) **
Uma lista de até 50 tags a serem atribuídas ao gateway. Cada tag é um par de chave/valor.
Tipo: matriz de objetos [Tag](API_BGW_Tag.md)
Obrigatório: não
## Sintaxe da resposta
```
{
"GatewayArn": "string"
}
```
## Elementos de resposta
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.
** [GatewayArn](#API_BGW_CreateGateway_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do gateway criado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/CreateGateway)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/CreateGateway)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/CreateGateway)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/CreateGateway)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/CreateGateway)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/CreateGateway)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/CreateGateway)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/CreateGateway)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/CreateGateway)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/CreateGateway)
# DeleteGateway
Exclui um gateway de backup.
## Sintaxe da solicitação
```
{
"GatewayArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [GatewayArn](#API_BGW_DeleteGateway_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do gateway a ser excluído.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"GatewayArn": "string"
}
```
## Elementos de resposta
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.
** [GatewayArn](#API_BGW_DeleteGateway_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do gateway excluído.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/DeleteGateway)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteGateway)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteGateway)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteGateway)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteGateway)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteGateway)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteGateway)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteGateway)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteGateway)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DeleteGateway)
# DeleteHypervisor
Exclui um hipervisor.
## Sintaxe da solicitação
```
{
"HypervisorArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [HypervisorArn](#API_BGW_DeleteHypervisor_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor a ser excluído.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"HypervisorArn": "string"
}
```
## Elementos de resposta
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.
** [HypervisorArn](#API_BGW_DeleteHypervisor_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor excluído.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Não foi possível continuar a operação porque você não tem permissões suficientes.
** ErrorCode **
Uma descrição do motivo pelo qual você não tem permissões suficientes.
Código de status HTTP: 400
** ConflictException **
Não foi possível continuar a operação porque ela não é compatível.
** ErrorCode **
Uma descrição do motivo pelo qual a operação não é compatível.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/DeleteHypervisor)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteHypervisor)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteHypervisor)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteHypervisor)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteHypervisor)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteHypervisor)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteHypervisor)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteHypervisor)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteHypervisor)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DeleteHypervisor)
# DisassociateGatewayFromServer
Desassocia um gateway de backup do servidor especificado. Depois que o processo de dissociação for concluído, o gateway não poderá mais acessar as máquinas virtuais no servidor.
## Sintaxe da solicitação
```
{
"GatewayArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_RequestSyntax) **
O nome de recurso da Amazon (ARN) do gateway a ser desassociado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"GatewayArn": "string"
}
```
## Elementos de resposta
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.
** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do gateway desassociado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** ConflictException **
Não foi possível continuar a operação porque ela não é compatível.
** ErrorCode **
Uma descrição do motivo pelo qual a operação não é compatível.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/DisassociateGatewayFromServer)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DisassociateGatewayFromServer)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DisassociateGatewayFromServer)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DisassociateGatewayFromServer)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DisassociateGatewayFromServer)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer)
# GetBandwidthRateLimitSchedule
Recupera a programação dos limites da taxa de largura de banda para um gateway especificado. Por padrão, os gateways não têm programações de limite de taxa de largura de banda, o que significa que nenhum limite de taxa de largura de banda está em vigor. Use isso para obter uma programação de limite de taxa de largura de banda de um gateway.
## Sintaxe da solicitação
```
{
"GatewayArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do gateway. Use a [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)operação para retornar uma lista de gateways para sua conta e. Região da AWS
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"BandwidthRateLimitIntervals": [
{
"AverageUploadRateLimitInBitsPerSec": number,
"DaysOfWeek": [ number ],
"EndHourOfDay": number,
"EndMinuteOfHour": number,
"StartHourOfDay": number,
"StartMinuteOfHour": number
}
],
"GatewayArn": "string"
}
```
## Elementos de resposta
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.
** [BandwidthRateLimitIntervals](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **
Uma matriz contendo intervalos de programação de limite de taxa de largura de banda para um gateway. Quando nenhum intervalo limite de taxa de largura de banda é programado, a matriz fica vazia.
Tipo: matriz de objetos [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md)
Membros da Matriz: número mínimo de 0 itens. Número máximo de 20 itens.
** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do gateway. Use a [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)operação para retornar uma lista de gateways para sua conta e. Região da AWS
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule)
# GetGateway
Ao fornecer o ARN (Nome do recurso da Amazon), essa API retorna o gateway.
## Sintaxe da solicitação
```
{
"GatewayArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [GatewayArn](#API_BGW_GetGateway_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do gateway.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"Gateway": {
"DeprecationDate": number,
"GatewayArn": "string",
"GatewayDisplayName": "string",
"GatewayType": "string",
"HypervisorId": "string",
"LastSeenTime": number,
"MaintenanceStartTime": {
"DayOfMonth": number,
"DayOfWeek": number,
"HourOfDay": number,
"MinuteOfHour": number
},
"NextUpdateAvailabilityTime": number,
"SoftwareVersion": "string",
"VpcEndpoint": "string"
}
}
```
## Elementos de resposta
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.
** [Gateway](#API_BGW_GetGateway_ResponseSyntax) **
Ao fornecer o ARN (Nome do recurso da Amazon), essa API retorna o gateway.
Tipo: objeto [GatewayDetails](API_BGW_GatewayDetails.md)
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/GetGateway)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetGateway)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetGateway)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetGateway)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetGateway)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetGateway)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetGateway)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetGateway)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetGateway)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetGateway)
# GetHypervisor
Essa ação solicita informações sobre o hipervisor especificado ao qual o gateway se conectará. Um hipervisor é um hardware, software ou firmware que cria e gerencia máquinas virtuais e aloca recursos para elas.
## Sintaxe da solicitação
```
{
"HypervisorArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [HypervisorArn](#API_BGW_GetHypervisor_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"Hypervisor": {
"Host": "string",
"HypervisorArn": "string",
"KmsKeyArn": "string",
"LastSuccessfulMetadataSyncTime": number,
"LatestMetadataSyncStatus": "string",
"LatestMetadataSyncStatusMessage": "string",
"LogGroupArn": "string",
"Name": "string",
"State": "string"
}
}
```
## Elementos de resposta
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.
** [Hypervisor](#API_BGW_GetHypervisor_ResponseSyntax) **
Detalhes sobre o hipervisor solicitado.
Tipo: objeto [HypervisorDetails](API_BGW_HypervisorDetails.md)
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/GetHypervisor)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisor)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisor)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisor)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisor)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisor)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisor)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisor)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisor)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetHypervisor)
# GetHypervisorPropertyMappings
Essa ação recupera os mapeamentos de propriedades do hipervisor especificado. Um mapeamento de propriedades do hipervisor exibe a relação das propriedades da entidade disponíveis no hipervisor com as propriedades disponíveis no. AWS
## Sintaxe da solicitação
```
{
"HypervisorArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"HypervisorArn": "string",
"IamRoleArn": "string",
"VmwareToAwsTagMappings": [
{
"AwsTagKey": "string",
"AwsTagValue": "string",
"VmwareCategory": "string",
"VmwareTagName": "string"
}
]
}
```
## Elementos de resposta
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.
** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
** [IamRoleArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do perfil do IAM.
Tipo: string
Restrições de tamanho: tamanho mínimo 20. Tamanho máximo de 2.048.
Padrão: `arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`
** [VmwareToAwsTagMappings](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **
Essa é uma exibição dos mapeamentos das VMware tags para as AWS tags.
Tipo: matriz de objetos [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md)
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/GetHypervisorPropertyMappings)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisorPropertyMappings)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisorPropertyMappings)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisorPropertyMappings)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings)
# GetVirtualMachine
Ao fornecer o ARN (Nome do recurso da Amazon), essa API retorna a máquina virtual.
## Sintaxe da solicitação
```
{
"ResourceArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceArn](#API_BGW_GetVirtualMachine_RequestSyntax) **
O Nome do recurso da Amazon (ARN) da máquina virtual.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"VirtualMachine": {
"HostName": "string",
"HypervisorId": "string",
"LastBackupDate": number,
"Name": "string",
"Path": "string",
"ResourceArn": "string",
"VmwareTags": [
{
"VmwareCategory": "string",
"VmwareTagDescription": "string",
"VmwareTagName": "string"
}
]
}
}
```
## Elementos de resposta
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.
** [VirtualMachine](#API_BGW_GetVirtualMachine_ResponseSyntax) **
Este objeto contém os atributos básicos da `VirtualMachine` contidos na saída da `GetVirtualMachine`
Tipo: objeto [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md)
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/GetVirtualMachine)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetVirtualMachine)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetVirtualMachine)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetVirtualMachine)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetVirtualMachine)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetVirtualMachine)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetVirtualMachine)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetVirtualMachine)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetVirtualMachine)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetVirtualMachine)
# ImportHypervisorConfiguration
Conecte-se a um hipervisor importando sua configuração.
## Sintaxe da solicitação
```
{
"Host": "string",
"KmsKeyArn": "string",
"Name": "string",
"Password": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Username": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [Host](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
O host do servidor do hipervisor. Isso pode ser um endereço IP ou um nome de domínio totalmente qualificado (FQDN).
Tipo: string
Restrições de tamanho: tamanho mínimo de 3. O tamanho máximo é 128.
Padrão: `.+`
Obrigatório: Sim
** [KmsKeyArn](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
O AWS Key Management Service para o hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`
Obrigatório: não
** [Name](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
O nome do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[a-zA-Z0-9-]*`
Obrigatório: Sim
** [Password](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
A senha do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[ -~]+`
Obrigatório: não
** [Tags](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
As tags da configuração do hipervisor a ser importada.
Tipo: matriz de objetos [Tag](API_BGW_Tag.md)
Obrigatório: não
** [Username](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **
O nome de usuário do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`
Obrigatório: Não
## Sintaxe da resposta
```
{
"HypervisorArn": "string"
}
```
## Elementos de resposta
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.
** [HypervisorArn](#API_BGW_ImportHypervisorConfiguration_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor desassociado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Não foi possível continuar a operação porque você não tem permissões suficientes.
** ErrorCode **
Uma descrição do motivo pelo qual você não tem permissões suficientes.
Código de status HTTP: 400
** ConflictException **
Não foi possível continuar a operação porque ela não é compatível.
** ErrorCode **
Uma descrição do motivo pelo qual a operação não é compatível.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/ImportHypervisorConfiguration)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ImportHypervisorConfiguration)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ImportHypervisorConfiguration)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ImportHypervisorConfiguration)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ImportHypervisorConfiguration)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration)
# ListGateways
Lista os gateways de backup pertencentes a um Conta da AWS em um Região da AWS. A lista retornada é solicitada pelo Nome do recurso da Amazon (ARN) do gateway.
## Sintaxe da solicitação
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [MaxResults](#API_BGW_ListGateways_RequestSyntax) **
O número máximo de gateways a serem listados.
Tipo: inteiro
Intervalo válido: valor mínimo de 1.
Obrigatório: não
** [NextToken](#API_BGW_ListGateways_RequestSyntax) **
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
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.
Padrão: `.+`
Obrigatório: Não
## Sintaxe da resposta
```
{
"Gateways": [
{
"GatewayArn": "string",
"GatewayDisplayName": "string",
"GatewayType": "string",
"HypervisorId": "string",
"LastSeenTime": number
}
],
"NextToken": "string"
}
```
## Elementos de resposta
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.
** [Gateways](#API_BGW_ListGateways_ResponseSyntax) **
Uma lista dos seus gateways.
Tipo: matriz de objetos [Gateway](API_BGW_Gateway.md)
** [NextToken](#API_BGW_ListGateways_ResponseSyntax) **
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
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.
Padrão: `.+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/ListGateways)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListGateways)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListGateways)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListGateways)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListGateways)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListGateways)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListGateways)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListGateways)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListGateways)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListGateways)
# ListHypervisors
Lista seus hipervisores.
## Sintaxe da solicitação
```
{
"MaxResults": number,
"NextToken": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [MaxResults](#API_BGW_ListHypervisors_RequestSyntax) **
O número máximo de hipervisores a serem listados.
Tipo: inteiro
Intervalo válido: valor mínimo de 1.
Obrigatório: não
** [NextToken](#API_BGW_ListHypervisors_RequestSyntax) **
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
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.
Padrão: `.+`
Obrigatório: Não
## Sintaxe da resposta
```
{
"Hypervisors": [
{
"Host": "string",
"HypervisorArn": "string",
"KmsKeyArn": "string",
"Name": "string",
"State": "string"
}
],
"NextToken": "string"
}
```
## Elementos de resposta
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.
** [Hypervisors](#API_BGW_ListHypervisors_ResponseSyntax) **
Uma lista de seus `Hypervisor` objetos, ordenada por seus nomes de recursos da Amazon (ARNs).
Tipo: matriz de objetos [Hypervisor](API_BGW_Hypervisor.md)
** [NextToken](#API_BGW_ListHypervisors_ResponseSyntax) **
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
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.
Padrão: `.+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/ListHypervisors)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListHypervisors)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListHypervisors)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListHypervisors)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListHypervisors)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListHypervisors)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListHypervisors)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListHypervisors)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListHypervisors)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListHypervisors)
# ListTagsForResource
Lista as tags aplicadas ao recurso identificado pelo seu Nome do recurso da Amazon (ARN).
## Sintaxe da solicitação
```
{
"ResourceArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceArn](#API_BGW_ListTagsForResource_RequestSyntax) **
O Nome do recurso da Amazon (ARN) das tags do recurso a serem listadas.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"ResourceArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Elementos de resposta
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.
** [ResourceArn](#API_BGW_ListTagsForResource_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) das tags do recurso que você listou.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
** [Tags](#API_BGW_ListTagsForResource_ResponseSyntax) **
Listar as tags do recurso.
Tipo: matriz de objetos [Tag](API_BGW_Tag.md)
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/ListTagsForResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListTagsForResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListTagsForResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListTagsForResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListTagsForResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListTagsForResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListTagsForResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListTagsForResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListTagsForResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListTagsForResource)
# ListVirtualMachines
Lista suas máquinas virtuais.
## Sintaxe da solicitação
```
{
"HypervisorArn": "string",
"MaxResults": number,
"NextToken": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [HypervisorArn](#API_BGW_ListVirtualMachines_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor conectado à sua máquina virtual.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: não
** [MaxResults](#API_BGW_ListVirtualMachines_RequestSyntax) **
O número máximo de máquinas virtuais a serem listadas.
Tipo: inteiro
Intervalo válido: valor mínimo de 1.
Obrigatório: não
** [NextToken](#API_BGW_ListVirtualMachines_RequestSyntax) **
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
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.
Padrão: `.+`
Obrigatório: Não
## Sintaxe da resposta
```
{
"NextToken": "string",
"VirtualMachines": [
{
"HostName": "string",
"HypervisorId": "string",
"LastBackupDate": number,
"Name": "string",
"Path": "string",
"ResourceArn": "string"
}
]
}
```
## Elementos de resposta
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_BGW_ListVirtualMachines_ResponseSyntax) **
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
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.
Padrão: `.+`
** [VirtualMachines](#API_BGW_ListVirtualMachines_ResponseSyntax) **
Uma lista de seus `VirtualMachine` objetos, ordenada por seus nomes de recursos da Amazon (ARNs).
Tipo: matriz de objetos [VirtualMachine](API_BGW_VirtualMachine.md)
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/ListVirtualMachines)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListVirtualMachines)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListVirtualMachines)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListVirtualMachines)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListVirtualMachines)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListVirtualMachines)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListVirtualMachines)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListVirtualMachines)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListVirtualMachines)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListVirtualMachines)
# PutBandwidthRateLimitSchedule
Essa ação define a programação dos limites da taxa de largura de banda para um gateway especificado. Por padrão, os gateways não têm uma programação de limite de taxa de largura de banda, o que significa que nenhum limite de taxa de largura de banda está em vigor. Use isso para iniciar a programação de limite de taxa de largura de banda de um gateway.
## Sintaxe da solicitação
```
{
"BandwidthRateLimitIntervals": [
{
"AverageUploadRateLimitInBitsPerSec": number,
"DaysOfWeek": [ number ],
"EndHourOfDay": number,
"EndMinuteOfHour": number,
"StartHourOfDay": number,
"StartMinuteOfHour": number
}
],
"GatewayArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [BandwidthRateLimitIntervals](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **
Uma matriz contendo intervalos de programação de limite de taxa de largura de banda para um gateway. Quando nenhum intervalo limite de taxa de largura de banda é programado, a matriz fica vazia.
Tipo: matriz de objetos [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md)
Membros da Matriz: número mínimo de 0 itens. Número máximo de 20 itens.
Obrigatório: Sim
** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do gateway. Use a [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)operação para retornar uma lista de gateways para sua conta e. Região da AWS
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"GatewayArn": "string"
}
```
## Elementos de resposta
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.
** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do gateway. Use a [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)operação para retornar uma lista de gateways para sua conta e. Região da AWS
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule)
# PutHypervisorPropertyMappings
Essa ação define os mapeamentos de propriedades para o hipervisor especificado. Um mapeamento de propriedades do hipervisor exibe a relação das propriedades da entidade disponíveis no hipervisor com as propriedades disponíveis no. AWS
## Sintaxe da solicitação
```
{
"HypervisorArn": "string",
"IamRoleArn": "string",
"VmwareToAwsTagMappings": [
{
"AwsTagKey": "string",
"AwsTagValue": "string",
"VmwareCategory": "string",
"VmwareTagName": "string"
}
]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Sim
** [IamRoleArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do perfil do IAM.
Tipo: string
Restrições de tamanho: tamanho mínimo 20. Tamanho máximo de 2.048.
Padrão: `arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`
Obrigatório: Sim
** [VmwareToAwsTagMappings](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **
Essa ação solicita o mapeamento das VMware tags para as AWS tags.
Tipo: matriz de objetos [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md)
Obrigatório: sim
## Sintaxe da resposta
```
{
"HypervisorArn": "string"
}
```
## Elementos de resposta
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.
** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Não foi possível continuar a operação porque você não tem permissões suficientes.
** ErrorCode **
Uma descrição do motivo pelo qual você não tem permissões suficientes.
Código de status HTTP: 400
** ConflictException **
Não foi possível continuar a operação porque ela não é compatível.
** ErrorCode **
Uma descrição do motivo pelo qual a operação não é compatível.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/PutHypervisorPropertyMappings)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutHypervisorPropertyMappings)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutHypervisorPropertyMappings)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutHypervisorPropertyMappings)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings)
# PutMaintenanceStartTime
Defina o horário de início da manutenção de um gateway.
## Sintaxe da solicitação
```
{
"DayOfMonth": number,
"DayOfWeek": number,
"GatewayArn": "string",
"HourOfDay": number,
"MinuteOfHour": number
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [DayOfMonth](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
O dia do mês para iniciar a manutenção em um gateway.
Os valores válidos variam de `Sunday` até `Saturday`.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 31.
Obrigatório: não
** [DayOfWeek](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
O dia da semana para iniciar a manutenção em um gateway.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 6.
Obrigatório: não
** [GatewayArn](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do gateway, usado para especificar o horário de início da manutenção.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Sim
** [HourOfDay](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
A hora do dia para iniciar a manutenção em um gateway.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 23.
Obrigatório: Sim
** [MinuteOfHour](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **
O minuto da hora para iniciar a manutenção em um gateway.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 59.
Obrigatório: sim
## Sintaxe da resposta
```
{
"GatewayArn": "string"
}
```
## Elementos de resposta
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.
** [GatewayArn](#API_BGW_PutMaintenanceStartTime_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) de um gateway para o qual você define o horário de início da manutenção.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** ConflictException **
Não foi possível continuar a operação porque ela não é compatível.
** ErrorCode **
Uma descrição do motivo pelo qual a operação não é compatível.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/PutMaintenanceStartTime)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutMaintenanceStartTime)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutMaintenanceStartTime)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutMaintenanceStartTime)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutMaintenanceStartTime)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutMaintenanceStartTime)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutMaintenanceStartTime)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutMaintenanceStartTime)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutMaintenanceStartTime)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutMaintenanceStartTime)
# StartVirtualMachinesMetadataSync
Essa ação envia uma solicitação para sincronizar metadados nas máquinas virtuais especificadas.
## Sintaxe da solicitação
```
{
"HypervisorArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"HypervisorArn": "string"
}
```
## Elementos de resposta
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.
** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Não foi possível continuar a operação porque você não tem permissões suficientes.
** ErrorCode **
Uma descrição do motivo pelo qual você não tem permissões suficientes.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync)
# TagResource
Marca o recurso.
## Sintaxe da solicitação
```
{
"ResourceARN": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceARN](#API_BGW_TagResource_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do recurso a ser marcado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Sim
** [Tags](#API_BGW_TagResource_RequestSyntax) **
A lista de tags a serem atribuídas ao recurso.
Tipo: matriz de objetos [Tag](API_BGW_Tag.md)
Obrigatório: sim
## Sintaxe da resposta
```
{
"ResourceARN": "string"
}
```
## Elementos de resposta
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.
** [ResourceARN](#API_BGW_TagResource_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do recurso marcado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/TagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/TagResource)
# TestHypervisorConfiguration
Testa a configuração do hipervisor para validar se o gateway de backup pode se conectar ao hipervisor e seus recursos.
## Sintaxe da solicitação
```
{
"GatewayArn": "string",
"Host": "string",
"Password": "string",
"Username": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [GatewayArn](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do gateway para o hipervisor a ser testado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Sim
** [Host](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **
O host do servidor do hipervisor. Isso pode ser um endereço IP ou um nome de domínio totalmente qualificado (FQDN).
Tipo: string
Restrições de tamanho: tamanho mínimo de 3. O tamanho máximo é 128.
Padrão: `.+`
Obrigatório: Sim
** [Password](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **
A senha do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[ -~]+`
Obrigatório: não
** [Username](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **
O nome de usuário do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`
Obrigatório: Não
## Elementos de resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** ConflictException **
Não foi possível continuar a operação porque ela não é compatível.
** ErrorCode **
Uma descrição do motivo pelo qual a operação não é compatível.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/TestHypervisorConfiguration)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TestHypervisorConfiguration)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TestHypervisorConfiguration)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TestHypervisorConfiguration)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TestHypervisorConfiguration)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TestHypervisorConfiguration)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TestHypervisorConfiguration)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TestHypervisorConfiguration)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TestHypervisorConfiguration)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/TestHypervisorConfiguration)
# UntagResource
Remove tags do recurso.
## Sintaxe da solicitação
```
{
"ResourceARN": "string",
"TagKeys": [ "string" ]
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [ResourceARN](#API_BGW_UntagResource_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do recurso do qual remover as tags.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Sim
** [TagKeys](#API_BGW_UntagResource_RequestSyntax) **
A lista de chaves de tag especificando quais tags a serem removidas.
Tipo: matriz de strings
Restrições de Tamanho: Tamanho mínimo 1. O tamanho máximo é 128.
Padrão: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`
Obrigatório: sim
## Sintaxe da resposta
```
{
"ResourceARN": "string"
}
```
## Elementos de resposta
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.
** [ResourceARN](#API_BGW_UntagResource_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do recurso do qual remover as tags.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/UntagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UntagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UntagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UntagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UntagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UntagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UntagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UntagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UntagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UntagResource)
# UpdateGatewayInformation
Atualiza o nome de um gateway. Especifique o gateway a ser atualizado usando o Nome do recurso da Amazon (ARN) do gateway em sua solicitação.
## Sintaxe da solicitação
```
{
"GatewayArn": "string",
"GatewayDisplayName": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [GatewayArn](#API_BGW_UpdateGatewayInformation_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do gateway a ser atualizado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Sim
** [GatewayDisplayName](#API_BGW_UpdateGatewayInformation_RequestSyntax) **
O nome de exibição atualizado do gateway.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[a-zA-Z0-9-]*`
Obrigatório: Não
## Sintaxe da resposta
```
{
"GatewayArn": "string"
}
```
## Elementos de resposta
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.
** [GatewayArn](#API_BGW_UpdateGatewayInformation_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do gateway atualizado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** ConflictException **
Não foi possível continuar a operação porque ela não é compatível.
** ErrorCode **
Uma descrição do motivo pelo qual a operação não é compatível.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/UpdateGatewayInformation)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewayInformation)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewayInformation)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewayInformation)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewayInformation)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewayInformation)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewayInformation)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewayInformation)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewayInformation)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateGatewayInformation)
# UpdateGatewaySoftwareNow
Atualiza o software da máquina virtual (VM) do gateway. A solicitação aciona imediatamente a atualização do software.
**nota**
Ao fazer essa solicitação, você recebe uma resposta de êxito `200 OK` imediatamente. No entanto, pode levar algum tempo até que a atualização seja concluída.
## Sintaxe da solicitação
```
{
"GatewayArn": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do gateway a ser atualizado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: sim
## Sintaxe da resposta
```
{
"GatewayArn": "string"
}
```
## Elementos de resposta
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.
** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do gateway atualizado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/UpdateGatewaySoftwareNow)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow)
# UpdateHypervisor
Atualiza os metadados de um hipervisor, incluindo seu host, nome de usuário e senha. Especifique qual hipervisor atualizar usando o Nome do recurso da Amazon (ARN) do hipervisor em sua solicitação.
## Sintaxe da solicitação
```
{
"Host": "string",
"HypervisorArn": "string",
"LogGroupArn": "string",
"Name": "string",
"Password": "string",
"Username": "string"
}
```
## Parâmetros da solicitação
Para obter informações sobre os parâmetros que são comuns em todas as ações, consulte [Parâmetros comuns](CommonParameters.md).
A solicitação aceita os dados a seguir no formato JSON.
** [Host](#API_BGW_UpdateHypervisor_RequestSyntax) **
O host atualizado do hipervisor. Isso pode ser um endereço IP ou um nome de domínio totalmente qualificado (FQDN).
Tipo: string
Restrições de tamanho: tamanho mínimo de 3. O tamanho máximo é 128.
Padrão: `.+`
Obrigatório: não
** [HypervisorArn](#API_BGW_UpdateHypervisor_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor a ser atualizado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Sim
** [LogGroupArn](#API_BGW_UpdateHypervisor_RequestSyntax) **
O Nome do recurso da Amazon (ARN) do grupo de gateways no log solicitado.
Tipo: string
Restrições de tamanho: tamanho mínimo 0. Comprimento máximo de 2.048.
Padrão: `$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*`
Obrigatório: não
** [Name](#API_BGW_UpdateHypervisor_RequestSyntax) **
O nome atualizado do hipervisor
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[a-zA-Z0-9-]*`
Obrigatório: não
** [Password](#API_BGW_UpdateHypervisor_RequestSyntax) **
A senha atualizada do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[ -~]+`
Obrigatório: não
** [Username](#API_BGW_UpdateHypervisor_RequestSyntax) **
O nome de usuário atualizado do hipervisor.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`
Obrigatório: Não
## Sintaxe da resposta
```
{
"HypervisorArn": "string"
}
```
## Elementos de resposta
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.
** [HypervisorArn](#API_BGW_UpdateHypervisor_ResponseSyntax) **
O Nome do recurso da Amazon (ARN) do hipervisor atualizado.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
## Erros
Para obter informações sobre os erros comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Não foi possível continuar a operação porque você não tem permissões suficientes.
** ErrorCode **
Uma descrição do motivo pelo qual você não tem permissões suficientes.
Código de status HTTP: 400
** ConflictException **
Não foi possível continuar a operação porque ela não é compatível.
** ErrorCode **
Uma descrição do motivo pelo qual a operação não é compatível.
Código de status HTTP: 400
** InternalServerException **
A operação não teve êxito porque ocorreu um erro interno. Tente novamente mais tarde.
** ErrorCode **
Uma descrição de qual erro interno ocorreu.
Código de status HTTP: 500
** ResourceNotFoundException **
Um recurso necessário para a ação não foi encontrado.
** ErrorCode **
A descrição de qual recurso não foi encontrado.
Código de status HTTP: 400
** ThrottlingException **
O TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
** ErrorCode **
Erro: o TPS foi limitado para proteger contra altos volumes de solicitações intencionais ou não intencionais.
Código de status HTTP: 400
** ValidationException **
A operação não teve êxito porque ocorreu um erro de validação.
** ErrorCode **
Uma descrição do que causou o erro de validação.
Código de Status HTTP: 400
## Consulte também
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-gateway-2021-01-01/UpdateHypervisor)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateHypervisor)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateHypervisor)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateHypervisor)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateHypervisor)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateHypervisor)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateHypervisor)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateHypervisor)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateHypervisor)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateHypervisor)
# Pesquisa do AWS Backup
As seguintes ações são apoiadas por Pesquisa do AWS Backup:
+ [GetSearchJob](API_BKS_GetSearchJob.md)
+ [GetSearchResultExportJob](API_BKS_GetSearchResultExportJob.md)
+ [ListSearchJobBackups](API_BKS_ListSearchJobBackups.md)
+ [ListSearchJobResults](API_BKS_ListSearchJobResults.md)
+ [ListSearchJobs](API_BKS_ListSearchJobs.md)
+ [ListSearchResultExportJobs](API_BKS_ListSearchResultExportJobs.md)
+ [ListTagsForResource](API_BKS_ListTagsForResource.md)
+ [StartSearchJob](API_BKS_StartSearchJob.md)
+ [StartSearchResultExportJob](API_BKS_StartSearchResultExportJob.md)
+ [StopSearchJob](API_BKS_StopSearchJob.md)
+ [TagResource](API_BKS_TagResource.md)
+ [UntagResource](API_BKS_UntagResource.md)
# GetSearchJob
Essa operação recupera metadados de um trabalho de pesquisa, incluindo seu andamento.
## Sintaxe da Solicitação
```
GET /search-jobs/SearchJobIdentifier HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [SearchJobIdentifier](#API_BKS_GetSearchJob_RequestSyntax) **
String exclusiva obrigatória que especifica o trabalho de pesquisa.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"CompletionTime": number,
"CreationTime": number,
"CurrentSearchProgress": {
"ItemsMatchedCount": number,
"ItemsScannedCount": number,
"RecoveryPointsScannedCount": number
},
"EncryptionKeyArn": "string",
"ItemFilters": {
"EBSItemFilters": [
{
"CreationTimes": [
{
"Operator": "string",
"Value": number
}
],
"FilePaths": [
{
"Operator": "string",
"Value": "string"
}
],
"LastModificationTimes": [
{
"Operator": "string",
"Value": number
}
],
"Sizes": [
{
"Operator": "string",
"Value": number
}
]
}
],
"S3ItemFilters": [
{
"CreationTimes": [
{
"Operator": "string",
"Value": number
}
],
"ETags": [
{
"Operator": "string",
"Value": "string"
}
],
"ObjectKeys": [
{
"Operator": "string",
"Value": "string"
}
],
"Sizes": [
{
"Operator": "string",
"Value": number
}
],
"VersionIds": [
{
"Operator": "string",
"Value": "string"
}
]
}
]
},
"Name": "string",
"SearchJobArn": "string",
"SearchJobIdentifier": "string",
"SearchScope": {
"BackupResourceArns": [ "string" ],
"BackupResourceCreationTime": {
"CreatedAfter": number,
"CreatedBefore": number
},
"BackupResourceTags": {
"string" : "string"
},
"BackupResourceTypes": [ "string" ],
"SourceResourceArns": [ "string" ]
},
"SearchScopeSummary": {
"TotalItemsToScanCount": number,
"TotalRecoveryPointsToScanCount": number
},
"Status": "string",
"StatusMessage": "string"
}
```
## Elementos de resposta
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.
** [CompletionTime](#API_BKS_GetSearchJob_ResponseSyntax) **
A data e hora em que um trabalho de pesquisa foi concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CompletionTime` 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
** [CreationTime](#API_BKS_GetSearchJob_ResponseSyntax) **
A data e a hora em que um trabalho de pesquisa foi criado, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CompletionTime` 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
** [CurrentSearchProgress](#API_BKS_GetSearchJob_ResponseSyntax) **
Retorna números representando BackupsScannedCount ItemsScanned, ItemsMatched e.
Tipo: objeto [CurrentSearchProgress](API_BKS_CurrentSearchProgress.md)
** [EncryptionKeyArn](#API_BKS_GetSearchJob_ResponseSyntax) **
A chave de criptografia para o trabalho de pesquisa especificado.
Exemplo: `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
Tipo: string
** [ItemFilters](#API_BKS_GetSearchJob_ResponseSyntax) **
Os filtros de itens representam todas as propriedades do item de entrada especificadas quando a pesquisa foi criada.
Tipo: objeto [ItemFilters](API_BKS_ItemFilters.md)
** [Name](#API_BKS_GetSearchJob_ResponseSyntax) **
Nome retornado do trabalho de pesquisa especificado.
Tipo: string
** [SearchJobArn](#API_BKS_GetSearchJob_ResponseSyntax) **
A string exclusiva que identifica o nome do recurso da Amazon (ARN) do trabalho de pesquisa especificado.
Tipo: string
** [SearchJobIdentifier](#API_BKS_GetSearchJob_ResponseSyntax) **
A string exclusiva que identifica o trabalho de pesquisa especificado.
Tipo: string
** [SearchScope](#API_BKS_GetSearchJob_ResponseSyntax) **
O escopo da pesquisa consiste em todas as propriedades de backup inseridas em uma pesquisa.
Tipo: objeto [SearchScope](API_BKS_SearchScope.md)
** [SearchScopeSummary](#API_BKS_GetSearchJob_ResponseSyntax) **
Resumo retornado do escopo do trabalho de pesquisa especificado, incluindo:
+ TotalBackupsToScanCount, o número de pontos de recuperação retornados pela pesquisa.
+ TotalItemsToScanCount, o número de itens retornados pela pesquisa.
Tipo: objeto [SearchScopeSummary](API_BKS_SearchScopeSummary.md)
** [Status](#API_BKS_GetSearchJob_ResponseSyntax) **
O status atual do trabalho de pesquisa especificado.
Um trabalho de pesquisa pode ter um destes status: `RUNNING`; `COMPLETED`; `STOPPED`; `FAILED`; `TIMED_OUT`; ou `EXPIRED`.
Tipo: string
Valores válidos: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`
** [StatusMessage](#API_BKS_GetSearchJob_ResponseSyntax) **
Uma mensagem de status será retornada para um trabalho de pesquisa com um status de `ERRORED` ou um status de trabalhos `COMPLETED` com problemas.
Por exemplo, uma mensagem pode dizer que uma pesquisa continha pontos de recuperação que não puderam ser verificados devido a um problema de permissões.
Tipo: string
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/GetSearchJob)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/GetSearchJob)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/GetSearchJob)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/GetSearchJob)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/GetSearchJob)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/GetSearchJob)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/GetSearchJob)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/GetSearchJob)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/GetSearchJob)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/GetSearchJob)
# GetSearchResultExportJob
Essa operação recupera os metadados de um trabalho de exportação.
Um trabalho de exportação é uma operação que transmite os resultados de um trabalho de pesquisa para um bucket do S3 especificado em um arquivo .csv.
Um trabalho de exportação permite reter os resultados de uma pesquisa além da retenção programada de sete dias do trabalho de pesquisa.
## Sintaxe da Solicitação
```
GET /export-search-jobs/ExportJobIdentifier HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [ExportJobIdentifier](#API_BKS_GetSearchResultExportJob_RequestSyntax) **
Essa é a string exclusiva que identifica um trabalho de exportação específico.
Obrigatório para esta operação.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"CompletionTime": number,
"CreationTime": number,
"ExportJobArn": "string",
"ExportJobIdentifier": "string",
"ExportSpecification": { ... },
"SearchJobArn": "string",
"Status": "string",
"StatusMessage": "string"
}
```
## Elementos de resposta
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.
** [CompletionTime](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
A data e hora em que um trabalho de exportação foi concluído, 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
** [CreationTime](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
A data e a hora em que um trabalho de exploraçã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
** [ExportJobArn](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
O nome do recurso da Amazon (ARN) único que identifica de forma exclusiva o trabalho de exportação.
Tipo: string
** [ExportJobIdentifier](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
Essa é a string exclusiva que identifica o trabalho de exportação especificado.
Tipo: string
** [ExportSpecification](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
A especificação de exportação consiste no bucket do S3 de destino para o qual os resultados da pesquisa foram exportados, junto com o prefixo de destino.
Tipo: objeto [ExportSpecification](API_BKS_ExportSpecification.md)
**Observação:** este objeto é uma união. Somente um membro desse objeto pode ser especificado ou retornado.
** [SearchJobArn](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
A string exclusiva que identifica o nome do recurso da Amazon (ARN) do trabalho de pesquisa especificado.
Tipo: string
** [Status](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
Esse é o status atual do trabalho de exportação.
Tipo: string
Valores válidos: `RUNNING | FAILED | COMPLETED`
** [StatusMessage](#API_BKS_GetSearchResultExportJob_ResponseSyntax) **
Uma mensagem de status é uma string que é retornada para um trabalho de pesquisa com o status de `FAILED`, junto com as etapas para corrigir e repetir a operação.
Tipo: string
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/GetSearchResultExportJob)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/GetSearchResultExportJob)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/GetSearchResultExportJob)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/GetSearchResultExportJob)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/GetSearchResultExportJob)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/GetSearchResultExportJob)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/GetSearchResultExportJob)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/GetSearchResultExportJob)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/GetSearchResultExportJob)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/GetSearchResultExportJob)
# ListSearchJobBackups
Essa operação retorna uma lista de todos os backups (pontos de recuperação) em um formato paginado que foram incluídos no trabalho de pesquisa.
Se uma pesquisa não exibir um backup esperado nos resultados, você poderá chamar essa operação para exibir cada backup incluído na pesquisa. Todos os backups que não foram incluídos porque têm um status `FAILED` de um problema de permissões serão exibidos junto com uma mensagem de status.
Somente pontos de recuperação com um índice de backup que têm um status de `ACTIVE` serão incluídos nos resultados da pesquisa. Se o índice tiver qualquer outro status, este será exibido junto com uma mensagem de status.
## Sintaxe da Solicitação
```
GET /search-jobs/SearchJobIdentifier/backups?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_BKS_ListSearchJobBackups_RequestSyntax) **
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_BKS_ListSearchJobBackups_RequestSyntax) **
O próximo item após uma lista parcial dos backups retornados incluídos em um trabalho de pesquisa.
Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de backups, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.
** [SearchJobIdentifier](#API_BKS_ListSearchJobBackups_RequestSyntax) **
A string exclusiva que especifica o trabalho de pesquisa.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Results": [
{
"BackupCreationTime": number,
"BackupResourceArn": "string",
"IndexCreationTime": number,
"ResourceType": "string",
"SourceResourceArn": "string",
"Status": "string",
"StatusMessage": "string"
}
]
}
```
## Elementos de resposta
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_BKS_ListSearchJobBackups_ResponseSyntax) **
O próximo item após uma lista parcial dos backups retornados incluídos em um trabalho de pesquisa.
Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de backups, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.
Tipo: string
** [Results](#API_BKS_ListSearchJobBackups_ResponseSyntax) **
Os pontos de recuperação retornados pelos resultados de um trabalho de pesquisa
Tipo: matriz de objetos [SearchJobBackupsResult](API_BKS_SearchJobBackupsResult.md)
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/ListSearchJobBackups)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchJobBackups)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchJobBackups)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchJobBackups)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchJobBackups)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchJobBackups)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchJobBackups)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchJobBackups)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchJobBackups)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListSearchJobBackups)
# ListSearchJobResults
Essa operação retorna uma lista de um trabalho de pesquisa especificado.
## Sintaxe da Solicitação
```
GET /search-jobs/SearchJobIdentifier/search-results?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_BKS_ListSearchJobResults_RequestSyntax) **
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_BKS_ListSearchJobResults_RequestSyntax) **
O próximo item após uma lista parcial dos resultados retornados do trabalho de pesquisa.
Por exemplo, se uma solicitação for feita para retornar o número `MaxResults` de resultados do trabalho de pesquisa, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.
** [SearchJobIdentifier](#API_BKS_ListSearchJobResults_RequestSyntax) **
A string exclusiva que especifica o trabalho de pesquisa.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Results": [
{ ... }
]
}
```
## Elementos de resposta
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_BKS_ListSearchJobResults_ResponseSyntax) **
O próximo item após uma lista parcial dos resultados do trabalho de pesquisa.
Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de backups, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.
Tipo: string
** [Results](#API_BKS_ListSearchJobResults_ResponseSyntax) **
Os resultados consistem em EBSResult Item ou S3ResultItem.
Tipo: matriz de objetos [ResultItem](API_BKS_ResultItem.md)
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/ListSearchJobResults)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchJobResults)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchJobResults)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchJobResults)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchJobResults)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchJobResults)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchJobResults)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchJobResults)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchJobResults)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListSearchJobResults)
# ListSearchJobs
Essa operação retorna uma lista de trabalhos de pesquisa pertencentes a uma conta.
## Sintaxe da Solicitação
```
GET /search-jobs?MaxResults=MaxResults&NextToken=NextToken&Status=ByStatus HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [ByStatus](#API_BKS_ListSearchJobs_RequestSyntax) **
Inclua esse parâmetro para filtrar a lista pelo status do trabalho de pesquisa.
Valores válidos: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`
** [MaxResults](#API_BKS_ListSearchJobs_RequestSyntax) **
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_BKS_ListSearchJobs_RequestSyntax) **
O próximo item após uma lista parcial de trabalhos de pesquisa retornados.
Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de backups, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"SearchJobs": [
{
"CompletionTime": number,
"CreationTime": number,
"Name": "string",
"SearchJobArn": "string",
"SearchJobIdentifier": "string",
"SearchScopeSummary": {
"TotalItemsToScanCount": number,
"TotalRecoveryPointsToScanCount": number
},
"Status": "string",
"StatusMessage": "string"
}
]
}
```
## Elementos de resposta
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_BKS_ListSearchJobs_ResponseSyntax) **
O próximo item após uma lista parcial dos backups retornados incluídos em um trabalho de pesquisa.
Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de backups, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.
Tipo: string
** [SearchJobs](#API_BKS_ListSearchJobs_ResponseSyntax) **
Os trabalhos de pesquisa na lista, com detalhes dos trabalhos de pesquisa retornados.
Tipo: matriz de objetos [SearchJobSummary](API_BKS_SearchJobSummary.md)
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ThrottlingException **
A solicitação foi negada devido ao controle de limitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/ListSearchJobs)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchJobs)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchJobs)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchJobs)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchJobs)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchJobs)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchJobs)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchJobs)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchJobs)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListSearchJobs)
# ListSearchResultExportJobs
Essa operação exporta os resultados da pesquisa de um trabalho de pesquisa para um bucket do S3 de destino especificado.
## Sintaxe da Solicitação
```
GET /export-search-jobs?MaxResults=MaxResults&NextToken=NextToken&SearchJobIdentifier=SearchJobIdentifier&Status=Status HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [MaxResults](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **
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_BKS_ListSearchResultExportJobs_RequestSyntax) **
O próximo item após uma lista parcial dos backups retornados incluídos em um trabalho de pesquisa.
Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de backups, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.
** [SearchJobIdentifier](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **
A string exclusiva que especifica o trabalho de pesquisa.
** [Status](#API_BKS_ListSearchResultExportJobs_RequestSyntax) **
Os trabalhos de pesquisa que devem ser incluídos no trabalho de exportação podem ser filtrados com a inclusão desse parâmetro.
Valores válidos: `RUNNING | FAILED | COMPLETED`
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"ExportJobs": [
{
"CompletionTime": number,
"CreationTime": number,
"ExportJobArn": "string",
"ExportJobIdentifier": "string",
"SearchJobArn": "string",
"Status": "string",
"StatusMessage": "string"
}
],
"NextToken": "string"
}
```
## Elementos de resposta
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.
** [ExportJobs](#API_BKS_ListSearchResultExportJobs_ResponseSyntax) **
A operação retorna os trabalhos de exportação incluídos.
Tipo: matriz de objetos [ExportJobSummary](API_BKS_ExportJobSummary.md)
** [NextToken](#API_BKS_ListSearchResultExportJobs_ResponseSyntax) **
O próximo item após uma lista parcial dos backups retornados incluídos em um trabalho de pesquisa.
Por exemplo, se for feita uma solicitação para retornar o número `MaxResults` de backups, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.
Tipo: string
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ServiceQuotaExceededException **
A solicitação foi negada por exceder os limites de cota permitidos.
** message **
Essa solicitação não foi bem-sucedida devido a uma cota de serviço que excedeu os limites.
** quotaCode **
Esse é o código específico para o tipo de cota.
** resourceId **
Identificador do recurso.
** resourceType **
Tipo de recurso.
** serviceCode **
Esse é o código exclusivo do serviço de origem com a cota.
Código de status HTTP: 402
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/ListSearchResultExportJobs)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListSearchResultExportJobs)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListSearchResultExportJobs)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListSearchResultExportJobs)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListSearchResultExportJobs)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListSearchResultExportJobs)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListSearchResultExportJobs)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListSearchResultExportJobs)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListSearchResultExportJobs)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListSearchResultExportJobs)
# ListTagsForResource
Essa operação retorna as tags de um tipo de recurso.
## Sintaxe da Solicitação
```
GET /tags/ResourceArn HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [ResourceArn](#API_BKS_ListTagsForResource_RequestSyntax) **
O nome do recurso da Amazon (ARN) que identifica de forma exclusiva o recurso.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
```
## Elementos de resposta
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.
** [Tags](#API_BKS_ListTagsForResource_ResponseSyntax) **
Lista de tags retornadas pela operação.
Tipo: mapa de string para string
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/ListTagsForResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/ListTagsForResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ListTagsForResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/ListTagsForResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ListTagsForResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/ListTagsForResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/ListTagsForResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/ListTagsForResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/ListTagsForResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ListTagsForResource)
# StartSearchJob
Essa operação cria um trabalho de pesquisa que retorna pontos de recuperação filtrados por SearchScope e itens filtrados por. ItemFilters
Opcionalmente, você pode incluir ClientToken EncryptionKeyArn, Nome, and/or Tags.
## Sintaxe da Solicitação
```
PUT /search-jobs HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"EncryptionKeyArn": "string",
"ItemFilters": {
"EBSItemFilters": [
{
"CreationTimes": [
{
"Operator": "string",
"Value": number
}
],
"FilePaths": [
{
"Operator": "string",
"Value": "string"
}
],
"LastModificationTimes": [
{
"Operator": "string",
"Value": number
}
],
"Sizes": [
{
"Operator": "string",
"Value": number
}
]
}
],
"S3ItemFilters": [
{
"CreationTimes": [
{
"Operator": "string",
"Value": number
}
],
"ETags": [
{
"Operator": "string",
"Value": "string"
}
],
"ObjectKeys": [
{
"Operator": "string",
"Value": "string"
}
],
"Sizes": [
{
"Operator": "string",
"Value": number
}
],
"VersionIds": [
{
"Operator": "string",
"Value": "string"
}
]
}
]
},
"Name": "string",
"SearchScope": {
"BackupResourceArns": [ "string" ],
"BackupResourceCreationTime": {
"CreatedAfter": number,
"CreatedBefore": number
},
"BackupResourceTags": {
"string" : "string"
},
"BackupResourceTypes": [ "string" ],
"SourceResourceArns": [ "string" ]
},
"Tags": {
"string" : "string"
}
}
```
## Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [ClientToken](#API_BKS_StartSearchJob_RequestSyntax) **
Inclua esse parâmetro para permitir várias chamadas idênticas de idempotência.
Um token de cliente é válido por oito horas depois que a primeira solicitação que o utiliza é concluída. Após esse prazo, qualquer solicitação com o mesmo token será tratada como uma nova solicitação.
Tipo: string
Obrigatório: não
** [EncryptionKeyArn](#API_BKS_StartSearchJob_RequestSyntax) **
A chave de criptografia para o trabalho de pesquisa especificado.
Tipo: string
Obrigatório: não
** [ItemFilters](#API_BKS_StartSearchJob_RequestSyntax) **
Os filtros de itens representam todas as propriedades do item de entrada especificadas quando a pesquisa foi criada.
Contém EBSItem filtros ou S3 ItemFilters
Tipo: objeto [ItemFilters](API_BKS_ItemFilters.md)
Obrigatório: não
** [Name](#API_BKS_StartSearchJob_RequestSyntax) **
Inclua caracteres alfanuméricos para criar um nome para esse trabalho de pesquisa.
Tipo: string
Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 500.
Obrigatório: não
** [SearchScope](#API_BKS_StartSearchJob_RequestSyntax) **
Esse objeto pode conter BackupResourceTypes,, BackupResourceArns BackupResourceCreationTime BackupResourceTags, e SourceResourceArns filtrar os pontos de recuperação retornados pelo trabalho de pesquisa.
Tipo: objeto [SearchScope](API_BKS_SearchScope.md)
Obrigatório: Sim
** [Tags](#API_BKS_StartSearchJob_RequestSyntax) **
Lista de tags retornadas pela operação.
Tipo: mapa de string para string
Obrigatório: Não
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"SearchJobArn": "string",
"SearchJobIdentifier": "string"
}
```
## Elementos de resposta
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_BKS_StartSearchJob_ResponseSyntax) **
A data e a hora em que um trabalho foi criado, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CompletionTime` 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
** [SearchJobArn](#API_BKS_StartSearchJob_ResponseSyntax) **
A string exclusiva que identifica o nome do recurso da Amazon (ARN) do trabalho de pesquisa especificado.
Tipo: string
** [SearchJobIdentifier](#API_BKS_StartSearchJob_ResponseSyntax) **
A string exclusiva que especifica o trabalho de pesquisa.
Tipo: string
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** ConflictException **
Essa exceção ocorre quando um conflito com uma operação anterior bem-sucedida é detectado. Isso geralmente ocorre quando a operação anterior não teve tempo de se propagar para o host que atende à solicitação atual.
Uma nova tentativa (com a lógica de recuo apropriada) é a resposta recomendada para essa exceção.
** message **
Atualizar ou excluir um recurso pode causar um estado inconsistente.
** resourceId **
Identificador do recurso afetado.
** resourceType **
Tipo do recurso afetado.
Código de Status HTTP: 409
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ServiceQuotaExceededException **
A solicitação foi negada por exceder os limites de cota permitidos.
** message **
Essa solicitação não foi bem-sucedida devido a uma cota de serviço que excedeu os limites.
** quotaCode **
Esse é o código específico para o tipo de cota.
** resourceId **
Identificador do recurso.
** resourceType **
Tipo de recurso.
** serviceCode **
Esse é o código exclusivo do serviço de origem com a cota.
Código de status HTTP: 402
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/StartSearchJob)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/StartSearchJob)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StartSearchJob)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/StartSearchJob)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StartSearchJob)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/StartSearchJob)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/StartSearchJob)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/StartSearchJob)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/StartSearchJob)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/StartSearchJob)
# StartSearchResultExportJob
Essa operação inicia um trabalho para exportar os resultados do trabalho de pesquisa para um bucket do S3 designado.
## Sintaxe da Solicitação
```
PUT /export-search-jobs HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"ExportSpecification": { ... },
"RoleArn": "string",
"SearchJobIdentifier": "string",
"Tags": {
"string" : "string"
}
}
```
## Parâmetros da solicitação de URI
A solicitação não usa nenhum parâmetro de URI.
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [ClientToken](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
Inclua esse parâmetro para permitir várias chamadas idênticas de idempotência.
Um token de cliente é válido por oito horas depois que a primeira solicitação que o utiliza é concluída. Após esse prazo, qualquer solicitação com o mesmo token será tratada como uma nova solicitação.
Tipo: string
Obrigatório: não
** [ExportSpecification](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
Essa especificação contém uma string obrigatória do bucket de destino. Se preferir, inclua o prefixo de destino.
Tipo: objeto [ExportSpecification](API_BKS_ExportSpecification.md)
**Observação:** este objeto é uma união. Somente um membro desse objeto pode ser especificado ou retornado.
Obrigatório: Sim
** [RoleArn](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
Esse parâmetro especifica o ARN do perfil usado para iniciar os trabalhos de exportação dos resultados da pesquisa.
Tipo: string
Restrições de tamanho: tamanho mínimo 20. Tamanho máximo de 2.048.
Padrão: `arn:(?:aws|aws-cn|aws-us-gov):iam::[a-z0-9-]+:role/(.+)`
Obrigatório: não
** [SearchJobIdentifier](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
A string exclusiva que especifica o trabalho de pesquisa.
Tipo: String
Obrigatório: Sim
** [Tags](#API_BKS_StartSearchResultExportJob_RequestSyntax) **
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
## Sintaxe da resposta
```
HTTP/1.1 200
Content-type: application/json
{
"ExportJobArn": "string",
"ExportJobIdentifier": "string"
}
```
## Elementos de resposta
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.
** [ExportJobArn](#API_BKS_StartSearchResultExportJob_ResponseSyntax) **
Esse é o ARN (nome do recurso da Amazon) exclusivo que pertence ao novo trabalho de exportação.
Tipo: string
** [ExportJobIdentifier](#API_BKS_StartSearchResultExportJob_ResponseSyntax) **
Esse é o identificador exclusivo que especifica o novo trabalho de exportação.
Tipo: string
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** ConflictException **
Essa exceção ocorre quando um conflito com uma operação anterior bem-sucedida é detectado. Isso geralmente ocorre quando a operação anterior não teve tempo de se propagar para o host que atende à solicitação atual.
Uma nova tentativa (com a lógica de recuo apropriada) é a resposta recomendada para essa exceção.
** message **
Atualizar ou excluir um recurso pode causar um estado inconsistente.
** resourceId **
Identificador do recurso afetado.
** resourceType **
Tipo do recurso afetado.
Código de Status HTTP: 409
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ServiceQuotaExceededException **
A solicitação foi negada por exceder os limites de cota permitidos.
** message **
Essa solicitação não foi bem-sucedida devido a uma cota de serviço que excedeu os limites.
** quotaCode **
Esse é o código específico para o tipo de cota.
** resourceId **
Identificador do recurso.
** resourceType **
Tipo de recurso.
** serviceCode **
Esse é o código exclusivo do serviço de origem com a cota.
Código de status HTTP: 402
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/StartSearchResultExportJob)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/StartSearchResultExportJob)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StartSearchResultExportJob)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/StartSearchResultExportJob)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StartSearchResultExportJob)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/StartSearchResultExportJob)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/StartSearchResultExportJob)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/StartSearchResultExportJob)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/StartSearchResultExportJob)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/StartSearchResultExportJob)
# StopSearchJob
Essa operação encerra um trabalho de pesquisa.
Somente um trabalho de pesquisa com o status de `RUNNING` pode ser interrompido.
## Sintaxe da Solicitação
```
PUT /search-jobs/SearchJobIdentifier/actions/cancel HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [SearchJobIdentifier](#API_BKS_StopSearchJob_RequestSyntax) **
A string exclusiva que especifica o trabalho de pesquisa.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** ConflictException **
Essa exceção ocorre quando um conflito com uma operação anterior bem-sucedida é detectado. Isso geralmente ocorre quando a operação anterior não teve tempo de se propagar para o host que atende à solicitação atual.
Uma nova tentativa (com a lógica de recuo apropriada) é a resposta recomendada para essa exceção.
** message **
Atualizar ou excluir um recurso pode causar um estado inconsistente.
** resourceId **
Identificador do recurso afetado.
** resourceType **
Tipo do recurso afetado.
Código de Status HTTP: 409
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/StopSearchJob)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/StopSearchJob)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StopSearchJob)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/StopSearchJob)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StopSearchJob)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/StopSearchJob)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/StopSearchJob)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/StopSearchJob)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/StopSearchJob)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/StopSearchJob)
# TagResource
Essa operação coloca tags no recurso que você indica.
## Sintaxe da Solicitação
```
POST /tags/ResourceArn HTTP/1.1
Content-type: application/json
{
"Tags": {
"string" : "string"
}
}
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [ResourceArn](#API_BKS_TagResource_RequestSyntax) **
O nome do recurso da Amazon (ARN) que identifica de forma exclusiva o recurso.
Esse é o recurso que terá as tags indicadas.
Obrigatório: Sim
## Corpo da Solicitação
A solicitação aceita os dados a seguir no formato JSON.
** [Tags](#API_BKS_TagResource_RequestSyntax) **
Tags obrigatórias que devem ser 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: sim
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/TagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/TagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/TagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/TagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/TagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/TagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/TagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/TagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/TagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/TagResource)
# UntagResource
Essa operação remove tags do recurso especificado.
## Sintaxe da Solicitação
```
DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1
```
## Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
** [ResourceArn](#API_BKS_UntagResource_RequestSyntax) **
O nome do recurso da Amazon (ARN) que identifica de forma exclusiva o recurso do qual você quer remover as tags.
Obrigatório: Sim
** [TagKeys](#API_BKS_UntagResource_RequestSyntax) **
Esse parâmetro obrigatório contém as chaves de tag que você deseja remover da origem.
Obrigatório: Sim
## Corpo da Solicitação
Essa solicitação não tem corpo.
## Sintaxe da resposta
```
HTTP/1.1 200
```
## Elementos de Resposta
Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.
## Erros
Para obter informações sobre os erros que são comuns a todas as ações, consulte [Tipos de erro comuns](CommonErrors.md).
** AccessDeniedException **
Você não tem acesso suficiente para executar esta ação.
** message **
O usuário não tem acesso suficiente para executar esta ação.
Código de status HTTP: 403
** InternalServerException **
Ocorreu um erro interno do servidor. Tente sua solicitação novamente.
** message **
Erro inesperado durante o processamento da solicitação.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
Código de status HTTP: 500
** ResourceNotFoundException **
O recurso não foi encontrado para essa solicitação.
Confirme se as informações do recurso, como o ARN ou o tipo, estão corretas e existem e, então, repita a solicitação.
** message **
A solicitação faz referência a um recurso que não existe.
** resourceId **
Identificador hipotético do recurso afetado.
** resourceType **
Tipo hipotético do recurso afetado.
Código de status HTTP: 404
** ThrottlingException **
A solicitação foi negada devido à limitação da solicitação.
** message **
A solicitação não foi bem-sucedida devido ao controle de utilização da solicitação.
** quotaCode **
Esse é o código exclusivo do serviço de origem com a cota.
** retryAfterSeconds **
Tente fazer a chamada novamente após alguns segundos.
** serviceCode **
Esse é o código exclusivo do serviço de origem.
Código de status HTTP: 429
** ValidationException **
A entrada não atende às restrições especificadas por um serviço.
** message **
A entrada não atende às restrições especificadas por um serviço da Amazon.
Código de Status HTTP: 400
## Consulte também
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/backupsearch-2018-05-10/UntagResource)
+ [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backupsearch-2018-05-10/UntagResource)
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/UntagResource)
+ [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backupsearch-2018-05-10/UntagResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/UntagResource)
+ [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backupsearch-2018-05-10/UntagResource)
+ [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backupsearch-2018-05-10/UntagResource)
+ [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backupsearch-2018-05-10/UntagResource)
+ [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backupsearch-2018-05-10/UntagResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/UntagResource)
# Tipos de dados
Os seguintes tipos de dados são compatíveis com AWS Backup:
+ [AdvancedBackupSetting](API_AdvancedBackupSetting.md)
+ [AggregatedScanResult](API_AggregatedScanResult.md)
+ [BackupJob](API_BackupJob.md)
+ [BackupJobSummary](API_BackupJobSummary.md)
+ [BackupPlan](API_BackupPlan.md)
+ [BackupPlanInput](API_BackupPlanInput.md)
+ [BackupPlansListMember](API_BackupPlansListMember.md)
+ [BackupPlanTemplatesListMember](API_BackupPlanTemplatesListMember.md)
+ [BackupRule](API_BackupRule.md)
+ [BackupRuleInput](API_BackupRuleInput.md)
+ [BackupSelection](API_BackupSelection.md)
+ [BackupSelectionsListMember](API_BackupSelectionsListMember.md)
+ [BackupVaultListMember](API_BackupVaultListMember.md)
+ [CalculatedLifecycle](API_CalculatedLifecycle.md)
+ [Condition](API_Condition.md)
+ [ConditionParameter](API_ConditionParameter.md)
+ [Conditions](API_Conditions.md)
+ [ControlInputParameter](API_ControlInputParameter.md)
+ [ControlScope](API_ControlScope.md)
+ [CopyAction](API_CopyAction.md)
+ [CopyJob](API_CopyJob.md)
+ [CopyJobSummary](API_CopyJobSummary.md)
+ [DateRange](API_DateRange.md)
+ [Framework](API_Framework.md)
+ [FrameworkControl](API_FrameworkControl.md)
+ [IndexAction](API_IndexAction.md)
+ [IndexedRecoveryPoint](API_IndexedRecoveryPoint.md)
+ [KeyValue](API_KeyValue.md)
+ [LatestMpaApprovalTeamUpdate](API_LatestMpaApprovalTeamUpdate.md)
+ [LatestRevokeRequest](API_LatestRevokeRequest.md)
+ [LegalHold](API_LegalHold.md)
+ [Lifecycle](API_Lifecycle.md)
+ [ProtectedResource](API_ProtectedResource.md)
+ [ProtectedResourceConditions](API_ProtectedResourceConditions.md)
+ [RecoveryPointByBackupVault](API_RecoveryPointByBackupVault.md)
+ [RecoveryPointByResource](API_RecoveryPointByResource.md)
+ [RecoveryPointCreator](API_RecoveryPointCreator.md)
+ [RecoveryPointMember](API_RecoveryPointMember.md)
+ [RecoveryPointSelection](API_RecoveryPointSelection.md)
+ [ReportDeliveryChannel](API_ReportDeliveryChannel.md)
+ [ReportDestination](API_ReportDestination.md)
+ [ReportJob](API_ReportJob.md)
+ [ReportPlan](API_ReportPlan.md)
+ [ReportSetting](API_ReportSetting.md)
+ [ResourceSelection](API_ResourceSelection.md)
+ [RestoreAccessBackupVaultListMember](API_RestoreAccessBackupVaultListMember.md)
+ [RestoreJobCreator](API_RestoreJobCreator.md)
+ [RestoreJobsListMember](API_RestoreJobsListMember.md)
+ [RestoreJobSummary](API_RestoreJobSummary.md)
+ [RestoreTestingPlanForCreate](API_RestoreTestingPlanForCreate.md)
+ [RestoreTestingPlanForGet](API_RestoreTestingPlanForGet.md)
+ [RestoreTestingPlanForList](API_RestoreTestingPlanForList.md)
+ [RestoreTestingPlanForUpdate](API_RestoreTestingPlanForUpdate.md)
+ [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md)
+ [RestoreTestingSelectionForCreate](API_RestoreTestingSelectionForCreate.md)
+ [RestoreTestingSelectionForGet](API_RestoreTestingSelectionForGet.md)
+ [RestoreTestingSelectionForList](API_RestoreTestingSelectionForList.md)
+ [RestoreTestingSelectionForUpdate](API_RestoreTestingSelectionForUpdate.md)
+ [ScanAction](API_ScanAction.md)
+ [ScanJob](API_ScanJob.md)
+ [ScanJobCreator](API_ScanJobCreator.md)
+ [ScanJobSummary](API_ScanJobSummary.md)
+ [ScanResult](API_ScanResult.md)
+ [ScanResultInfo](API_ScanResultInfo.md)
+ [ScanSetting](API_ScanSetting.md)
+ [ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md)
+ [TieringConfiguration](API_TieringConfiguration.md)
+ [TieringConfigurationInputForCreate](API_TieringConfigurationInputForCreate.md)
+ [TieringConfigurationInputForUpdate](API_TieringConfigurationInputForUpdate.md)
+ [TieringConfigurationsListMember](API_TieringConfigurationsListMember.md)
Os seguintes tipos de dados são compatíveis com AWS Backup gateway:
+ [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md)
+ [Gateway](API_BGW_Gateway.md)
+ [GatewayDetails](API_BGW_GatewayDetails.md)
+ [Hypervisor](API_BGW_Hypervisor.md)
+ [HypervisorDetails](API_BGW_HypervisorDetails.md)
+ [MaintenanceStartTime](API_BGW_MaintenanceStartTime.md)
+ [Tag](API_BGW_Tag.md)
+ [VirtualMachine](API_BGW_VirtualMachine.md)
+ [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md)
+ [VmwareTag](API_BGW_VmwareTag.md)
+ [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md)
Os seguintes tipos de dados são compatíveis com Pesquisa do AWS Backup:
+ [BackupCreationTimeFilter](API_BKS_BackupCreationTimeFilter.md)
+ [CurrentSearchProgress](API_BKS_CurrentSearchProgress.md)
+ [EBSItemFilter](API_BKS_EBSItemFilter.md)
+ [EBSResultItem](API_BKS_EBSResultItem.md)
+ [ExportJobSummary](API_BKS_ExportJobSummary.md)
+ [ExportSpecification](API_BKS_ExportSpecification.md)
+ [ItemFilters](API_BKS_ItemFilters.md)
+ [LongCondition](API_BKS_LongCondition.md)
+ [ResultItem](API_BKS_ResultItem.md)
+ [S3ExportSpecification](API_BKS_S3ExportSpecification.md)
+ [S3ItemFilter](API_BKS_S3ItemFilter.md)
+ [S3ResultItem](API_BKS_S3ResultItem.md)
+ [SearchJobBackupsResult](API_BKS_SearchJobBackupsResult.md)
+ [SearchJobSummary](API_BKS_SearchJobSummary.md)
+ [SearchScope](API_BKS_SearchScope.md)
+ [SearchScopeSummary](API_BKS_SearchScopeSummary.md)
+ [StringCondition](API_BKS_StringCondition.md)
+ [TimeCondition](API_BKS_TimeCondition.md)
# AWS Backup
Os seguintes tipos de dados são compatíveis com AWS Backup:
+ [AdvancedBackupSetting](API_AdvancedBackupSetting.md)
+ [AggregatedScanResult](API_AggregatedScanResult.md)
+ [BackupJob](API_BackupJob.md)
+ [BackupJobSummary](API_BackupJobSummary.md)
+ [BackupPlan](API_BackupPlan.md)
+ [BackupPlanInput](API_BackupPlanInput.md)
+ [BackupPlansListMember](API_BackupPlansListMember.md)
+ [BackupPlanTemplatesListMember](API_BackupPlanTemplatesListMember.md)
+ [BackupRule](API_BackupRule.md)
+ [BackupRuleInput](API_BackupRuleInput.md)
+ [BackupSelection](API_BackupSelection.md)
+ [BackupSelectionsListMember](API_BackupSelectionsListMember.md)
+ [BackupVaultListMember](API_BackupVaultListMember.md)
+ [CalculatedLifecycle](API_CalculatedLifecycle.md)
+ [Condition](API_Condition.md)
+ [ConditionParameter](API_ConditionParameter.md)
+ [Conditions](API_Conditions.md)
+ [ControlInputParameter](API_ControlInputParameter.md)
+ [ControlScope](API_ControlScope.md)
+ [CopyAction](API_CopyAction.md)
+ [CopyJob](API_CopyJob.md)
+ [CopyJobSummary](API_CopyJobSummary.md)
+ [DateRange](API_DateRange.md)
+ [Framework](API_Framework.md)
+ [FrameworkControl](API_FrameworkControl.md)
+ [IndexAction](API_IndexAction.md)
+ [IndexedRecoveryPoint](API_IndexedRecoveryPoint.md)
+ [KeyValue](API_KeyValue.md)
+ [LatestMpaApprovalTeamUpdate](API_LatestMpaApprovalTeamUpdate.md)
+ [LatestRevokeRequest](API_LatestRevokeRequest.md)
+ [LegalHold](API_LegalHold.md)
+ [Lifecycle](API_Lifecycle.md)
+ [ProtectedResource](API_ProtectedResource.md)
+ [ProtectedResourceConditions](API_ProtectedResourceConditions.md)
+ [RecoveryPointByBackupVault](API_RecoveryPointByBackupVault.md)
+ [RecoveryPointByResource](API_RecoveryPointByResource.md)
+ [RecoveryPointCreator](API_RecoveryPointCreator.md)
+ [RecoveryPointMember](API_RecoveryPointMember.md)
+ [RecoveryPointSelection](API_RecoveryPointSelection.md)
+ [ReportDeliveryChannel](API_ReportDeliveryChannel.md)
+ [ReportDestination](API_ReportDestination.md)
+ [ReportJob](API_ReportJob.md)
+ [ReportPlan](API_ReportPlan.md)
+ [ReportSetting](API_ReportSetting.md)
+ [ResourceSelection](API_ResourceSelection.md)
+ [RestoreAccessBackupVaultListMember](API_RestoreAccessBackupVaultListMember.md)
+ [RestoreJobCreator](API_RestoreJobCreator.md)
+ [RestoreJobsListMember](API_RestoreJobsListMember.md)
+ [RestoreJobSummary](API_RestoreJobSummary.md)
+ [RestoreTestingPlanForCreate](API_RestoreTestingPlanForCreate.md)
+ [RestoreTestingPlanForGet](API_RestoreTestingPlanForGet.md)
+ [RestoreTestingPlanForList](API_RestoreTestingPlanForList.md)
+ [RestoreTestingPlanForUpdate](API_RestoreTestingPlanForUpdate.md)
+ [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md)
+ [RestoreTestingSelectionForCreate](API_RestoreTestingSelectionForCreate.md)
+ [RestoreTestingSelectionForGet](API_RestoreTestingSelectionForGet.md)
+ [RestoreTestingSelectionForList](API_RestoreTestingSelectionForList.md)
+ [RestoreTestingSelectionForUpdate](API_RestoreTestingSelectionForUpdate.md)
+ [ScanAction](API_ScanAction.md)
+ [ScanJob](API_ScanJob.md)
+ [ScanJobCreator](API_ScanJobCreator.md)
+ [ScanJobSummary](API_ScanJobSummary.md)
+ [ScanResult](API_ScanResult.md)
+ [ScanResultInfo](API_ScanResultInfo.md)
+ [ScanSetting](API_ScanSetting.md)
+ [ScheduledPlanExecutionMember](API_ScheduledPlanExecutionMember.md)
+ [TieringConfiguration](API_TieringConfiguration.md)
+ [TieringConfigurationInputForCreate](API_TieringConfigurationInputForCreate.md)
+ [TieringConfigurationInputForUpdate](API_TieringConfigurationInputForUpdate.md)
+ [TieringConfigurationsListMember](API_TieringConfigurationsListMember.md)
# AdvancedBackupSetting
As opções de backup para cada tipo de recurso.
## Conteúdo
** BackupOptions **
Especifica a opção de backup para um recurso selecionado. Essa opção está disponível para trabalhos de backup do VSS do Windows e backups do S3.
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.
Para backups do S3, `"BackupACLs":"disabled"` defina como excluir ACLs do backup ou `"BackupObjectTags":"disabled"` excluir tags de objeto do backup. Por padrão, tanto as tags ACLs quanto as tags de objeto são incluídas nos backups do S3.
Se especificar uma opção inválida, você obterá uma exceção `InvalidParameterValueException`.
Para obter mais informações sobre backups do VSS do Windows, consulte [Criar um backup do Windows habilitado para VSS](https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html).
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
** ResourceType **
Especifica um objeto que contém o tipo de recurso e as opções de backup. O único tipo de recurso compatível são as instâncias do Amazon EC2 com o Serviço de Cópias de Sombra de Volume (VSS) do Windows. Para ver um CloudFormation exemplo, consulte o [ CloudFormation modelo de amostra para habilitar o Windows VSS](https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html) no *Guia do AWS Backup Usuário*.
Valores válidos: `EC2`.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/AdvancedBackupSetting)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/AdvancedBackupSetting)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/AdvancedBackupSetting)
# AggregatedScanResult
Contém resultados de escaneamento agregados em várias operações de escaneamento, fornecendo um resumo do status e das descobertas do escaneamento.
## Conteúdo
** FailedScan **
Um valor booleano indicando se alguma das varreduras agregadas falhou.
Tipo: booliano
Obrigatório: não
** Findings **
Uma série de descobertas descobertas em todas as varreduras agregadas.
Tipo: matriz de strings
Valores válidos: `MALWARE`
Obrigatório: não
** LastComputed **
O registro de data e hora em que o resultado da verificação agregada foi calculado pela última vez, no formato Unix e no Tempo Universal Coordenado (UTC).
Tipo: Timestamp
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/AggregatedScanResult)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/AggregatedScanResult)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/AggregatedScanResult)
# BackupJob
Contém informações detalhadas sobre um trabalho de backup.
## Conteúdo
** AccountId **
O ID da conta proprietária do trabalho de backup.
Tipo: sequência
Padrão: `^[0-9]{12}$`
Obrigatório: não
** BackupJobId **
Identifica de forma exclusiva uma solicitação para AWS Backup fazer backup de um recurso.
Tipo: string
Obrigatório: não
** BackupOptions **
Especifica 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. Se especificar uma opção inválida, você obterá uma exceção `InvalidParameterValueException`.
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
** BackupSizeInBytes **
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
Obrigatório: não
** BackupType **
Representa o tipo de backup para um trabalho de backup.
Tipo: string
Obrigatório: não
** BackupVaultArn **
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
Obrigatório: não
** BackupVaultName **
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`
Obrigatório: não
** BytesTransferred **
O tamanho em bytes transferido para um cofre de backup no momento em que o status do trabalho foi consultado.
Tipo: longo
Obrigatório: não
** CompletionDate **
A data e a hora em que um trabalho para criar um trabalho de backup 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: Carimbo de data/hora
Obrigatório: não
** CreatedBy **
Contém informações de identificação sobre a criação de um trabalho de backup, incluindo `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, e `BackupRuleId` do plano de backup usado para criá-lo.
Tipo: objeto [RecoveryPointCreator](API_RecoveryPointCreator.md)
Obrigatório: não
** CreationDate **
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: Carimbo de data/hora
Obrigatório: não
** EncryptionKeyArn **
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
Obrigatório: não
** ExpectedCompletionDate **
A data e a hora em que um trabalho para fazer backup de recursos foi 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: Carimbo de data/hora
Obrigatório: não
** IamRoleArn **
Especifica o ARN do perfil do IAM usado para criar o ponto de recuperação de destino. Os perfis do IAM que não sejam o perfil padrão devem incluir `AWSBackup` ou `AwsBackup` no nome do perfil. Por exemplo, .`arn:aws:iam::123456789012:role/AWSBackupRDSAccess` Os nomes de perfil sem essas strings não terão permissões para realizar trabalhos de backup.
Tipo: string
Obrigatório: não
** InitiationDate **
A data na qual o trabalho de backup foi iniciado.
Tipo: Carimbo de data/hora
Obrigatório: não
** IsEncrypted **
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
Obrigatório: não
** IsParent **
Isso é um valor booliano que indica que se trata de um trabalho de backup pai (composto).
Tipo: booliano
Obrigatório: não
** MessageCategory **
Esse parâmetro é a contagem de trabalhos para a categoria de mensagem especificada.
Exemplos de strings podem incluir `AccessDenied`, `SUCCESS`, `AGGREGATE_ALL` 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.
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.
Tipo: string
Obrigatório: não
** ParentJobId **
Isso identifica de forma exclusiva uma solicitação ao AWS Backup para fazer backup de um recurso. O retorno será o ID do trabalho pai (composto).
Tipo: string
Obrigatório: não
** PercentDone **
Contém uma porcentagem estimada de conclusão de um trabalho no momento em que o status do trabalho foi consultado.
Tipo: string
Obrigatório: não
** RecoveryPointArn **
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: não
** RecoveryPointLifecycle **
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
** ResourceArn **
Um ARN identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.
Tipo: string
Obrigatório: não
** ResourceName **
O nome não exclusivo do recurso que pertence ao backup especificado.
Tipo: string
Obrigatório: não
** ResourceType **
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). Para backups do Windows Volume Shadow Copy Service (VSS), o único tipo de recurso compatível é o Amazon EC2.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: não
** StartBy **
Especifica a hora em formato Unix e Tempo Universal Coordenado (UTC) em que um trabalho de backup deve ser iniciado antes de ser cancelado. 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: Carimbo de data/hora
Obrigatório: não
** State **
O estado atual de um trabalho de backup.
Tipo: string
Valores válidos: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL`
Obrigatório: não
** StatusMessage **
Uma mensagem detalhada explicando o status do trabalho para fazer backup de um recurso.
Tipo: string
Obrigatório: não
** VaultLockState **
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
Obrigatório: não
** VaultType **
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
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupJob)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupJob)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupJob)
# BackupJobSummary
Isso é um resumo dos trabalhos criados ou em execução nos últimos 30 dias.
O resumo retornado pode conter o seguinte: Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime e Count dos trabalhos incluídos.
## Conteúdo
** AccountId **
O ID da conta à qual os trabalhos no resumo pertencem.
Tipo: sequência
Padrão: : `^[0-9]{12}$`
Obrigatório: Não
** Count **
O valor como um número de trabalhos em um resumo do trabalhos.
Tipo: inteiro
Obrigatório: Não
** EndTime **
O valor do horário de término de um trabalho em formato numérico.
Esse valor é o horário no formato Unix, Tempo Universal Coordenado (UTC), e com precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: Timestamp
Obrigatório: Não
** MessageCategory **
Esse parâmetro é a contagem de trabalhos para a categoria de mensagem especificada.
Exemplos de strings incluem `AccessDenied`, `Success` e `InvalidParameters`. Consulte [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) para conferir uma lista de strings de MessageCategory.
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.
Tipo: String
Obrigatório: Não
** Region **
As regiões da AWS no resumo de trabalhos.
Tipo: String
Obrigatório: Não
** ResourceType **
Esse valor é a contagem de trabalhos para o tipo de recurso especificado. A solicitação `GetSupportedResourceTypes` retorna strings para os tipos de recurso compatíveis.
Tipo: sequência
Padrão: : `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Não
** StartTime **
O valor do horário de início de um trabalho em formato numérico.
Esse valor é o horário no formato Unix, Tempo Universal Coordenado (UTC), e com precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: Timestamp
Obrigatório: Não
** State **
Esse valor é a contagem dos trabalhos com o estado especificado.
Tipo: String
Valores Válidos: `CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL | AGGREGATE_ALL | ANY`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupJobSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupJobSummary)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupJobSummary)
# BackupPlan
Contém um nome de exibição opcional do plano de backup e uma matriz de objetos `BackupRule`, sendo que cada um especifica uma regra de backup. Cada regra em um plano de backup é uma tarefa programada separada e pode fazer backup de uma seleção diferente de recursos da AWS .
## Conteúdo
** BackupPlanName **
O nome de exibição de um plano de backup. Deve conter de somente caracteres alfanuméricos ou '-\$1.' caracteres especiais.
Se for definido no console, ele pode conter de 1 a 50 caracteres; se for definido por meio da CLI ou da API, poderá conter de 1 a 200 caracteres.
Tipo: String
Obrigatório: Sim
** Rules **
Uma matriz de objetos `BackupRule`, em que cada um especifica uma tarefa programada que é usada para fazer backup de uma seleção de recursos.
Tipo: matriz de objetos [BackupRule](API_BackupRule.md)
Obrigatório: sim
** AdvancedBackupSettings **
Contém uma lista de `BackupOptions` para cada tipo de recurso.
Tipo: matriz de objetos [AdvancedBackupSetting](API_AdvancedBackupSetting.md)
Obrigatório: não
** ScanSettings **
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)
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlan)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlan)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupPlan)
# BackupPlanInput
Contém um nome de exibição opcional do plano de backup e uma matriz de objetos `BackupRule`, sendo que cada um especifica uma regra de backup. Cada regra em um plano de backup é uma tarefa programada separada.
## Conteúdo
** BackupPlanName **
O nome de exibição de um plano de backup. Deve conter de 1 a 50 caracteres alfanuméricos ou '-\$1.' .
Tipo: String
Obrigatório: Sim
** Rules **
Uma matriz de objetos `BackupRule`, em que cada um especifica uma tarefa programada que é usada para fazer backup de uma seleção de recursos.
Tipo: matriz de objetos [BackupRuleInput](API_BackupRuleInput.md)
Obrigatório: sim
** AdvancedBackupSettings **
Especifica uma lista de `BackupOptions` para cada tipo de recurso. Essas configurações só estão disponíveis 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)
Obrigatório: não
** ScanSettings **
Contém sua configuração de escaneamento para a regra de backup e inclui o verificador de malware e o modo de escaneamento completo ou incremental.
Tipo: matriz de objetos [ScanSetting](API_ScanSetting.md)
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlanInput)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlanInput)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupPlanInput)
# BackupPlansListMember
Contém metadados sobre um plano de backup.
## Conteúdo
** AdvancedBackupSettings **
Contém uma lista de `BackupOptions` para um tipo de recurso.
Tipo: matriz de objetos [AdvancedBackupSetting](API_AdvancedBackupSetting.md)
Obrigatório: Não
** BackupPlanArn **
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
Obrigatório: Não
** BackupPlanId **
Identifica exclusivamente um plano de backup.
Tipo: String
Obrigatório: Não
** BackupPlanName **
O nome de exibição de um plano de backup salvo.
Tipo: String
Obrigatório: Não
** CreationDate **
A data e a hora em que o plano de backup de um recurso 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
Obrigatório: Não
** CreatorRequestId **
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
** DeletionDate **
A data e a 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
Obrigatório: Não
** LastExecutionDate **
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
Obrigatório: Não
** VersionId **
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
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlansListMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlansListMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupPlansListMember)
# BackupPlanTemplatesListMember
Um objeto que especifica os metadados associados a um modelo de plano de backup.
## Conteúdo
** BackupPlanTemplateId **
Identifica de forma exclusiva um modelo de plano de backup armazenado.
Tipo: String
Obrigatório: Não
** BackupPlanTemplateName **
O nome de exibição opcional de um modelo de plano de backup.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupPlanTemplatesListMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupPlanTemplatesListMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupPlanTemplatesListMember)
# BackupRule
Especifica uma tarefa programada usada para fazer backup de uma seleção de recursos.
## Conteúdo
** RuleName **
Um nome de exibição para uma regra de backup. Deve conter de 1 a 50 caracteres alfanuméricos ou '-\$1.' .
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Exigido: Sim
** TargetBackupVaultName **
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}$`
Exigido: Sim
** CompletionWindowMinutes **
Um valor em minutos após um trabalho de backup ser iniciado com êxito antes que ele seja concluído ou ele será cancelado pelo AWS Backup. Este valor é opcional.
Tipo: longo
Obrigatório: não
** CopyActions **
Uma matriz de objetos `CopyAction`, que contém os detalhes da operação de cópia.
Tipo: matriz de objetos [CopyAction](API_CopyAction.md)
Obrigatório: não
** EnableContinuousBackup **
Especifica se AWS Backup cria backups contínuos. Causas verdadeiras AWS Backup para criar backups contínuos capazes de point-in-time restauração (PITR). Causas falsas (ou não especificadas) AWS Backup para criar backups instantâneos.
Tipo: booliano
Obrigatório: não
** IndexActions **
IndexActions é uma matriz que você usa para especificar como os dados de backup devem ser indexados.
Cada um BackupRule pode ter 0 ou 1 IndexAction, pois cada backup pode ter até um índice associado a ele.
Dentro da matriz está ResourceType. Somente um será aceito para cada um BackupRule.
Tipo: matriz de objetos [IndexAction](API_IndexAction.md)
Obrigatório: não
** Lifecycle **
O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup 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)
Obrigatório: não
** RecoveryPointTags **
As tags são atribuídas aos recursos associados a essa regra quando restaurados do backup.
Tipo: mapa de string para string
Obrigatório: não
** RuleId **
Identifica de forma exclusiva uma regra usada para programar o backup de uma seleção de recursos.
Tipo: string
Obrigatório: não
** ScanActions **
Contém sua configuração de escaneamento para a regra de backup e inclui o verificador de malware e o modo de escaneamento completo ou incremental.
Tipo: matriz de objetos [ScanAction](API_ScanAction.md)
Obrigatório: não
** ScheduleExpression **
Uma expressão cron em UTC especificando quando AWS Backup inicia uma tarefa de backup. Quando nenhuma expressão CRON for fornecida, AWS Backup usará a expressão `cron(0 5 ? * * *)` padrão.
Para obter mais informações sobre expressões AWS cron, consulte [Programar expressões para regras](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html) no *Guia do usuário do Amazon CloudWatch Events*.
Dois exemplos de expressões AWS cron são ` 15 * ? * * *` (faça um backup a cada hora, 15 minutos após a hora) e `0 12 * * ? *` (faça um backup todos os dias às 12h UTC).
Para ver uma tabela de exemplos, clique no link anterior e role a página para baixo.
Tipo: string
Obrigatório: não
** ScheduleExpressionTimezone **
O fuso horário no qual a expressão de programação foi definida. Por padrão, ScheduleExpressions estão em UTC. É possível modificar isso para um fuso horário específico.
Tipo: string
Obrigatório: não
** StartWindowMinutes **
Um valor em minutos após a programação de um backup antes que um trabalho seja cancelado, se ele não for iniciado com êxito. Este valor é opcional. Se esse valor for incluído, deve ser de pelo menos 60 minutos para evitar erros.
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
** TargetLogicallyAirGappedBackupVaultArn **
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
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupRule)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupRule)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupRule)
# BackupRuleInput
Especifica uma tarefa programada usada para fazer backup de uma seleção de recursos.
## Conteúdo
** RuleName **
Um nome de exibição para uma regra de backup. Deve conter de 1 a 50 caracteres alfanuméricos ou '-\$1.' .
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Exigido: Sim
** TargetBackupVaultName **
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}$`
Exigido: Sim
** CompletionWindowMinutes **
Um valor em minutos após um trabalho de backup ser iniciado com êxito antes que ele seja concluído ou ele será cancelado pelo AWS Backup. Este valor é opcional.
Tipo: longo
Obrigatório: não
** CopyActions **
Uma matriz de objetos `CopyAction`, que contém os detalhes da operação de cópia.
Tipo: matriz de objetos [CopyAction](API_CopyAction.md)
Obrigatório: não
** EnableContinuousBackup **
Especifica se AWS Backup cria backups contínuos. Causas verdadeiras AWS Backup para criar backups contínuos capazes de point-in-time restauração (PITR). Causas falsas (ou não especificadas) AWS Backup para criar backups instantâneos.
Tipo: booliano
Obrigatório: não
** IndexActions **
Pode haver até um IndexAction em cada BackupRule, pois cada backup pode ter 0 ou 1 índice de backup associado a ele.
Dentro da matriz está ResourceTypes. Somente 1 tipo de recurso será aceito para cada um BackupRule. Valores válidos:
+ `EBS` para Amazon Elastic Block Store
+ `S3` para Amazon Simple Storage Service (Amazon S3)
Tipo: matriz de objetos [IndexAction](API_IndexAction.md)
Obrigatório: não
** Lifecycle **
O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup fará a transição e expirará os backups automaticamente de acordo com o ciclo de vida que você definir.
Os backups transferidos para 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 transição para armazenamento 'frio'" não poderá ser alterada depois que um backup for 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
** RecoveryPointTags **
As tags a serem atribuídas ao recurso.
Tipo: mapa de string para string
Obrigatório: não
** ScanActions **
Contém sua configuração de escaneamento para a regra de backup e inclui o verificador de malware e o modo de escaneamento completo ou incremental.
Tipo: matriz de objetos [ScanAction](API_ScanAction.md)
Obrigatório: não
** ScheduleExpression **
Uma expressão CRON em UTC especificando quando AWS Backup inicia uma tarefa de backup. Quando nenhuma expressão CRON for fornecida, AWS Backup usará a expressão `cron(0 5 ? * * *)` padrão.
Tipo: string
Obrigatório: não
** ScheduleExpressionTimezone **
O fuso horário no qual a expressão de programação foi definida. Por padrão, ScheduleExpressions estão em UTC. É possível modificar isso para um fuso horário específico.
Tipo: string
Obrigatório: não
** StartWindowMinutes **
Um valor em minutos após a programação de um backup antes que um trabalho seja cancelado, se ele não for iniciado com êxito. Este valor é opcional. 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
** TargetLogicallyAirGappedBackupVaultArn **
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
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupRuleInput)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupRuleInput)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupRuleInput)
# BackupSelection
Especifica um conjunto de recursos para um plano de backup.
Recomendamos que você especifique condições, tags ou recursos a serem incluídos ou excluídos. Caso contrário, o backup tentará selecionar todos os recursos de armazenamento compatíveis e inclusos, o que pode ter implicações de custo não intencionais.
Para obter mais informações, consulte [Atribuir recursos de forma programática](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json).
## Conteúdo
** IamRoleArn **
O ARN da função do IAM AWS Backup usada para autenticar ao fazer backup do recurso de destino; por exemplo,. `arn:aws:iam::123456789012:role/S3Access`
Tipo: String
Obrigatório: Sim
** SelectionName **
O nome de exibição de um documento de seleção de recursos. Deve conter de 1 a 50 caracteres alfanuméricos ou '-\$1.' .
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Sim
** Conditions **
A lista de condições que você define para atribuir recursos aos seus planos de backup usando tags. Por exemplo, .`"StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }`
`Conditions` oferece suporte a `StringEquals`, `StringLike`, `StringNotEquals` e `StringNotLike`. Os operadores de condição diferenciam maiúsculas de minúsculas.
Se você especificar várias condições, os recursos corresponderão a todas as condições (e à lógica).
Tipo: objeto [Conditions](API_Conditions.md)
Obrigatório: não
** ListOfTags **
Recomendamos o uso do parâmetro `Conditions`, em vez desse parâmetro.
A lista de condições que você define para atribuir recursos aos seus planos de backup usando tags. Por exemplo, .`"StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}`
`ListOfTags` suporte somente `StringEquals`. Os operadores de condição diferenciam maiúsculas de minúsculas.
Se você especificar várias condições, os recursos corresponderão a qualquer uma das condições (lógica OR).
Tipo: matriz de objetos [Condition](API_Condition.md)
Obrigatório: não
** NotResources **
Os nomes de recursos da Amazon (ARNs) dos recursos a serem excluídos de um plano de backup. O número máximo de ARNs é 500 sem curingas ou 30 ARNs com curingas.
Se você precisar excluir muitos recursos de um plano de backup, considere uma estratégia de seleção de recursos diferente, como atribuir apenas um ou alguns tipos de recursos ou refinar sua seleção de recursos usando tags.
Tipo: matriz de strings
Obrigatório: Não
** Resources **
Os nomes de recursos da Amazon (ARNs) dos recursos a serem atribuídos a um plano de backup. O número máximo de ARNs é 500 sem curingas ou 30 ARNs com curingas.
Se você precisar excluir muitos recursos de um plano de backup, considere uma estratégia de seleção de recursos diferente, como atribuir todos os recursos a um tipo de recursos ou refinar a seleção de recursos usando tags.
Se você especificar vários ARNs, os recursos corresponderão muito a qualquer uma das ARNs (lógica OR).
Ao usar curingas em padrões de ARN para seleções de backup, o asterisco (\$1) deve aparecer no final da string ARN (padrão de prefixo). Por exemplo, `arn:aws:s3:::my-bucket-*` é válido, mas não `arn:aws:s3:::*-logs` é suportado.
Tipo: matriz de strings
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupSelection)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupSelection)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupSelection)
# BackupSelectionsListMember
Contém metadados sobre um objeto `BackupSelection`.
## Conteúdo
** BackupPlanId **
Identifica exclusivamente um plano de backup.
Tipo: String
Obrigatório: Não
** CreationDate **
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
Obrigatório: Não
** CreatorRequestId **
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
** IamRoleArn **
Especifica o nome do recurso da Amazon (ARN) do perfil do IAM para criar o ponto de recuperação de destino. Por exemplo, `arn:aws:iam::123456789012:role/S3Access`.
Tipo: String
Obrigatório: Não
** SelectionId **
Identifica exclusivamente uma solicitação para atribuir um conjunto de recursos a um plano de backup.
Tipo: String
Obrigatório: Não
** SelectionName **
O nome de exibição de um documento de seleção de recursos.
Tipo: sequência
Padrão: : `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupSelectionsListMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupSelectionsListMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupSelectionsListMember)
# BackupVaultListMember
Contém metadados sobre um cofre de backup.
## Conteúdo
** BackupVaultArn **
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
Obrigatório: não
** BackupVaultName **
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`
Obrigatório: não
** CreationDate **
A data e a hora em que o plano de backup de um recurso 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: Carimbo de data/hora
Obrigatório: não
** CreatorRequestId **
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 **
Uma chave de criptografia do lado do servidor que você pode especificar para criptografar seus backups a partir de serviços que oferecem suporte ao AWS Backup gerenciamento completo; por exemplo,. `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` Se você especificar uma chave, deverá especificar seu ARN, e não seu alias. Se você não especificar uma chave, o AWS Backup criará uma chave do KMS para você por padrão.
Para saber quais AWS Backup serviços oferecem suporte ao AWS Backup gerenciamento completo e como AWS Backup lida com a criptografia para backups de serviços que ainda não oferecem suporte completo AWS Backup, consulte [Criptografia para backups em AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html)
Tipo: string
Obrigatório: não
** EncryptionKeyType **
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`
Obrigatório: não
** LockDate **
A data e a hora em que a configuração do AWS Backup Vault Lock se torna imutável, o que significa que 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 as 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: Carimbo de data/hora
Obrigatório: não
** Locked **
Um valor booleano que indica se o AWS Backup Vault Lock se aplica ao cofre de backup selecionado. Se`true`, o Vault Lock impede operações de exclusão e atualização nos pontos de recuperação no cofre selecionado.
Tipo: booliano
Obrigatório: não
** MaxRetentionDays **
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
Obrigatório: não
** MinRetentionDays **
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
Obrigatório: não
** NumberOfRecoveryPoints **
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.
Tipo: longo
Obrigatório: não
** VaultState **
O estado atual do cofre.
Tipo: string
Valores válidos: `CREATING | AVAILABLE | FAILED`
Obrigatório: não
** VaultType **
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`
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/BackupVaultListMember)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/BackupVaultListMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/BackupVaultListMember)
# CalculatedLifecycle
Contém os timestamps `DeleteAt` e `MoveToColdStorageAt`, que são usados para especificar o ciclo de vida de um ponto de recuperação.
O ciclo de vida define quando um recurso protegido é transferido para o armazenamento "frio" e quando ele expira. O AWS Backup faz a transição e a expiração de backups automaticamente de acordo com o ciclo de vida que você definir.
Os backups transferidos para armazenamento "frio" devem ficar armazenados lá por no mínimo 90 dias. Portanto, a configuração de “retenção” deve ser 90 dias a mais do que a configuração de “número de dias para a transição para o armazenamento frio”. A configuração de “número de dias para transferência ao armazenamento a frio” não pode ser alterada depois que um backup é transferido para o armazenamento a frio.
Os tipos de recursos que podem ser transferidos para o armazenamento a frio estão listados na tabela [Disponibilidade de recursos por recurso](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource). O AWS Backup ignora essa expressão para outros tipos de recurso.
## Conteúdo
** DeleteAt **
Um timestamp que especifica quando excluir um ponto de recuperação.
Tipo: Timestamp
Obrigatório: Não
** MoveToColdStorageAt **
Um timestamp que especifica quando fazer a transição de um ponto de recuperação para o armazenamento frio.
Tipo: Timestamp
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CalculatedLifecycle)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CalculatedLifecycle)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CalculatedLifecycle)
# Condition
Contém uma matriz de tripletos composta por um tipo de condição (como `StringEquals`), uma chave e um valor. Usado para filtrar recursos usando suas tags e atribuí-los a um plano de backup. Diferencia maiúsculas e minúsculas.
## Conteúdo
** ConditionKey **
A chave em um par de chave-valor. Por exemplo, na tag `Department: Accounting`, `Department` é a chave.
Tipo: string
Obrigatório: Sim
** ConditionType **
Uma operação aplicada a um par de chave/valor usado para atribuir recursos ao seu plano de backup. A condição só é compatível com `StringEquals`. Para opções de atribuição mais flexíveis, incluindo `StringLike` e a possibilidade de excluir recursos do seu plano de backup, use `Conditions` (com um “s” no final) para a [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html).
Tipo: String
Valores Válidos: `STRINGEQUALS`
Obrigatório: Sim
** ConditionValue **
O valor em um par de chave-valor. Por exemplo, na tag `Department: Accounting`, `Accounting` é o valor.
Tipo: string
Obrigatório: Sim
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Condition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Condition)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Condition)
# ConditionParameter
Inclui informações sobre tags definidas para atribuir recursos marcados a um plano de backup.
Inclua o prefixo `aws:ResourceTag` em suas tags. Por exemplo, `"aws:ResourceTag/TagKey1": "Value1"`.
## Conteúdo
** ConditionKey **
A chave em um par de chave-valor. Por exemplo, na tag `Department: Accounting`, `Department` é a chave.
Tipo: String
Obrigatório: Não
** ConditionValue **
O valor em um par de chave-valor. Por exemplo, na tag `Department: Accounting`, `Accounting` é o valor.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ConditionParameter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ConditionParameter)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ConditionParameter)
# Conditions
Contém informações sobre quais recursos incluir ou excluir de um plano de backup usando suas tags. As condições fazem distinção entre maiúsculas e minúsculas.
## Conteúdo
** StringEquals **
Filtra os valores dos seus recursos marcados somente para os recursos que você marcou com o mesmo valor. Também chamada de "correspondência exata".
Tipo: matriz de objetos [ConditionParameter](API_ConditionParameter.md)
Obrigatório: Não
** StringLike **
Filtra os valores dos recursos marcados para os valores de tag correspondentes com o uso de um caractere curinga (\$1) em qualquer posição na string. Por exemplo, "prod\$1" ou "\$1rod\$1" corresponde ao valor da tag “produção”.
Tipo: matriz de objetos [ConditionParameter](API_ConditionParameter.md)
Obrigatório: Não
** StringNotEquals **
Filtra os valores dos recursos marcados somente para os recursos que você marcou que não têm o mesmo valor. Também chamada de "correspondência negada”.
Tipo: matriz de objetos [ConditionParameter](API_ConditionParameter.md)
Obrigatório: Não
** StringNotLike **
Filtra os valores dos recursos marcados para valores de tag não correspondentes com o uso de um caractere curinga (\$1) em qualquer posição na string.
Tipo: matriz de objetos [ConditionParameter](API_ConditionParameter.md)
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Conditions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Conditions)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Conditions)
# ControlInputParameter
Os parâmetros para um controle. Um controle pode ter zero, um ou mais de um parâmetro. Um exemplo de controle com dois parâmetros é: “a frequência do plano de backup é pelo menos `daily` e o período de retenção é de pelo menos `1 year`“. O primeiro parâmetro é `daily`. O segundo parâmetro é `1 year`.
## Conteúdo
** ParameterName **
O nome de um parâmetro, por exemplo, `BackupPlanFrequency`.
Tipo: String
Obrigatório: Não
** ParameterValue **
O valor do parâmetro, por exemplo, `hourly`.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ControlInputParameter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ControlInputParameter)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ControlInputParameter)
# ControlScope
Uma framework consiste em um ou mais controles. Cada controle tem seu próprio escopo de controle. O escopo de controle pode incluir um ou mais tipos de recursos, uma combinação de chave e valor de tag, ou uma combinação de um tipo de recurso e um ID de recurso. Se nenhum escopo for especificado, as avaliações da regra serão acionadas quando qualquer recurso no grupo de registros for alterado na configuração.
**nota**
Para definir o escopo de um controle que inclua todo um recurso específico, deixe o `ControlScope` vazio ou não o passe ao chamar `CreateFramework`.
## Conteúdo
** ComplianceResourceIds **
O ID do único recurso AWS que você deseja que o escopo do controle contenha.
Tipo: matriz de strings
Membros da matriz: número mínimo de 1 item. Número máximo de 100 itens.
Obrigatório: Não
** ComplianceResourceTypes **
Descreve se o escopo do controle inclui um ou mais tipos de recursos, como `EFS` ou `RDS`.
Tipo: matriz de strings
Obrigatório: Não
** Tags **
O valor do par chave-valor aplicado aos recursos da AWS que você deseja que acionem uma avaliação de uma regra. No máximo um par chave-valor pode ser fornecido. O valor da tag é opcional, mas não pode ser uma string vazia se você estiver criando ou editando um framework a partir do console (embora o valor possa ser uma string vazia quando incluído em um modelo do CloudFormation).
A estrutura para atribuir uma tag é: `[{"Key":"string","Value":"string"}]`.
Tipo: mapa de string para string
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ControlScope)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ControlScope)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ControlScope)
# CopyAction
Os detalhes da operação de cópia.
## Conteúdo
** DestinationBackupVaultArn **
Um nome de recurso da Amazon (ARN) que identifica exclusivamente o cofre de backup de destino para o backup copiado. Por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
Tipo: string
Obrigatório: Sim
** Lifecycle **
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 armazenamento "frio" devem ficar armazenados lá 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 ser transferidos para o armazenamento a frio estão listados na tabela [Disponibilidade de recursos por recurso](https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource). O AWS Backup ignora essa expressão para outros tipos de recurso.
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
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CopyAction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CopyAction)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CopyAction)
# CopyJob
Contém informações detalhadas sobre um trabalho de cópia.
## Conteúdo
** AccountId **
O ID da conta proprietária do trabalho de cópia.
Tipo: sequência
Padrão: `^[0-9]{12}$`
Obrigatório: não
** BackupSizeInBytes **
O tamanho, em bytes, de um trabalho de cópia.
Tipo: longo
Obrigatório: não
** ChildJobsInState **
Isso retorna as estatísticas dos trabalhos de cópia filhos (aninhados) incluídos.
Tipo: mapa de string para string
Chaves válidas: `CREATED | RUNNING | COMPLETED | FAILED | PARTIAL`
Obrigatório: não
** CompletionDate **
A data e hora em que um trabalho de cópia 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
Obrigatório: não
** CompositeMemberIdentifier **
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
Obrigatório: não
** CopyJobId **
Identifica de forma exclusiva um trabalho de cópia.
Tipo: string
Obrigatório: não
** CreatedBy **
Contém informações sobre o plano de backup e a regra AWS Backup usados para iniciar o backup do ponto de recuperação.
Tipo: objeto [RecoveryPointCreator](API_RecoveryPointCreator.md)
Obrigatório: não
** CreatedByBackupJobId **
O ID do trabalho de backup que iniciou esse trabalho de cópia. Aplicável somente a trabalhos de cópia agendados e trabalhos de cópia automática em um cofre logicamente isolado.
Tipo: string
Obrigatório: não
** CreationDate **
A data e 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
Obrigatório: não
** DestinationBackupVaultArn **
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
Obrigatório: não
** DestinationEncryptionKeyArn **
O nome do recurso da Amazon (ARN) da chave do KMS usada para criptografar o backup copiado no cofre de destino. Isso pode ser uma chave gerenciada pelo cliente ou uma chave AWS gerenciada.
Tipo: string
Obrigatório: não
** DestinationRecoveryPointArn **
Um ARN que identifica de forma exclusiva um ponto de recuperação de destino. Por exemplo, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Tipo: string
Obrigatório: não
** DestinationRecoveryPointLifecycle **
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
** DestinationVaultLockState **
O estado do bloqueio do cofre de backup de destino. 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
Obrigatório: não
** DestinationVaultType **
O tipo de cofre de backup de destino no qual o ponto de recuperação copiado 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
Obrigatório: não
** IamRoleArn **
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: não
** IsParent **
Isso um valor booliano que indica que se trata de um trabalho de cópia pai (composto).
Tipo: booliano
Obrigatório: não
** MessageCategory **
Esse parâmetro é a contagem de trabalhos para a categoria de mensagem especificada.
Exemplos de strings podem incluir `AccessDenied`, `SUCCESS`, `AGGREGATE_ALL` 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.
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.
Tipo: string
Obrigatório: não
** NumberOfChildJobs **
O número de trabalhos de cópia (aninhados).
Tipo: longo
Obrigatório: não
** ParentJobId **
Isso identifica de forma exclusiva uma solicitação para o AWS Backup copiar um recurso. O retorno será o ID do trabalho pai (composto).
Tipo: string
Obrigatório: não
** ResourceArn **
O 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: string
Obrigatório: não
** ResourceName **
O nome não exclusivo do recurso que pertence ao backup especificado.
Tipo: string
Obrigatório: não
** ResourceType **
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}$`
Obrigatório: não
** SourceBackupVaultArn **
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
Obrigatório: não
** SourceRecoveryPointArn **
Um ARN que identifica de forma exclusiva um ponto de recuperação de origem. Por exemplo, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Tipo: string
Obrigatório: não
** State **
O estado atual de um trabalho de cópia.
Tipo: string
Valores válidos: `CREATED | RUNNING | COMPLETED | FAILED | PARTIAL`
Obrigatório: não
** StatusMessage **
Uma mensagem detalhada explicando o status do trabalho para copiar um recurso.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CopyJob)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CopyJob)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CopyJob)
# CopyJobSummary
Isso é um resumo dos trabalhos de cópia criados ou em execução nos últimos 30 dias.
O resumo retornado pode conter o seguinte: Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime e Count dos trabalhos incluídos.
## Conteúdo
** AccountId **
O ID da conta à qual os trabalhos no resumo pertencem.
Tipo: sequência
Padrão: : `^[0-9]{12}$`
Obrigatório: Não
** Count **
O valor como um número de trabalhos em um resumo do trabalhos.
Tipo: inteiro
Obrigatório: Não
** EndTime **
O valor do horário de término de um trabalho em formato numérico.
Esse valor é o horário no formato Unix, Tempo Universal Coordenado (UTC), e com precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: Timestamp
Obrigatório: Não
** MessageCategory **
Esse parâmetro é a contagem de trabalhos para a categoria de mensagem especificada.
Exemplos de strings incluem `AccessDenied`, `Success` e `InvalidParameters`. Consulte [Monitoring](https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html) para conferir uma lista de strings de MessageCategory.
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.
Tipo: String
Obrigatório: Não
** Region **
As regiões da AWS no resumo de trabalhos.
Tipo: String
Obrigatório: Não
** ResourceType **
Esse valor é a contagem de trabalhos para o tipo de recurso especificado. A solicitação `GetSupportedResourceTypes` retorna strings para os tipos de recurso compatíveis.
Tipo: sequência
Padrão: : `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Não
** StartTime **
O valor do horário de início de um trabalho em formato numérico.
Esse valor é o horário no formato Unix, Tempo Universal Coordenado (UTC), e com precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: Timestamp
Obrigatório: Não
** State **
Esse valor é a contagem dos trabalhos com o estado especificado.
Tipo: String
Valores Válidos: `CREATED | RUNNING | ABORTING | ABORTED | COMPLETING | COMPLETED | FAILING | FAILED | PARTIAL | AGGREGATE_ALL | ANY`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CopyJobSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CopyJobSummary)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CopyJobSummary)
# DateRange
Isso é um filtro de recursos contendo fromDate: DateTime e toDate: DateTime. Ambos os valores são necessários. Valores futuros de DateTime não são permitidos.
A data e a hora estão no formato Unix e no Tempo Universal Coordenado (UTC) e têm precisão de milissegundos (os milissegundos são opcionais). Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
## Conteúdo
** FromDate **
Esse valor é a data de início, inclusive.
A data e a hora estão no formato Unix e Tempo Universal Coordenado (UTC) e têm precisão de milissegundos (milissegundos são opcionais).
Tipo: Timestamp
Obrigatório: Sim
** ToDate **
Esse valor é a data de término, inclusive.
A data e a hora estão no formato Unix e Tempo Universal Coordenado (UTC) e têm precisão de milissegundos (milissegundos são opcionais).
Tipo: Timestamp
Obrigatório: Sim
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/DateRange)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/DateRange)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/DateRange)
# Framework
Contém informações detalhadas sobre uma framework. As frameworks contêm controles que avaliam e relatam seus eventos e recursos de backup. As frameworks geram resultados diários de conformidade.
## Conteúdo
** CreationTime **
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
Obrigatório: Não
** DeploymentStatus **
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
Obrigatório: Não
** FrameworkArn **
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: Não
** FrameworkDescription **
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 **
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]*`
Obrigatório: Não
** NumberOfControls **
O número de controles contidos na framework.
Tipo: inteiro
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Framework)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Framework)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Framework)
# FrameworkControl
Contém informações detalhadas sobre todos os controles de um framework. Cada framework deve conter pelo menos um controle.
## Conteúdo
** ControlName **
O nome de um controle. Esse nome tem entre 1 e 256 caracteres.
Tipo: string
Obrigatório: Sim
** ControlInputParameters **
Pares de nome/valor.
Tipo: matriz de objetos [ControlInputParameter](API_ControlInputParameter.md)
Obrigatório: Não
** ControlScope **
O escopo de um controle. O escopo do controle define o que o controle avaliará. Três exemplos de escopos de controle são: um plano de backup específico, todos os planos de backup com uma tag específica ou todos os planos de backup.
Para obter mais informações, consulte [`ControlScope`.](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html)
Tipo: objeto [ControlScope](API_ControlScope.md)
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/FrameworkControl)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/FrameworkControl)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/FrameworkControl)
# IndexAction
Essa é uma matriz opcional em um BackupRule.
IndexAction consiste em um ResourceTypes.
## Conteúdo
** ResourceTypes **
A ação de índice 0 ou 1 é aceita para cada BackupRule.
Valores válidos:
+ `EBS` para Amazon Elastic Block Store
+ `S3` para Amazon Simple Storage Service (Amazon S3)
Tipo: matriz de strings
Padrão: : `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/IndexAction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/IndexAction)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/IndexAction)
# IndexedRecoveryPoint
Esse é um ponto de recuperação que tem um índice de backup associado.
Somente pontos de recuperação com um índice de backup podem ser incluídos em uma pesquisa.
## Conteúdo
** BackupCreationDate **
A data e hora em que um 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
Obrigatório: Não
** BackupVaultArn **
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
Obrigatório: Não
** IamRoleArn **
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
** IndexCreationDate **
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
Obrigatório: Não
** IndexStatus **
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`
Obrigatório: Não
** IndexStatusMessage **
Uma string na forma de uma mensagem detalhada explicando o status de um índice de backup associado ao ponto de recuperação.
Tipo: String
Obrigatório: Não
** RecoveryPointArn **
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: Não
** ResourceType **
O tipo de recurso do ponto de recuperação indexado.
+ `EBS` para Amazon Elastic Block Store
+ `S3` para Amazon Simple Storage Service (Amazon S3)
Tipo: sequência
Padrão: : `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Não
** SourceResourceArn **
Uma string do nome do recurso da Amazon (ARN) que identifica de forma exclusiva um recurso de origem.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/IndexedRecoveryPoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/IndexedRecoveryPoint)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/IndexedRecoveryPoint)
# KeyValue
Par de duas strings relacionadas. Os caracteres permitidos são letras, espaços em branco e números que podem ser representados em UTF-8 e os seguintes caracteres: ` + - = . _ : /`.
## Conteúdo
** Key **
A chave da tag (String). A chave não pode começar com `aws:`.
Restrições de Tamanho: Tamanho mínimo 1. O tamanho máximo é 128.
Padrão: : `^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`
Tipo: string
Obrigatório: Sim
** Value **
O valor da chave.
Restrições de tamanho: o tamanho máximo é 256.
Padrão: : `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
Tipo: string
Obrigatório: Sim
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/KeyValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/KeyValue)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/KeyValue)
# LatestMpaApprovalTeamUpdate
Contém informações sobre a atualização mais recente de uma associação da equipe de aprovação MPA.
## Conteúdo
** ExpiryDate **
A data e a hora em que a atualização da equipe de aprovação MPA expira.
Tipo: Timestamp
Obrigatório: Não
** InitiationDate **
A data e a hora em que a atualização da equipe de aprovação MPA foi iniciada.
Tipo: Timestamp
Obrigatório: Não
** MpaSessionArn **
O ARN da sessão de MPA associada a essa atualização.
Tipo: String
Obrigatório: Não
** Status **
O status atual da atualização da equipe de aprovação MPA.
Tipo: String
Valores Válidos: `PENDING | APPROVED | FAILED`
Obrigatório: Não
** StatusMessage **
Uma mensagem que descreve o status atual da atualização da equipe de aprovação MPA.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/LatestMpaApprovalTeamUpdate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/LatestMpaApprovalTeamUpdate)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/LatestMpaApprovalTeamUpdate)
# LatestRevokeRequest
Contém informações sobre a solicitação mais recente para revogar o acesso a um cofre de backup.
## Conteúdo
** ExpiryDate **
A data e a hora quando a solicitação de revogação expira.
Tipo: Timestamp
Obrigatório: Não
** InitiationDate **
A data e a hora em que a solicitação de revogação foi iniciada.
Tipo: Timestamp
Obrigatório: Não
** MpaSessionArn **
O ARN da sessão de MPA associada a essa solicitação de revogação.
Tipo: String
Obrigatório: Não
** Status **
O status atual da solicitação de revogação.
Tipo: String
Valores Válidos: `PENDING | FAILED`
Obrigatório: Não
** StatusMessage **
Uma mensagem descrevendo o status atual da solicitação de revogação.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/LatestRevokeRequest)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/LatestRevokeRequest)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/LatestRevokeRequest)
# LegalHold
Uma retenção legal é uma ferramenta administrativa que ajuda a evitar que os backups sejam excluídos enquanto estão em retenção. Enquanto a retenção estiver em vigor, não será possível excluir os backups em retenção, e as políticas de ciclo de vida que alterariam o status do backup (como a transição para armazenamento frio) serão adiadas até que a retenção legal seja removida. Um backup pode ter mais de uma retenção legal. As retenções legais são aplicadas a um ou mais backups (também conhecidos como pontos de recuperação). Esses backups podem ser filtrados por tipos de recursos e por IDs de recursos.
## Conteúdo
** CancellationDate **
Hora em formato numérico em que a retenção legal foi cancelada.
Tipo: Timestamp
Obrigatório: Não
** CreationDate **
A hora em que a retenção legal foi criada.
Tipo: Timestamp
Obrigatório: Não
** Description **
A descrição de uma retenção legal.
Tipo: String
Obrigatório: Não
** LegalHoldArn **
O nome do recurso da Amazon (ARN) da retenção legal, por exemplo, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
Tipo: String
Obrigatório: Não
** LegalHoldId **
O ID da retenção legal.
Tipo: String
Obrigatório: Não
** Status **
O status da retenção legal.
Tipo: String
Valores Válidos: `CREATING | ACTIVE | CANCELING | CANCELED`
Obrigatório: Não
** Title **
O título de uma retenção legal.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/LegalHold)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/LegalHold)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/LegalHold)
# Lifecycle
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`.
## Conteúdo
** DeleteAfterDays **
Especifica o número de dias após a criação em que um ponto de recuperação é excluído. Esse valor deve ser de pelo menos 90 dias após o número de dias especificado em `MoveToColdStorageAfterDays`.
Tipo: longo
Obrigatório: não
** DeleteAfterEvent **
O evento após o qual um ponto de recuperação é excluído. Um ponto de recuperação com ambos `DeleteAfterDays` e `DeleteAfterEvent` será excluído após qualquer condição ser satisfeita primeiro. Não é válido como entrada.
Tipo: string
Valores válidos: `DELETE_AFTER_COPY`
Obrigatório: não
** MoveToColdStorageAfterDays **
Especifica o número de dias após a criação em que um ponto de recuperação é movido para armazenamento a frio.
Tipo: longo
Obrigatório: não
** OptInToArchiveForSupportedResources **
Se for verdadeira, essa configuração instruirá o plano de backup a fazer a transição dos recursos compatíveis para o nível de armazenamento de arquivos (frio) de acordo com as suas configurações de ciclo de vida.
Tipo: booliano
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/Lifecycle)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/Lifecycle)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/Lifecycle)
# ProtectedResource
Uma estrutura que contém informações sobre um recurso que teve backup feito.
## Conteúdo
** LastBackupTime **
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
Obrigatório: Não
** LastBackupVaultArn **
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
Obrigatório: Não
** LastRecoveryPointArn **
O ARN (Nome do recurso da Amazon) do ponto de recuperação mais recente.
Tipo: String
Obrigatório: Não
** ResourceArn **
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: Não
** ResourceName **
O nome não exclusivo do recurso que pertence ao backup especificado.
Tipo: String
Obrigatório: Não
** ResourceType **
O tipo de recurso da AWS. Por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS). Para backups do Serviço de Cópias de Sombra de Volume (VSS) do Windows, o único tipo de recurso compatível é o Amazon EC2.
Tipo: sequência
Padrão: : `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ProtectedResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ProtectedResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ProtectedResource)
# ProtectedResourceConditions
As condições que você define para os recursos em um plano de teste de restauração usando tags.
## Conteúdo
** StringEquals **
Filtra os valores dos seus recursos marcados somente para os recursos que você marcou com o mesmo valor. Também chamada de "correspondência exata".
Tipo: matriz de objetos [KeyValue](API_KeyValue.md)
Obrigatório: Não
** StringNotEquals **
Filtra os valores dos recursos marcados somente para os recursos que você marcou que não têm o mesmo valor. Também chamada de "correspondência negada”.
Tipo: matriz de objetos [KeyValue](API_KeyValue.md)
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ProtectedResourceConditions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ProtectedResourceConditions)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ProtectedResourceConditions)
# RecoveryPointByBackupVault
Contém informações detalhadas sobre os pontos de recuperação armazenados em um cofre de backup.
## Conteúdo
** AggregatedScanResult **
Contém os resultados mais recentes da verificação em relação ao ponto de recuperação e atualmente inclui`FailedScan`,`Findings`,`LastComputed`.
Tipo: objeto [AggregatedScanResult](API_AggregatedScanResult.md)
Obrigatório: não
** BackupSizeInBytes **
O tamanho de um backup, em bytes.
Tipo: longo
Obrigatório: não
** BackupVaultArn **
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
Obrigatório: não
** BackupVaultName **
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`
Obrigatório: não
** CalculatedLifecycle **
Um objeto `CalculatedLifecycle` que contém os timestamps `DeleteAt` e `MoveToColdStorageAt`.
Tipo: objeto [CalculatedLifecycle](API_CalculatedLifecycle.md)
Obrigatório: não
** CompletionDate **
A data e 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
Obrigatório: não
** CompositeMemberIdentifier **
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
Obrigatório: não
** CreatedBy **
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)
Obrigatório: não
** CreationDate **
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
Obrigatório: não
** EncryptionKeyArn **
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
** EncryptionKeyType **
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`
Obrigatório: não
** IamRoleArn **
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: não
** IndexStatus **
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`
Obrigatório: não
** IndexStatusMessage **
Uma string na forma de uma mensagem detalhada explicando o status de um índice de backup associado ao ponto de recuperação.
Tipo: string
Obrigatório: não
** InitiationDate **
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
Obrigatório: não
** IsEncrypted **
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
Obrigatório: não
** IsParent **
Isso é um valor booliano que indica que se trata de um ponto de recuperação pai (composto).
Tipo: booliano
Obrigatório: não
** LastRestoreTime **
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
Obrigatório: não
** Lifecycle **
O ciclo de vida define quando um recurso protegido é transferido para o armazenamento refrigerado e quando ele expira. AWS Backup 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)
Obrigatório: não
** ParentRecoveryPointArn **
O nome do recurso da Amazon (ARN) do ponto de recuperação pai (composto).
Tipo: string
Obrigatório: não
** RecoveryPointArn **
Um Nome de 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
Obrigatório: não
** ResourceArn **
Um ARN identifica de forma exclusiva um recurso. O formato do ARN depende do tipo de recurso.
Tipo: string
Obrigatório: não
** ResourceName **
O nome não exclusivo do recurso que pertence ao backup especificado.
Tipo: string
Obrigatório: não
** ResourceType **
O tipo de AWS recurso 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). Para backups do Windows Volume Shadow Copy Service (VSS), o único tipo de recurso compatível é o Amazon EC2.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: não
** SourceBackupVaultArn **
O cofre de backup do qual o ponto de recuperação foi copiado originalmente. Se o ponto de recuperação for restaurado na mesma conta, esse valor será `null`.
Tipo: string
Obrigatório: não
** Status **
Um código de status que especifica o estado do ponto de recuperação.
Tipo: string
Valores válidos: `COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING`
Obrigatório: não
** StatusMessage **
Uma mensagem explicando o status do ponto de recuperação.
Tipo: string
Obrigatório: não
** VaultType **
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`
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointByBackupVault)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointByBackupVault)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointByBackupVault)
# RecoveryPointByResource
Contém informações detalhadas sobre um ponto de recuperação salvo.
## Conteúdo
** AggregatedScanResult **
Contém os resultados mais recentes da verificação em relação ao ponto de recuperação e atualmente inclui`FailedScan`,`Findings`,`LastComputed`.
Tipo: objeto [AggregatedScanResult](API_AggregatedScanResult.md)
Obrigatório: não
** BackupSizeBytes **
O tamanho de um backup, em bytes.
Tipo: longo
Obrigatório: não
** BackupVaultName **
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_]{2,50}$`
Obrigatório: não
** CreationDate **
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
Obrigatório: não
** EncryptionKeyArn **
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
** EncryptionKeyType **
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`
Obrigatório: não
** IndexStatus **
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`
Obrigatório: não
** IndexStatusMessage **
Uma string na forma de uma mensagem detalhada explicando o status de um índice de backup associado ao ponto de recuperação.
Tipo: string
Obrigatório: não
** IsParent **
Isso é um valor booliano que indica que se trata de um ponto de recuperação pai (composto).
Tipo: booliano
Obrigatório: não
** ParentRecoveryPointArn **
O nome do recurso da Amazon (ARN) do ponto de recuperação pai (composto).
Tipo: string
Obrigatório: não
** RecoveryPointArn **
Um Nome de 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
Obrigatório: não
** ResourceName **
O nome não exclusivo do recurso que pertence ao backup especificado.
Tipo: string
Obrigatório: não
** Status **
Um código de status que especifica o estado do ponto de recuperação.
Tipo: string
Valores válidos: `COMPLETED | PARTIAL | DELETING | EXPIRED | AVAILABLE | STOPPED | CREATING`
Obrigatório: não
** StatusMessage **
Uma mensagem explicando o status do ponto de recuperação.
Tipo: string
Obrigatório: não
** VaultType **
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`
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointByResource)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointByResource)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointByResource)
# RecoveryPointCreator
Contém informações sobre o plano de backup e a regra que o AWS Backup usou para iniciar o backup do ponto de recuperação.
## Conteúdo
** BackupPlanArn **
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
Obrigatório: Não
** BackupPlanId **
Identifica de forma exclusiva um plano de backup.
Tipo: String
Obrigatório: Não
** BackupPlanName **
O nome do plano de backup que criou esse ponto de recuperação. Isso fornece um contexto legível por humanos sobre qual plano de backup foi responsável pelo trabalho de backup.
Tipo: String
Obrigatório: Não
** BackupPlanVersion **
IDs de versão são strings Unicode exclusivas, geradas aleatoriamente, codificadas em UTF-8 com, no máximo, 1.024 bytes. Eles não podem ser editados.
Tipo: String
Obrigatório: Não
** BackupRuleCron **
A expressão cron que define a programação para a regra de backup. Isso mostra a frequência e o momento em que os backups são acionados automaticamente.
Tipo: String
Obrigatório: Não
** BackupRuleId **
Identifica de forma exclusiva uma regra usada para programar o backup de uma seleção de recursos.
Tipo: String
Obrigatório: Não
** BackupRuleName **
O nome da regra do plano de backup que criou esse ponto de recuperação. Isso ajuda a identificar qual regra específica acionou o trabalho de backup.
Tipo: String
Obrigatório: Não
** BackupRuleTimezone **
O fuso horário usado para a programação da regra de backup. Isso fornece contexto para quando os backups estão programados para execução no fuso horário especificado.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointCreator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointCreator)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointCreator)
# RecoveryPointMember
Isso é um ponto de recuperação que é filho (aninhado) de um ponto de recuperação pai (composto). Esses pontos de recuperação podem ser desassociados do ponto de recuperação pai (composto). Nesse caso, eles não serão mais membros.
## Conteúdo
** BackupVaultName **
O nome do cofre de backup (o contêiner lógico no qual os backups são armazenados).
Tipo: sequência
Padrão: : `^[a-zA-Z0-9\-\_]{2,50}$`
Obrigatório: Não
** RecoveryPointArn **
O nome do recurso da Amazon (ARN) do ponto de recuperação pai (composto).
Tipo: String
Obrigatório: Não
** ResourceArn **
O nome do recurso da Amazon (ARN) que identifica de forma exclusiva um recurso salvo.
Tipo: String
Obrigatório: Não
** ResourceType **
O tipo de recurso da AWS que é salvo como ponto de recuperação.
Tipo: sequência
Padrão: : `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointMember)
# RecoveryPointSelection
Isso especifica os critérios para atribuir um conjunto de recursos, como tipos de recursos ou cofres de backup.
## Conteúdo
** DateRange **
Isso é um filtro de recursos contendo fromDate: DateTime e toDate: DateTime. Ambos os valores são necessários. Valores futuros de DateTime não são permitidos.
A data e a hora estão no formato Unix e no Tempo Universal Coordenado (UTC) e têm precisão de milissegundos (os milissegundos são opcionais). Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: objeto [DateRange](API_DateRange.md)
Obrigatório: Não
** ResourceIdentifiers **
Esses são os recursos incluídos na seleção de recursos (incluindo tipo de recursos e cofres).
Tipo: matriz de strings
Obrigatório: Não
** VaultNames **
Esses são os nomes dos cofres que contêm os pontos de recuperação selecionados.
Tipo: matriz de strings
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RecoveryPointSelection)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RecoveryPointSelection)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RecoveryPointSelection)
# ReportDeliveryChannel
Contém informações do seu plano de relatório sobre onde entregar seus relatórios, especificamente o nome do bucket do Amazon S3, o prefixo de chave do S3 e os formatos dos relatórios.
## Conteúdo
** S3BucketName **
O nome exclusivo do bucket do S3 que recebe os relatórios.
Tipo: string
Obrigatório: Sim
** Formats **
O formato dos relatórios: `CSV`, `JSON` ou ambos. Se não especificado, o formato padrão será `CSV`.
Tipo: matriz de strings
Obrigatório: Não
** S3KeyPrefix **
O prefixo de onde o AWS Backup Audit Manager entrega os relatórios ao Amazon S3. O prefixo é essa parte do seguinte caminho: s3://your-bucket-name/`prefix`/Backup/us-west-2/year/month/day/report-name. Se não for especificado, não haverá prefixo.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportDeliveryChannel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportDeliveryChannel)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportDeliveryChannel)
# ReportDestination
Contém informações do trabalho do relatório sobre o destino do relatório.
## Conteúdo
** S3BucketName **
O nome exclusivo do bucket do Amazon S3 que recebe os relatórios.
Tipo: String
Obrigatório: Não
** S3Keys **
O nome da chave do objeto que identifica de forma exclusiva os relatórios no bucket do S3.
Tipo: matriz de strings
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportDestination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportDestination)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportDestination)
# ReportJob
Contém informações detalhadas sobre um trabalho de relatório. Um trabalho de relatório compila um relatório com base em um plano de relatório e o publica no Amazon S3.
## Conteúdo
** CompletionTime **
A data e hora em que um trabalho de relatório foi concluído, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `CompletionTime` 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
Obrigatório: Não
** CreationTime **
A data e hora em que um trabalho 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
Obrigatório: Não
** ReportDestination **
O nome do bucket do S3 e as chaves do S3 para o destino em que o trabalho de relatório publica o relatório.
Tipo: objeto [ReportDestination](API_ReportDestination.md)
Obrigatório: Não
** ReportJobId **
O identificador de um 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 os IDs de trabalho de relatório.
Tipo: String
Obrigatório: Não
** ReportPlanArn **
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: Não
** ReportTemplate **
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`
Tipo: String
Obrigatório: Não
** Status **
O status de um trabalho de relatório. Os status são:
`CREATED | RUNNING | COMPLETED | FAILED`
`COMPLETED` significa que o relatório está disponível para análise no destino designado. Se o status for `FAILED`, analise a `StatusMessage` para ver o motivo.
Tipo: String
Obrigatório: Não
** StatusMessage **
Uma mensagem explicando o status do trabalho de relatório.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportJob)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportJob)
# ReportPlan
Contém informações detalhadas sobre um trabalho de relatório.
## Conteúdo
** CreationTime **
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
Obrigatório: Não
** DeploymentStatus **
O status de implantação de um plano de relatório. Os status são:
`CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED`
Tipo: String
Obrigatório: Não
** LastAttemptedExecutionTime **
A data e a hora da última tentativa de execução de um trabalho de relatório associado a esse plano de relatório, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `LastAttemptedExecutionTime` 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
Obrigatório: Não
** LastSuccessfulExecutionTime **
A data e a hora da última tentativa de execução de um trabalho de relatório associado a esse plano de relatório, em formato Unix e Tempo Universal Coordenado (UTC). O valor de `LastSuccessfulExecutionTime` 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
Obrigatório: Não
** ReportDeliveryChannel **
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
** ReportPlanArn **
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: Não
** ReportPlanDescription **
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
** ReportPlanName **
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).
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: Não
** ReportSetting **
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`
Se o modelo de relatório for `RESOURCE_COMPLIANCE_REPORT` ou `CONTROL_COMPLIANCE_REPORT`, esse recurso de API também descreverá a cobertura do relatório por Regiões da AWS e as frameworks.
Tipo: objeto [ReportSetting](API_ReportSetting.md)
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportPlan)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportPlan)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportPlan)
# ReportSetting
Contém informações detalhadas sobre uma configuração de relatório.
## Conteúdo
** ReportTemplate **
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`
Tipo: String
Obrigatório: Sim
** Accounts **
Essas são as contas a serem incluídas no relatório.
Use o valor da string de `ROOT` para incluir todas as unidades organizacionais.
Tipo: matriz de strings
Obrigatório: Não
** FrameworkArns **
Os nomes de recursos da Amazon (ARNs) das estruturas que um relatório abrange.
Tipo: matriz de strings
Obrigatório: Não
** NumberOfFrameworks **
O número de frameworks que um relatório abrange.
Tipo: inteiro
Obrigatório: não
** OrganizationUnits **
Estas são as unidades organizacionais a serem incluídas no relatório.
Tipo: matriz de strings
Obrigatório: Não
** Regions **
Essas são as regiões a serem incluídas no relatório.
Use o caractere curinga como valor da string para incluir todas as regiões.
Tipo: matriz de strings
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ReportSetting)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ReportSetting)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ReportSetting)
# ResourceSelection
Ele contém metadados sobre a seleção de recursos para configurações de camadas.
Você pode especificar até 5 seleções de recursos diferentes por configuração de camadas. Os dados movidos para um nível de custo mais baixo permanecem lá até a exclusão (transição unidirecional).
## Conteúdo
** Resources **
Uma matriz de cadeias de caracteres que contém ARNs os recursos associados ou contém um caractere curinga `*` para especificar todos os recursos. Você pode especificar até 100 recursos específicos por configuração de camadas.
Tipo: matriz de strings
Obrigatório: sim
** ResourceType **
O tipo de AWS recurso; por exemplo, `S3` para o Amazon S3. Para configurações de hierarquização, atualmente isso está limitado a. `S3`
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Exigido: Sim
** TieringDownSettingsInDays **
O número de dias após a criação em um cofre de backup em que um objeto pode fazer a transição para o nível de armazenamento aquecido de baixo custo. Deve ser um número inteiro positivo entre 60 e 36500 dias.
Tipo: inteiro
Intervalo válido: valor mínimo de 60. Valor máximo de 36500.
Obrigatório: sim
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ResourceSelection)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ResourceSelection)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ResourceSelection)
# RestoreAccessBackupVaultListMember
Contém informações sobre um cofre de backup de acesso para restauração.
## Conteúdo
** ApprovalDate **
A data e a hora em que o cofre de backup de acesso para restauração foi aprovado.
Tipo: Timestamp
Obrigatório: Não
** CreationDate **
A data e a hora em que o cofre de backup de acesso para restauração foi criado.
Tipo: Timestamp
Obrigatório: Não
** LatestRevokeRequest **
Informações sobre a solicitação mais recente para revogar o acesso a esse cofre de backup.
Tipo: objeto [LatestRevokeRequest](API_LatestRevokeRequest.md)
Obrigatório: Não
** RestoreAccessBackupVaultArn **
O ARN do cofre de backup de acesso para restauração.
Tipo: String
Obrigatório: Não
** VaultState **
O estado atual do cofre de backup de acesso para restauração.
Tipo: String
Valores Válidos: `CREATING | AVAILABLE | FAILED`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreAccessBackupVaultListMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreAccessBackupVaultListMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreAccessBackupVaultListMember)
# RestoreJobCreator
Contém informações sobre o plano de testes de restauração que o AWS Backup utilizou para iniciar o trabalho de restauração.
## Conteúdo
** RestoreTestingPlanArn **
Um nome do recurso da Amazon (ARN) que identifica exclusivamente um plano de testes de restauração.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreJobCreator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreJobCreator)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreJobCreator)
# RestoreJobsListMember
Contém metadados sobre um trabalho de restauração.
## Conteúdo
** AccountId **
O ID da conta proprietária do trabalho de restauração.
Tipo: sequência
Padrão: `^[0-9]{12}$`
Obrigatório: não
** BackupSizeInBytes **
O tamanho, em bytes, do recurso restaurado.
Tipo: longo
Obrigatório: não
** BackupVaultArn **
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
Obrigatório: não
** CompletionDate **
A data e 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
Obrigatório: não
** CreatedBy **
Contém informações de identificação sobre a criação de um trabalho de restauração.
Tipo: objeto [RestoreJobCreator](API_RestoreJobCreator.md)
Obrigatório: não
** CreatedResourceArn **
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: não
** CreationDate **
A data e hora em que um trabalho de restauraçã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
Obrigatório: não
** DeletionStatus **
Isso registra o status dos dados gerados pelo teste de restauração. O status pode ser `Deleting`, `Failed` ou `Successful`.
Tipo: string
Valores válidos: `DELETING | FAILED | SUCCESSFUL`
Obrigatório: não
** DeletionStatusMessage **
Isso descreve o status de exclusão do trabalho de restauração.
Tipo: string
Obrigatório: não
** ExpectedCompletionTimeMinutes **
A quantidade de tempo, em minutos, que se espera que um trabalho de restauração de um ponto de recuperação leve.
Tipo: longo
Obrigatório: não
** IamRoleArn **
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: não
** IsParent **
Esse é um valor booleano que indica se o trabalho de restauração é um trabalho de restauração principal (composto).
Tipo: booliano
Obrigatório: não
** ParentJobId **
Esse é o identificador exclusivo da tarefa de restauração principal da tarefa de restauração selecionada.
Tipo: string
Obrigatório: não
** PercentDone **
Contém uma porcentagem estimada de conclusão de um trabalho no momento em que o status do trabalho foi consultado.
Tipo: string
Obrigatório: não
** RecoveryPointArn **
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: não
** RecoveryPointCreationDate **
A data em que um ponto de recuperação foi criado.
Tipo: Timestamp
Obrigatório: não
** ResourceType **
O tipo de recurso dos trabalhos de restauração listados. Por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS). Para backups do Windows Volume Shadow Copy Service (VSS), o único tipo de recurso compatível é o Amazon EC2.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: não
** RestoreJobId **
Identifica de forma exclusiva a tarefa que restaura um ponto de recuperação.
Tipo: string
Obrigatório: não
** SourceResourceArn **
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
Obrigatório: não
** Status **
Um código de status que especifica o estado do trabalho iniciado AWS Backup para restaurar um ponto de recuperação.
Tipo: string
Valores válidos: `PENDING | RUNNING | COMPLETED | ABORTED | FAILED`
Obrigatório: não
** StatusMessage **
Uma mensagem detalhada explicando o status do trabalho para restaurar um ponto de recuperação.
Tipo: string
Obrigatório: não
** ValidationStatus **
O status da validação executada no trabalho de restauração indicado.
Tipo: string
Valores válidos: `FAILED | SUCCESSFUL | TIMED_OUT | VALIDATING`
Obrigatório: não
** ValidationStatusMessage **
Isso descreve o status da validação executada no trabalho de restauração indicado.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreJobsListMember)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreJobsListMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreJobsListMember)
# RestoreJobSummary
Isso é um resumo dos trabalhos de restauração criados ou em execução nos últimos 30 dias.
O resumo retornado pode conter o seguinte: Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime e Count dos trabalhos incluídos.
## Conteúdo
** AccountId **
O ID da conta à qual os trabalhos no resumo pertencem.
Tipo: sequência
Padrão: : `^[0-9]{12}$`
Obrigatório: Não
** Count **
O valor como um número de trabalhos em um resumo do trabalhos.
Tipo: inteiro
Obrigatório: Não
** EndTime **
O valor do horário de término de um trabalho em formato numérico.
Esse valor é o horário no formato Unix, Tempo Universal Coordenado (UTC), e com precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: Timestamp
Obrigatório: Não
** Region **
As regiões da AWS no resumo de trabalhos.
Tipo: String
Obrigatório: Não
** ResourceType **
Esse valor é a contagem de trabalhos para o tipo de recurso especificado. A solicitação `GetSupportedResourceTypes` retorna strings para os tipos de recurso compatíveis.
Tipo: sequência
Padrão: : `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: Não
** StartTime **
O valor do horário de início de um trabalho em formato numérico.
Esse valor é o horário no formato Unix, Tempo Universal Coordenado (UTC), e com precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: Timestamp
Obrigatório: Não
** State **
Esse valor é a contagem dos trabalhos com o estado especificado.
Tipo: String
Valores Válidos: `CREATED | PENDING | RUNNING | ABORTED | COMPLETED | FAILED | AGGREGATE_ALL | ANY`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreJobSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreJobSummary)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreJobSummary)
# RestoreTestingPlanForCreate
Contém metadados sobre um plano de testes de restauração.
## Conteúdo
** RecoveryPointSelection **
A `RecoveryPointSelection` tem cinco parâmetros (três obrigatórios e dois opcionais). Os valores que você especifica determinam qual ponto de recuperação está incluído no teste de restauração. Você deve indicar com `Algorithm` se deseja o ponto de recuperação mais recente dentro de `SelectionWindowDays` ou se deseja um ponto de recuperação aleatório e deve indicar por meio de `IncludeVaults` quais cofres os pontos de recuperação podem ser escolhidos.
`Algorithm` (*obrigatório*) Valores válidos: "`LATEST_WITHIN_WINDOW`" ou "`RANDOM_WITHIN_WINDOW`”.
`Recovery point types` (*obrigatório*) Valores válidos: "`SNAPSHOT`" e/ou "`CONTINUOUS`”. Inclua `SNAPSHOT` para restaurar somente pontos de recuperação de snapshots; inclua `CONTINUOUS` para restaurar pontos de recuperação contínuos (restauração para um ponto no tempo/PITR); use ambos para restaurar um snapshot ou um ponto de recuperação contínuo. O ponto de recuperação será determinado pelo valor de `Algorithm`.
`IncludeVaults` (*obrigatório*). Você deve incluir um ou mais cofres de backup. Use o caractere curinga ["\$1"] ou ARNs específicos.
`SelectionWindowDays` (*opcional*) O valor deve ser um número inteiro (em dias) de 1 a 365. Se não for incluído, `30` é assumido como padrão.
`ExcludeVaults` (*opcional*). Você pode optar por inserir um ou mais ARNs específicos do cofre de backup para excluir o conteúdo desses cofres da elegibilidade de restauração. Ou você pode incluir uma lista de seletores. Se esse parâmetro e seu valor não forem incluídos, o padrão será uma lista vazia.
Tipo: objeto [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md)
Obrigatório: Sim
** RestoreTestingPlanName **
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: string
Obrigatório: Sim
** ScheduleExpression **
Uma expressão cron no fuso horário especificado quando um plano de testes de restauração é executado. Quando nenhuma expressão CRON é fornecida, o AWS Backup usa a expressão padrão `cron(0 5 ? * * *)`.
Tipo: string
Obrigatório: Sim
** ScheduleExpressionTimezone **
Opcional. O fuso horário no qual a expressão de programação foi definida. Por padrão, ScheduleExpressions estão em UTC. É possível modificar isso para um fuso horário específico.
Tipo: String
Obrigatório: Não
** StartWindowHours **
O padrão é 24 horas.
Quantidade de horas que um teste de restauração tem para ser iniciado após sua programação, antes que o trabalho seja cancelado. Este valor é opcional. Se esse valor for incluído, o parâmetro terá um valor máximo de 168 horas (uma semana).
Tipo: inteiro
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForCreate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForCreate)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingPlanForCreate)
# RestoreTestingPlanForGet
Contém metadados sobre um plano de testes de restauração.
## Conteúdo
** CreationTime **
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
Obrigatório: Sim
** RecoveryPointSelection **
Os critérios especificados para atribuir um conjunto de recursos, como tipos de ponto de recuperação ou cofres de backup.
Tipo: objeto [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md)
Obrigatório: Sim
** RestoreTestingPlanArn **
Um nome do recurso da Amazon (ARN) que identifica de forma exclusiva um plano de testes de restauração.
Tipo: string
Obrigatório: Sim
** RestoreTestingPlanName **
O nome do plano de teste de restauração.
Tipo: string
Obrigatório: Sim
** ScheduleExpression **
Uma expressão cron no fuso horário especificado quando um plano de testes de restauração é executado. Quando nenhuma expressão CRON é fornecida, o AWS Backup usa a expressão padrão `cron(0 5 ? * * *)`.
Tipo: string
Obrigatório: Sim
** CreatorRequestId **
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
** LastExecutionTime **
A última vez que um teste de restauração foi executado com o plano de testes de restauração especificado. 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
Obrigatório: Não
** LastUpdateTime **
A data e hora em que o plano de testes de restauração foi atualizado. 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
Obrigatório: Não
** ScheduleExpressionTimezone **
Opcional. O fuso horário no qual a expressão de programação foi definida. Por padrão, ScheduleExpressions estão em UTC. É possível modificar isso para um fuso horário específico.
Tipo: String
Obrigatório: Não
** StartWindowHours **
O padrão é 24 horas.
Quantidade de horas que um teste de restauração tem para ser iniciado após sua programação, antes que o trabalho seja cancelado. Este valor é opcional. Se esse valor for incluído, o parâmetro terá um valor máximo de 168 horas (uma semana).
Tipo: inteiro
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForGet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForGet)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingPlanForGet)
# RestoreTestingPlanForList
Contém metadados sobre um plano de testes de restauração.
## Conteúdo
** CreationTime **
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
Obrigatório: Sim
** RestoreTestingPlanArn **
Um nome do recurso da Amazon (ARN) que identifica de forma exclusiva um plano de testes de restauração.
Tipo: string
Obrigatório: Sim
** RestoreTestingPlanName **
O nome do plano de teste de restauração.
Tipo: string
Obrigatório: Sim
** ScheduleExpression **
Uma expressão cron no fuso horário especificado quando um plano de testes de restauração é executado. Quando nenhuma expressão CRON é fornecida, o AWS Backup usa a expressão padrão `cron(0 5 ? * * *)`.
Tipo: string
Obrigatório: Sim
** LastExecutionTime **
A última vez que um teste de restauração foi executado com o plano de testes de restauração especificado. 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
Obrigatório: Não
** LastUpdateTime **
A data e hora em que o plano de testes de restauração foi atualizado. 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
Obrigatório: Não
** ScheduleExpressionTimezone **
Opcional. O fuso horário no qual a expressão de programação foi definida. Por padrão, ScheduleExpressions estão em UTC. É possível modificar isso para um fuso horário específico.
Tipo: String
Obrigatório: Não
** StartWindowHours **
O padrão é 24 horas.
Quantidade de horas que um teste de restauração tem para ser iniciado após sua programação, antes que o trabalho seja cancelado. Este valor é opcional. Se esse valor for incluído, o parâmetro terá um valor máximo de 168 horas (uma semana).
Tipo: inteiro
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForList)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForList)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingPlanForList)
# RestoreTestingPlanForUpdate
Contém metadados sobre um plano de testes de restauração.
## Conteúdo
** RecoveryPointSelection **
Obrigatório: `Algorithm`; `RecoveryPointTypes`; `IncludeVaults` (*um ou mais*).
Opcional: *SelectionWindowDays* (*“30” se não for especificado*); `ExcludeVaults` (o padrão será uma lista vazia se não estiver listado).
Tipo: objeto [RestoreTestingRecoveryPointSelection](API_RestoreTestingRecoveryPointSelection.md)
Obrigatório: Não
** ScheduleExpression **
Uma expressão cron no fuso horário especificado quando um plano de testes de restauração é executado. Quando nenhuma expressão CRON é fornecida, o AWS Backup usa a expressão padrão `cron(0 5 ? * * *)`.
Tipo: String
Obrigatório: Não
** ScheduleExpressionTimezone **
Opcional. O fuso horário no qual a expressão de programação foi definida. Por padrão, ScheduleExpressions estão em UTC. É possível modificar isso para um fuso horário específico.
Tipo: String
Obrigatório: Não
** StartWindowHours **
O padrão é 24 horas.
Quantidade de horas que um teste de restauração tem para ser iniciado após sua programação, antes que o trabalho seja cancelado. Este valor é opcional. Se esse valor for incluído, o parâmetro terá um valor máximo de 168 horas (uma semana).
Tipo: inteiro
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingPlanForUpdate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingPlanForUpdate)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingPlanForUpdate)
# RestoreTestingRecoveryPointSelection
A `RecoveryPointSelection` tem cinco parâmetros (três obrigatórios e dois opcionais). Os valores que você especifica determinam qual ponto de recuperação está incluído no teste de restauração. Você deve indicar com `Algorithm` se deseja o ponto de recuperação mais recente dentro de `SelectionWindowDays` ou se deseja um ponto de recuperação aleatório e deve indicar por meio de `IncludeVaults` quais cofres os pontos de recuperação podem ser escolhidos.
`Algorithm` (*obrigatório*) Valores válidos: "`LATEST_WITHIN_WINDOW`" ou "`RANDOM_WITHIN_WINDOW`”.
`Recovery point types` (*obrigatório*) Valores válidos: "`SNAPSHOT`" e/ou "`CONTINUOUS`”. Inclua `SNAPSHOT` para restaurar somente pontos de recuperação de snapshots; inclua `CONTINUOUS` para restaurar pontos de recuperação contínuos (restauração para um ponto no tempo/PITR); use ambos para restaurar um snapshot ou um ponto de recuperação contínuo. O ponto de recuperação será determinado pelo valor de `Algorithm`.
`IncludeVaults` (*obrigatório*). Você deve incluir um ou mais cofres de backup. Use o caractere curinga ["\$1"] ou ARNs específicos.
`SelectionWindowDays` (*opcional*) O valor deve ser um número inteiro (em dias) de 1 a 365. Se não for incluído, `30` é assumido como padrão.
`ExcludeVaults` (*opcional*). Você pode optar por inserir um ou mais ARNs específicos do cofre de backup para excluir o conteúdo desses cofres da elegibilidade de restauração. Ou você pode incluir uma lista de seletores. Se esse parâmetro e seu valor não forem incluídos, o padrão será uma lista vazia.
## Conteúdo
** Algorithm **
Os valores aceitáveis incluem “LATEST\$1WITHIN\$1WINDOW” ou “RANDOM\$1WITHIN\$1WINDOW”.
Tipo: String
Valores Válidos: `LATEST_WITHIN_WINDOW | RANDOM_WITHIN_WINDOW`
Obrigatório: Não
** ExcludeVaults **
Os valores aceitos incluem ARNs específicos ou uma lista de seletores. O padrão será uma lista vazia se não estiver listado.
Tipo: matriz de strings
Obrigatório: Não
** IncludeVaults **
Os valores aceitos incluem o caractere curinga [“\$1”], ARNs específicos ou substituição de caractere curinga de ARN [“arn:aws:backup:us-west-2:123456789012:backup-vault:asdf”, ...] [“arn:aws:backup:\$1:\$1:backup-vault:asdf-\$1”, ...]
Tipo: matriz de strings
Obrigatório: Não
** RecoveryPointTypes **
Esses são os tipos de ponto de recuperação.
Inclua `SNAPSHOT` para restaurar somente pontos de recuperação de snapshots; inclua `CONTINUOUS` para restaurar pontos de recuperação contínuos (restauração para um ponto no tempo/PITR); use ambos para restaurar um snapshot ou um ponto de recuperação contínuo. O ponto de recuperação será determinado pelo valor de `Algorithm`.
Tipo: matriz de strings
Valores Válidos: `CONTINUOUS | SNAPSHOT`
Obrigatório: Não
** SelectionWindowDays **
Os valores aceitos são números inteiros de 1 a 365.
Tipo: inteiro
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingRecoveryPointSelection)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingRecoveryPointSelection)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingRecoveryPointSelection)
# RestoreTestingSelectionForCreate
Contém metadados sobre uma seleção de testes de restauração específica.
ProtectedResourceType é obrigatório, como Amazon EBS ou Amazon EC2.
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`.
Exemplos de `ProtectedResourceConditions` incluem `StringEquals` e `StringNotEquals`.
## Conteúdo
** IamRoleArn **
O nome do recurso da Amazon (ARN) do perfil do IAM que o AWS Backup usa para criar o recurso de destino. Por exemplo: `arn:aws:iam::123456789012:role/S3Access`.
Tipo: String
Obrigatório: Sim
** ProtectedResourceType **
O tipo de AWS recurso incluído em uma seleção de teste de restauração; por exemplo, um volume do Amazon EBS ou um banco de dados do Amazon RDS.
Os tipos de recurso compatíveis e aceitos incluem:
+ `Aurora` para Amazon Aurora
+ `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
+ `FSx`para Amazon FSx
+ `Neptune` para Amazon Neptune
+ `RDS` para Amazon Relational Database Service
+ `S3` para Amazon S3
Tipo: String
Obrigatório: Sim
** RestoreTestingSelectionName **
O nome exclusivo da seleção de teste de restauração que pertence ao plano de teste de restauração relacionado.
Ele só pode conter caracteres alfanuméricos e sublinhados. O tamanho máximo é 50.
Tipo: String
Obrigatório: Sim
** ProtectedResourceArns **
Cada recurso protegido pode ser filtrado por seu recurso específico ARNs, como `ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]` ou por um caractere curinga:`ProtectedResourceArns: ["*"]`, mas não por ambos.
Tipo: matriz de strings
Obrigatório: Não
** ProtectedResourceConditions **
Se você incluiu o caractere curinga em ProtectedResourceArns, você pode incluir condições de recursos, como`ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }]`.
Tipo: objeto [ProtectedResourceConditions](API_ProtectedResourceConditions.md)
Obrigatório: não
** RestoreMetadataOverrides **
Você pode substituir determinadas chaves de metadados de restauração incluindo o parâmetro `RestoreMetadataOverrides` no corpo de `RestoreTestingSelection`. Os valores de chave não diferenciam entrem maiúsculas e minúsculas.
Veja a lista completa de [Metadados inferidos de testes de restauração](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html).
Tipo: mapa de string para string
Obrigatório: não
** ValidationWindowHours **
Essa é a quantidade de horas (0 a 168) disponíveis para executar um script de validação nos dados. Os dados serão excluídos após a conclusão do script de validação ou no final do período de retenção especificado, o que ocorrer primeiro.
Tipo: inteiro
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForCreate)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForCreate)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingSelectionForCreate)
# RestoreTestingSelectionForGet
Contém metadados sobre uma seleção de testes de restauração.
## Conteúdo
** CreationTime **
A data e hora em que uma seleção de testes de restauração foi criada, 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: carimbo de data/hora
Obrigatório: sim
** IamRoleArn **
O nome do recurso da Amazon (ARN) do perfil do IAM que o AWS Backup usa para criar o recurso de destino. Por exemplo: `arn:aws:iam::123456789012:role/S3Access`.
Tipo: String
Obrigatório: Sim
** ProtectedResourceType **
O tipo de AWS recurso incluído em uma seleção de teste de recursos; por exemplo, um volume do Amazon EBS ou um banco de dados do Amazon RDS.
Tipo: String
Obrigatório: Sim
** RestoreTestingPlanName **
RestoreTestingPlanName É uma string exclusiva que é o nome do plano de teste de restauração.
Tipo: String
Obrigatório: Sim
** RestoreTestingSelectionName **
O nome exclusivo da seleção de teste de restauração que pertence ao plano de teste de restauração relacionado.
Ele só pode conter caracteres alfanuméricos e sublinhados. O tamanho máximo é 50.
Tipo: String
Obrigatório: Sim
** CreatorRequestId **
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
** ProtectedResourceArns **
Você pode incluir caracteres específicos ARNs, como `ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]` ou incluir um caractere curinga:`ProtectedResourceArns: ["*"]`, mas não ambos.
Tipo: matriz de strings
Obrigatório: Não
** ProtectedResourceConditions **
Em uma seleção de testes de recursos, esse parâmetro é filtrado por condições específicas, como `StringEquals` ou `StringNotEquals`.
Tipo: objeto [ProtectedResourceConditions](API_ProtectedResourceConditions.md)
Obrigatório: não
** RestoreMetadataOverrides **
Você pode substituir determinadas chaves de metadados de restauração incluindo o parâmetro `RestoreMetadataOverrides` no corpo de `RestoreTestingSelection`. Os valores de chave não diferenciam entrem maiúsculas e minúsculas.
Veja a lista completa de [Metadados inferidos de testes de restauração](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html).
Tipo: mapa de string para string
Obrigatório: não
** ValidationWindowHours **
Essa é a quantidade de horas (de 1 a 168) disponíveis para executar um script de validação nos dados. Os dados serão excluídos após a conclusão do script de validação ou no final do período de retenção especificado, o que ocorrer primeiro.
Tipo: inteiro
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForGet)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForGet)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingSelectionForGet)
# RestoreTestingSelectionForList
Contém metadados sobre uma seleção de testes de restauração.
## Conteúdo
** CreationTime **
A data e hora em que uma seleção de testes de restauração foi criada, 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: carimbo de data/hora
Obrigatório: sim
** IamRoleArn **
O nome do recurso da Amazon (ARN) do perfil do IAM que o AWS Backup usa para criar o recurso de destino. Por exemplo: `arn:aws:iam::123456789012:role/S3Access`.
Tipo: String
Obrigatório: Sim
** ProtectedResourceType **
O tipo de AWS recurso incluído em uma seleção de teste de restauração; por exemplo, um volume do Amazon EBS ou um banco de dados do Amazon RDS.
Tipo: String
Obrigatório: Sim
** RestoreTestingPlanName **
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
Obrigatório: Sim
** RestoreTestingSelectionName **
Nome exclusivo de uma seleção de testes de restauração.
Ele só pode conter caracteres alfanuméricos e sublinhados. O tamanho máximo é 50.
Tipo: String
Obrigatório: Sim
** ValidationWindowHours **
Esse valor representa o tempo, em horas, em que os dados são retidos após um teste de restauração para que a validação opcional possa ser concluída.
O valor aceito é um número inteiro entre 0 e 168 (o equivalente a sete dias).
Tipo: inteiro
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForList)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForList)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingSelectionForList)
# RestoreTestingSelectionForUpdate
Contém metadados sobre uma seleção de testes de restauração.
## Conteúdo
** IamRoleArn **
O nome do recurso da Amazon (ARN) do perfil do IAM que o AWS Backup usa para criar o recurso de destino. Por exemplo: `arn:aws:iam::123456789012:role/S3Access`.
Tipo: String
Obrigatório: Não
** ProtectedResourceArns **
Você pode incluir uma lista de ARNs específicos, como `ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]`, ou pode incluir um caractere curinga (`ProtectedResourceArns: ["*"]`), mas não ambos.
Tipo: matriz de strings
Obrigatório: Não
** ProtectedResourceConditions **
As condições que você define para os recursos em um plano de teste de restauração usando tags.
Tipo: objeto [ProtectedResourceConditions](API_ProtectedResourceConditions.md)
Obrigatório: Não
** RestoreMetadataOverrides **
Você pode substituir determinadas chaves de metadados de restauração incluindo o parâmetro `RestoreMetadataOverrides` no corpo de `RestoreTestingSelection`. Os valores de chave não diferenciam entrem maiúsculas e minúsculas.
Veja a lista completa de [Metadados inferidos de testes de restauração](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html).
Tipo: mapa de string para string
Obrigatório: Não
** ValidationWindowHours **
Esse valor representa o tempo, em horas, em que os dados são retidos após um teste de restauração para que a validação opcional possa ser concluída.
O valor aceito é um número inteiro entre 0 e 168 (o equivalente a sete dias).
Tipo: inteiro
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/RestoreTestingSelectionForUpdate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/RestoreTestingSelectionForUpdate)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/RestoreTestingSelectionForUpdate)
# ScanAction
Define uma ação de varredura que especifica o scanner de malware e o modo de verificação a serem usados.
## Conteúdo
** MalwareScanner **
O verificador de malware a ser usado para a ação de verificação. No momento, somente `GUARDDUTY` é compatível.
Tipo: string
Valores válidos: `GUARDDUTY`
Obrigatório: não
** ScanMode **
O modo de digitalização a ser usado para a ação de digitalização.
Valores válidos: `FULL_SCAN` \$1 `INCREMENTAL_SCAN`.
Tipo: string
Valores válidos: `FULL_SCAN | INCREMENTAL_SCAN`
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanAction)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanAction)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanAction)
# ScanJob
Contém metadados sobre um trabalho de escaneamento, incluindo informações sobre o processo de escaneamento, resultados e recursos associados.
## Conteúdo
** AccountId **
O ID da conta responsável pelo trabalho de digitalização.
Tipo: String
Obrigatório: Sim
** BackupVaultArn **
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
Obrigatório: Sim
** BackupVaultName **
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.
Tipo: String
Obrigatório: Sim
** CreatedBy **
Contém informações de identificação sobre a criação de um trabalho de digitalização.
Tipo: objeto [ScanJobCreator](API_ScanJobCreator.md)
Obrigatório: sim
** CreationDate **
A data e a hora em que um trabalho de varredura é criado, no formato Unix e no Horário 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: carimbo de data/hora
Obrigatório: sim
** IamRoleArn **
Especifica o ARN da função do IAM usado para criar o trabalho de verificação; por exemplo,. `arn:aws:iam::123456789012:role/S3Access`
Tipo: String
Obrigatório: Sim
** MalwareScanner **
O mecanismo de digitalização usado para o trabalho de digitalização. No momento, somente `GUARDDUTY` é compatível.
Tipo: string
Valores válidos: `GUARDDUTY`
Obrigatório: sim
** RecoveryPointArn **
Um ARN que identifica de forma exclusiva o ponto de recuperação que está sendo escaneado; por exemplo,. `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`
Tipo: String
Obrigatório: Sim
** ResourceArn **
Um ARN que identifica de forma exclusiva o recurso de origem do ponto de recuperação que está sendo escaneado.
Tipo: String
Obrigatório: Sim
** ResourceName **
O nome não exclusivo do recurso que pertence ao backup especificado.
Tipo: String
Obrigatório: Sim
** ResourceType **
O tipo de AWS recurso que está sendo escaneado; por exemplo, um volume do Amazon Elastic Block Store (Amazon EBS) ou um banco de dados do Amazon Relational Database Service (Amazon RDS).
Tipo: string
Valores válidos: `EBS | EC2 | S3`
Obrigatório: sim
** ScanJobId **
O identificador exclusivo que identifica a solicitação de trabalho de digitalização para AWS Backup.
Tipo: String
Obrigatório: Sim
** ScanMode **
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 **
Especifica o ARN da função IAM do scanner usado para o trabalho de digitalização.
Tipo: String
Obrigatório: Sim
** CompletionDate **
A data e a hora em que um trabalho de digitalização é concluído, no formato Unix e no Horário 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
Obrigatório: não
** ScanBaseRecoveryPointArn **
Um ARN que identifica de forma exclusiva o ponto de recuperação básico para digitalização. Esse campo é preenchido quando um trabalho de verificação incremental é realizado.
Tipo: string
Obrigatório: não
** ScanId **
O ID de escaneamento gerado pelo verificador de malware para o trabalho de verificação correspondente.
Tipo: string
Obrigatório: não
** ScanResult **
Contém as informações dos resultados do escaneamento, incluindo o status das ameaças encontradas durante o escaneamento.
Tipo: objeto [ScanResultInfo](API_ScanResultInfo.md)
Obrigatório: não
** State **
O estado atual do trabalho de digitalização.
Valores válidos: `CREATED` \$1 `RUNNING` \$1 `COMPLETED` \$1 `COMPLETED_WITH_ISSUES` \$1 `FAILED` \$1`CANCELED`.
Tipo: string
Valores válidos: `CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING`
Obrigatório: não
** StatusMessage **
Uma mensagem detalhada explicando o status do trabalho de digitalização.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanJob)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanJob)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanJob)
# ScanJobCreator
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.
## Conteúdo
** BackupPlanArn **
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
Obrigatório: Sim
** BackupPlanId **
O ID do plano de backup.
Tipo: String
Obrigatório: Sim
** BackupPlanVersion **
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
Obrigatório: Sim
** BackupRuleId **
Identifica de forma exclusiva a regra de backup que iniciou o trabalho de verificação.
Tipo: String
Obrigatório: Sim
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanJobCreator)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanJobCreator)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanJobCreator)
# ScanJobSummary
Contém informações resumidas sobre trabalhos de escaneamento, incluindo contagens e metadados de um período e critérios específicos.
## Conteúdo
** AccountId **
O ID da conta que possui os trabalhos de digitalização incluídos neste resumo.
Tipo: sequência
Padrão: `^[0-9]{12}$`
Obrigatório: não
** Count **
O número de trabalhos de digitalização que correspondem aos critérios especificados.
Tipo: inteiro
Obrigatório: não
** EndTime **
O valor do horário de término de um trabalho em formato numérico.
Esse valor é o horário no formato Unix, Tempo Universal Coordenado (UTC), e com precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: Timestamp
Obrigatório: não
** MalwareScanner **
Especifica o verificador de malware usado durante o trabalho de verificação. Atualmente, só suporta`GUARDDUTY`.
Tipo: string
Valores válidos: `GUARDDUTY`
Obrigatório: não
** Region **
A AWS região em que os trabalhos de digitalização foram executados.
Tipo: string
Obrigatório: não
** ResourceType **
O tipo de AWS recurso para os trabalhos de digitalização incluídos neste resumo.
Tipo: sequência
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: não
** ScanResultStatus **
O status do resultado do escaneamento para os trabalhos de escaneamento incluídos neste resumo.
Valores válidos: `THREATS_FOUND` \$1 `NO_THREATS_FOUND`.
Tipo: string
Valores válidos: `NO_THREATS_FOUND | THREATS_FOUND`
Obrigatório: não
** StartTime **
O valor do horário de início de um trabalho em formato numérico.
Esse valor é o horário no formato Unix, Tempo Universal Coordenado (UTC), e com precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.
Tipo: Timestamp
Obrigatório: não
** State **
O estado dos trabalhos de digitalização incluídos neste resumo.
Valores válidos: `CREATED` \$1 `RUNNING` \$1 `COMPLETED` \$1 `COMPLETED_WITH_ISSUES` \$1 `FAILED` \$1`CANCELED`.
Tipo: string
Valores válidos: `CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY`
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanJobSummary)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanJobSummary)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanJobSummary)
# ScanResult
Contém os resultados de uma verificação de segurança, incluindo informações do scanner, estado do escaneamento e quaisquer descobertas descobertas.
## Conteúdo
** Findings **
Uma série de descobertas descobertas durante a varredura.
Tipo: matriz de strings
Valores válidos: `MALWARE`
Obrigatório: não
** LastScanTimestamp **
O registro de data e hora de quando a última varredura foi realizada, no formato Unix e no Tempo Universal Coordenado (UTC).
Tipo: Timestamp
Obrigatório: não
** MalwareScanner **
O verificador de malware usado para realizar o escaneamento. No momento, somente `GUARDDUTY` é compatível.
Tipo: string
Valores válidos: `GUARDDUTY`
Obrigatório: não
** ScanJobState **
O estado final do trabalho de digitalização.
Valores válidos: `COMPLETED` \$1 `FAILED` \$1 `CANCELED`.
Tipo: string
Valores válidos: `COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED`
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanResult)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanResult)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanResult)
# ScanResultInfo
Contém informações sobre os resultados de um trabalho de digitalização.
## Conteúdo
** ScanResultStatus **
O status dos resultados do escaneamento.
Valores válidos: `THREATS_FOUND` \$1 `NO_THREATS_FOUND`.
Tipo: string
Valores válidos: `NO_THREATS_FOUND | THREATS_FOUND`
Exigido: Sim
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanResultInfo)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanResultInfo)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanResultInfo)
# ScanSetting
Contém configurações para a verificação de malware, incluindo o tipo de scanner, os tipos de recursos de destino e a função do scanner.
## Conteúdo
** MalwareScanner **
O scanner de malware a ser usado para escanear. No momento, somente `GUARDDUTY` é compatível.
Tipo: string
Valores válidos: `GUARDDUTY`
Obrigatório: não
** ResourceTypes **
Uma variedade de tipos de recursos a serem verificados em busca de malware.
Tipo: matriz de strings
Padrão: `^[a-zA-Z0-9\-\_\.]{1,50}$`
Obrigatório: não
** ScannerRoleArn **
O Amazon Resource Name (ARN) da função do IAM que o scanner usa para acessar recursos; por exemplo,. `arn:aws:iam::123456789012:role/ScannerRole`
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScanSetting)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScanSetting)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScanSetting)
# ScheduledPlanExecutionMember
Contém informações sobre a execução programada de um plano de backup, incluindo o tempo de execução, o tipo de regra e o identificador de regra associado.
## Conteúdo
** ExecutionTime **
O registro de data e hora em que o plano de execução do backup foi programado, em formato Unix e Tempo Universal Coordenado (UTC). O valor tem precisão de milissegundos.
Tipo: Timestamp
Obrigatório: Não
** RuleExecutionType **
O tipo de execução da regra de backup. Os valores válidos são `CONTINUOUS` (recuperação para um ponto no tempo), `SNAPSHOTS` (backups de snapshot) ou `CONTINUOUS_AND_SNAPSHOTS` (ambos os tipos combinados).
Tipo: String
Valores Válidos: `CONTINUOUS | SNAPSHOTS | CONTINUOUS_AND_SNAPSHOTS`
Obrigatório: Não
** RuleId **
O identificador exclusivo da regra de backup que será executada no horário programado.
Tipo: String
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/ScheduledPlanExecutionMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/ScheduledPlanExecutionMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/ScheduledPlanExecutionMember)
# TieringConfiguration
Ele contém metadados sobre uma configuração hierárquica.
## Conteúdo
** BackupVaultName **
O nome do cofre de backup ao qual a configuração hierárquica se aplica. Use `*` para aplicar em todos os cofres de backup.
Tipo: sequência
Padrão: `^(\*|[a-zA-Z0-9\-\_]{2,50})$`
Exigido: Sim
** ResourceSelection **
Uma matriz de objetos de seleção de recursos que especificam quais recursos estão incluídos na configuração de camadas e suas configurações de classificação por níveis.
Tipo: matriz de objetos [ResourceSelection](API_ResourceSelection.md)
Obrigatório: sim
** TieringConfigurationName **
O nome exclusivo 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: sequência
Padrão: `^[a-zA-Z0-9_]{1,200}$`
Exigido: Sim
** CreationTime **
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
Obrigatório: não
** CreatorRequestId **
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.
Tipo: string
Obrigatório: não
** LastUpdatedTime **
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
Obrigatório: não
** TieringConfigurationArn **
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva a configuração de camadas.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfiguration)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfiguration)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TieringConfiguration)
# TieringConfigurationInputForCreate
Ele contém metadados sobre uma configuração hierárquica para operações de criação.
## Conteúdo
** BackupVaultName **
O nome do cofre de backup ao qual a configuração de camadas se aplica. Use `*` para aplicar em todos os cofres de backup.
Tipo: sequência
Padrão: `^(\*|[a-zA-Z0-9\-\_]{2,50})$`
Exigido: Sim
** ResourceSelection **
Uma matriz de objetos de seleção de recursos que especificam quais recursos estão incluídos na configuração de camadas e suas configurações de classificação por níveis.
Tipo: matriz de objetos [ResourceSelection](API_ResourceSelection.md)
Obrigatório: sim
** TieringConfigurationName **
O nome exclusivo 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: sequência
Padrão: `^[a-zA-Z0-9_]{1,200}$`
Exigido: Sim
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfigurationInputForCreate)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfigurationInputForCreate)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TieringConfigurationInputForCreate)
# TieringConfigurationInputForUpdate
Ele contém metadados sobre uma configuração hierárquica para operações de atualização.
## Conteúdo
** BackupVaultName **
O nome do cofre de backup ao qual a configuração de camadas se aplica. Use `*` para aplicar em todos os cofres de backup.
Tipo: sequência
Padrão: `^(\*|[a-zA-Z0-9\-\_]{2,50})$`
Exigido: Sim
** ResourceSelection **
Uma matriz de objetos de seleção de recursos que especificam quais recursos estão incluídos na configuração de camadas e suas configurações de classificação por níveis.
Tipo: matriz de objetos [ResourceSelection](API_ResourceSelection.md)
Obrigatório: sim
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfigurationInputForUpdate)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfigurationInputForUpdate)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TieringConfigurationInputForUpdate)
# TieringConfigurationsListMember
Ele contém metadados sobre uma configuração hierárquica retornada em uma lista.
## Conteúdo
** BackupVaultName **
O nome do cofre de backup ao qual a configuração hierárquica se aplica. Use `*` para aplicar em todos os cofres de backup.
Tipo: sequência
Padrão: `^(\*|[a-zA-Z0-9\-\_]{2,50})$`
Obrigatório: não
** CreationTime **
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
Obrigatório: não
** LastUpdatedTime **
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
Obrigatório: não
** TieringConfigurationArn **
Um nome de recurso da Amazon (ARN) que identifica de forma exclusiva a configuração de camadas.
Tipo: string
Obrigatório: não
** TieringConfigurationName **
O nome exclusivo da configuração de camadas.
Tipo: sequência
Padrão: `^[a-zA-Z0-9_]{1,200}$`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/TieringConfigurationsListMember)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/TieringConfigurationsListMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/TieringConfigurationsListMember)
# AWS Backup gateway
Os seguintes tipos de dados são compatíveis com o AWS Backup gateway:
+ [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md)
+ [Gateway](API_BGW_Gateway.md)
+ [GatewayDetails](API_BGW_GatewayDetails.md)
+ [Hypervisor](API_BGW_Hypervisor.md)
+ [HypervisorDetails](API_BGW_HypervisorDetails.md)
+ [MaintenanceStartTime](API_BGW_MaintenanceStartTime.md)
+ [Tag](API_BGW_Tag.md)
+ [VirtualMachine](API_BGW_VirtualMachine.md)
+ [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md)
+ [VmwareTag](API_BGW_VmwareTag.md)
+ [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md)
# BandwidthRateLimitInterval
Descreve um intervalo limite de taxa de largura de banda para um gateway. Uma programação de limite de taxa de largura de banda consiste em um ou mais intervalos de limite de taxa de largura de banda. Um intervalo de limite de taxa de largura de banda define um período de tempo em um ou mais dias da semana, durante o qual os limites de taxa de largura de banda são especificados para upload.
## Conteúdo
** DaysOfWeek **
O componente de dias da semana do intervalo limite da taxa de largura de banda, representado como números ordinais de 0 a 6, em que 0 representa domingo e 6 representa sábado.
Tipo: matriz de números inteiros
Membros da matriz: número mínimo de 1 item. Número máximo de 7 itens.
Intervalo válido: valor mínimo de 0. Valor máximo de 6.
Obrigatório: Sim
** EndHourOfDay **
A hora do dia para encerrar o intervalo do limite da taxa de largura de banda.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 23.
Obrigatório: Sim
** EndMinuteOfHour **
O minuto da hora para encerrar o intervalo do limite da taxa de largura de banda.
O intervalo do limite da taxa de largura de banda termina no final do minuto. Para encerrar um intervalo ao final de uma hora, use o valor `59`.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 59.
Obrigatório: Sim
** StartHourOfDay **
A hora do dia para iniciar o intervalo do limite da taxa de largura de banda.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 23.
Obrigatório: Sim
** StartMinuteOfHour **
O minuto da hora para iniciar o intervalo do limite da taxa de largura de banda. O intervalo inicia no início desse minuto. Para iniciar um intervalo exatamente no início da hora, use o valor `0`.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 59.
Obrigatório: Sim
** AverageUploadRateLimitInBitsPerSec **
O componente do limite médio da taxa de upload do intervalo limite da taxa de largura de banda, em bits por segundo. Esse campo não será exibido na resposta se o limite da taxa de upload não estiver definido.
Tipo: longo
Intervalo válido: valor mínimo de 51.200. Valor máximo de 8.000.000.000.000.
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/BandwidthRateLimitInterval)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/BandwidthRateLimitInterval)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/BandwidthRateLimitInterval)
# Gateway
Um gateway é um dispositivo do AWS Backup Gateway executado na rede do cliente para fornecer conectividade perfeita ao armazenamento de backups na Nuvem AWS.
## Conteúdo
** GatewayArn **
O Nome do recurso da Amazon (ARN) do gateway. Use a operação `ListGateways` para retornar uma lista de gateways para sua conta e Região da AWS.
Tipo: String
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: : `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Não
** GatewayDisplayName **
O nome de exibição do gateway.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: : `[a-zA-Z0-9-]*`
Obrigatório: Não
** GatewayType **
O tipo do gateway.
Tipo: String
Valores Válidos: `BACKUP_VM`
Obrigatório: Não
** HypervisorId **
O ID do hipervisor do gateway.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Obrigatório: Não
** LastSeenTime **
A última vez que o gateway do AWS Backup se comunicou com o gateway, em formato Unix e horário UTC.
Tipo: Timestamp
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Gateway)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Gateway)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/Gateway)
# GatewayDetails
Os detalhes do gateway.
## Conteúdo
** DeprecationDate **
Data após a qual esse gateway não receberá atualizações de software para novos recursos e correções de erros.
Tipo: Carimbo de data/hora
Obrigatório: não
** GatewayArn **
O Nome do recurso da Amazon (ARN) do gateway. Use a operação `ListGateways` para retornar uma lista de gateways para sua conta e Região da AWS.
Tipo: string
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 180.
Padrão: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: não
** GatewayDisplayName **
O nome de exibição do gateway.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[a-zA-Z0-9-]*`
Obrigatório: não
** GatewayType **
O tipo do tipo de gateway.
Tipo: string
Valores válidos: `BACKUP_VM`
Obrigatório: não
** HypervisorId **
O ID do hipervisor do gateway.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Obrigatório: não
** LastSeenTime **
Detalhes mostrando a última vez que o AWS Backup gateway se comunicou com a nuvem, em formato Unix e horário UTC.
Tipo: Carimbo de data/hora
Obrigatório: não
** MaintenanceStartTime **
Retorna a hora de início da manutenção semanal de gateway incluindo o dia da semana e a hora. Observe que os valores estão em termos do fuso horário do gateway. Pode ser semanal ou mensal.
Tipo: objeto [MaintenanceStartTime](API_BGW_MaintenanceStartTime.md)
Obrigatório: não
** NextUpdateAvailabilityTime **
Detalhes mostrando o horário de disponibilidade da próxima atualização do gateway.
Tipo: Carimbo de data/hora
Obrigatório: não
** SoftwareVersion **
O número da versão do software em execução no dispositivo de gateway.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: `[a-zA-Z0-9-]*`
Obrigatório: não
** VpcEndpoint **
O nome DNS do endpoint da nuvem privada virtual (VPC) que o gateway usa para se conectar à nuvem para o gateway de backup.
Tipo: string
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 255.
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GatewayDetails)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GatewayDetails)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GatewayDetails)
# Hypervisor
Representa as permissões do hipervisor ao qual o gateway se conectará.
Um hipervisor é um hardware, software ou firmware que cria e gerencia máquinas virtuais e aloca recursos para elas.
## Conteúdo
** Host **
O host do servidor do hipervisor. Isso pode ser um endereço IP ou um nome de domínio totalmente qualificado (FQDN).
Tipo: String
Restrições de tamanho: tamanho mínimo de 3. O tamanho máximo é 128.
Padrão: : `.+`
Obrigatório: Não
** HypervisorArn **
O Nome do recurso da Amazon (ARN) do hipervisor.
Tipo: String
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: : `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Não
** KmsKeyArn **
O Nome do recurso da Amazon (ARN) do AWS Key Management Service usado para criptografar o hipervisor.
Tipo: String
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: : `(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`
Obrigatório: Não
** Name **
O nome do hipervisor.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: : `[a-zA-Z0-9-]*`
Obrigatório: Não
** State **
O nome do hipervisor.
Tipo: String
Valores Válidos: `PENDING | ONLINE | OFFLINE | ERROR`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Hypervisor)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Hypervisor)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/Hypervisor)
# HypervisorDetails
Esses são os detalhes do hipervisor especificado. Um hipervisor é um hardware, software ou firmware que cria e gerencia máquinas virtuais e aloca recursos para elas.
## Conteúdo
** Host **
O host do servidor do hipervisor. Isso pode ser um endereço IP ou um nome de domínio totalmente qualificado (FQDN).
Tipo: String
Restrições de tamanho: tamanho mínimo de 3. O tamanho máximo é 128.
Padrão: : `.+`
Obrigatório: Não
** HypervisorArn **
O Nome do recurso da Amazon (ARN) do hipervisor.
Tipo: String
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: : `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Não
** KmsKeyArn **
O Nome do recurso da Amazon (ARN) do AWS KMS usado para criptografar o hipervisor.
Tipo: String
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: : `(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`
Obrigatório: Não
** LastSuccessfulMetadataSyncTime **
Esse é o momento em que ocorreu a sincronização com êxito mais recente dos metadados.
Tipo: Timestamp
Obrigatório: Não
** LatestMetadataSyncStatus **
Esse é o status mais recente da sincronização de metadados indicada.
Tipo: String
Valores Válidos: `CREATED | RUNNING | FAILED | PARTIALLY_FAILED | SUCCEEDED`
Obrigatório: Não
** LatestMetadataSyncStatusMessage **
Esse é o status mais recente da sincronização de metadados indicada.
Tipo: String
Obrigatório: Não
** LogGroupArn **
O Nome do recurso da Amazon (ARN) do grupo de gateways no log solicitado.
Tipo: String
Restrições de tamanho: tamanho mínimo 0. Comprimento máximo de 2.048.
Padrão: : `$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*`
Obrigatório: Não
** Name **
Esse é o nome do hipervisor especificado.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: : `[a-zA-Z0-9-]*`
Obrigatório: Não
** State **
Esse é o estado atual do hipervisor especificado.
Os estados possíveis são `PENDING`, `ONLINE`, `OFFLINE` ou `ERROR`.
Tipo: String
Valores Válidos: `PENDING | ONLINE | OFFLINE | ERROR`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/HypervisorDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/HypervisorDetails)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/HypervisorDetails)
# MaintenanceStartTime
Essa e a hora de início da manutenção semanal de gateway incluindo o dia da semana e a hora. Observe que os valores estão em termos do fuso horário do gateway. Pode ser semanal ou mensal.
## Conteúdo
** HourOfDay **
O componente de hora do horário de início da manutenção representado como *hh*, em que *hh* é a hora (0 a 23). A hora do dia está no fuso horário do gateway.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 23.
Obrigatório: Sim
** MinuteOfHour **
O componente de minuto do horário de início da manutenção representado como *mm*, em que *mm* é o minuto (0 a 59). O minuto da hora está no fuso horário do gateway.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 59.
Obrigatório: Sim
** DayOfMonth **
O componente dia do mês do horário de início da manutenção representado como um número ordinal de 1 a 28, em que 1 representa o primeiro dia do mês e 28 representa o último dia do mês.
Tipo: inteiro
Intervalo válido: valor mínimo de 1. Valor máximo de 31.
Obrigatório: Não
** DayOfWeek **
Um número ordinal entre 0 e 6 que representa o dia da semana, em que 0 representa domingo e 6 representa sábado. O dia da semana está no fuso horário do gateway.
Tipo: inteiro
Intervalo válido: valor mínimo de 0. Valor máximo de 6.
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/MaintenanceStartTime)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/MaintenanceStartTime)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/MaintenanceStartTime)
# Tag
Um par de chave/valor que ajuda você a gerenciar, filtrar e pesquisar seus recursos. Os caracteres permitidos incluem números, letras em UTF-8 e estes caracteres: \$1 - = . \$1 : /. Não são permitidos espaços nos valores das tags.
## Conteúdo
** Key **
A parte da chave do par de chave/valor da tag. A chave não pode começar com `aws:`.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. O tamanho máximo é 128.
Padrão: : `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`
Exigido: Sim
** Value **
A parte do valor do par de chave/valor da tag.
Tipo: String
Restrições de tamanho: o tamanho mínimo é 0. O tamanho máximo é 256.
Padrão: : `[^\x00]*`
Exigido: Sim
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Tag)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Tag)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/Tag)
# VirtualMachine
Uma máquina virtual que está em um hipervisor.
## Conteúdo
** HostName **
O nome do host da máquina virtual.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: : `[a-zA-Z0-9-]*`
Obrigatório: Não
** HypervisorId **
O ID do hipervisor da máquina virtual.
Tipo: String
Obrigatório: Não
** LastBackupDate **
A data mais recente do backup de uma máquina virtual, em formato Unix e horário UTC.
Tipo: Timestamp
Obrigatório: Não
** Name **
O nome da máquina virtual.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: : `[a-zA-Z0-9-]*`
Obrigatório: Não
** Path **
O caminho da máquina virtual.
Tipo: String
Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 4.096.
Padrão: : `[^\x00]+`
Obrigatório: Não
** ResourceArn **
O Nome do recurso da Amazon (ARN) da máquina virtual. Por exemplo, `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.
Tipo: String
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: : `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VirtualMachine)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VirtualMachine)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VirtualMachine)
# VirtualMachineDetails
Seus objetos `VirtualMachine`, ordenados pelos seus Nomes de recurso da Amazon (ARNs).
## Conteúdo
** HostName **
O nome do host da máquina virtual.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: : `[a-zA-Z0-9-]*`
Obrigatório: Não
** HypervisorId **
O ID do hipervisor da máquina virtual.
Tipo: String
Obrigatório: Não
** LastBackupDate **
A data mais recente do backup de uma máquina virtual, em formato Unix e horário UTC.
Tipo: Timestamp
Obrigatório: Não
** Name **
O nome da máquina virtual.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 100.
Padrão: : `[a-zA-Z0-9-]*`
Obrigatório: Não
** Path **
O caminho da máquina virtual.
Tipo: String
Restrições de comprimento: tamanho mínimo de 1. O tamanho máximo é 4.096.
Padrão: : `[^\x00]+`
Obrigatório: Não
** ResourceArn **
O Nome do recurso da Amazon (ARN) da máquina virtual. Por exemplo, `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.
Tipo: String
Restrições de tamanho: tamanho mínimo de 50. Tamanho máximo de 500.
Padrão: : `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`
Obrigatório: Não
** VmwareTags **
Esses são os detalhes das tags da VMware associadas à máquina virtual especificada.
Tipo: matriz de objetos [VmwareTag](API_BGW_VmwareTag.md)
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VirtualMachineDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VirtualMachineDetails)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VirtualMachineDetails)
# VmwareTag
Uma tag da VMware é uma tag anexada a uma máquina virtual específica. Uma [tag](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html) é um par de chave/valor que ajuda você a gerenciar, filtrar e pesquisar seus recursos.
O conteúdo das tags da VMware pode ser combinado com as tags da AWS.
## Conteúdo
** VmwareCategory **
Essa é a categoria da VMware.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 80.
Obrigatório: Não
** VmwareTagDescription **
Esse é o nome definido pelo usuário de uma tag da VMware.
Tipo: String
Obrigatório: Não
** VmwareTagName **
Esse é o nome definido pelo usuário de uma tag da VMware.
Tipo: String
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 80.
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VmwareTag)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VmwareTag)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VmwareTag)
# VmwareToAwsTagMapping
Isso exibe o mapeamento das VMware tags para as AWS tags correspondentes.
## Conteúdo
** AwsTagKey **
A parte principal do par de AWS valores-chave da tag.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O tamanho máximo é 128.
Padrão: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`
Obrigatório: Sim
** AwsTagValue **
A parte do valor do par de AWS valores-chave da tag.
Tipo: string
Restrições de tamanho: o tamanho mínimo é 0. O tamanho máximo é 256.
Padrão: `[^\x00]*`
Obrigatório: Sim
** VmwareCategory **
A é a categoria de VMware.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 80.
Obrigatório: Sim
** VmwareTagName **
Esse é o nome definido pelo usuário de uma VMware tag.
Tipo: string
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 80.
Obrigatório: Sim
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VmwareToAwsTagMapping)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VmwareToAwsTagMapping)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VmwareToAwsTagMapping)
# Pesquisa do AWS Backup
Os seguintes tipos de dados são compatíveis com Pesquisa do AWS Backup:
+ [BackupCreationTimeFilter](API_BKS_BackupCreationTimeFilter.md)
+ [CurrentSearchProgress](API_BKS_CurrentSearchProgress.md)
+ [EBSItemFilter](API_BKS_EBSItemFilter.md)
+ [EBSResultItem](API_BKS_EBSResultItem.md)
+ [ExportJobSummary](API_BKS_ExportJobSummary.md)
+ [ExportSpecification](API_BKS_ExportSpecification.md)
+ [ItemFilters](API_BKS_ItemFilters.md)
+ [LongCondition](API_BKS_LongCondition.md)
+ [ResultItem](API_BKS_ResultItem.md)
+ [S3ExportSpecification](API_BKS_S3ExportSpecification.md)
+ [S3ItemFilter](API_BKS_S3ItemFilter.md)
+ [S3ResultItem](API_BKS_S3ResultItem.md)
+ [SearchJobBackupsResult](API_BKS_SearchJobBackupsResult.md)
+ [SearchJobSummary](API_BKS_SearchJobSummary.md)
+ [SearchScope](API_BKS_SearchScope.md)
+ [SearchScopeSummary](API_BKS_SearchScopeSummary.md)
+ [StringCondition](API_BKS_StringCondition.md)
+ [TimeCondition](API_BKS_TimeCondition.md)
# BackupCreationTimeFilter
Isso filtra por pontos de recuperação dentro dos CreatedBefore carimbos CreatedAfter de data/hora.
## Conteúdo
** CreatedAfter **
Esse carimbo de data e hora inclui pontos de recuperação criados somente depois do horário especificado.
Tipo: Carimbo de data/hora
Obrigatório: não
** CreatedBefore **
Esse carimbo de data e hora inclui pontos de recuperação criados somente antes do horário especificado.
Tipo: Carimbo de data/hora
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/BackupCreationTimeFilter)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/BackupCreationTimeFilter)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/BackupCreationTimeFilter)
# CurrentSearchProgress
Contém resultados de informações recuperados de um trabalho de pesquisa que pode não ter sido concluído.
## Conteúdo
** ItemsMatchedCount **
Esse número é a soma de todos os itens que correspondem aos filtros de itens em um trabalho de pesquisa em andamento.
Tipo: longo
Obrigatório: não
** ItemsScannedCount **
Esse número é a soma de todos os itens que foram verificados até o momento durante um trabalho de pesquisa.
Tipo: longo
Obrigatório: não
** RecoveryPointsScannedCount **
Esse número é a soma de todos os backups que foram verificados até o momento durante um trabalho de pesquisa.
Tipo: inteiro
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/CurrentSearchProgress)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/CurrentSearchProgress)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/CurrentSearchProgress)
# EBSItemFilter
Isso contém matrizes de objetos, que podem incluir objetos de condição de CreationTimes tempo, objetos de sequência de FilePaths caracteres, objetos de condição de LastModificationTimes tempo,
## Conteúdo
** CreationTimes **
Você pode incluir de 1 a 10 valores.
Se apenas um for incluído, os resultados retornarão somente itens que correspondam.
Se mais de um for incluído, os resultados retornarão todos os itens que correspondam a qualquer um dos valores incluídos.
Tipo: matriz de objetos [TimeCondition](API_BKS_TimeCondition.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Obrigatório: não
** FilePaths **
Você pode incluir de 1 a 10 valores.
Se apenas um caminho de arquivo for incluído, os resultados retornarão somente itens que correspondam ao caminho de arquivo.
Se mais de um caminho de arquivo for incluído, os resultados retornarão todos os itens que correspondam a qualquer um dos caminhos de arquivo.
Tipo: matriz de objetos [StringCondition](API_BKS_StringCondition.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Obrigatório: não
** LastModificationTimes **
Você pode incluir de 1 a 10 valores.
Se apenas um for incluído, os resultados retornarão somente itens que correspondam.
Se mais de um for incluído, os resultados retornarão todos os itens que correspondam a qualquer um dos valores incluídos.
Tipo: matriz de objetos [TimeCondition](API_BKS_TimeCondition.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Obrigatório: não
** Sizes **
Você pode incluir de 1 a 10 valores.
Se apenas um for incluído, os resultados retornarão somente itens que correspondam.
Se mais de um for incluído, os resultados retornarão todos os itens que correspondam a qualquer um dos valores incluídos.
Tipo: matriz de objetos [LongCondition](API_BKS_LongCondition.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/EBSItemFilter)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/EBSItemFilter)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/EBSItemFilter)
# EBSResultItem
Esses são os itens retornados nos resultados de uma pesquisa de metadados de backup do Amazon EBS.
## Conteúdo
** BackupResourceArn **
Esses são um ou mais itens nos resultados que correspondem aos valores do nome do recurso da Amazon (ARN) dos pontos de recuperação retornados em uma pesquisa de metadados de backup do Amazon EBS.
Tipo: string
Obrigatório: não
** BackupVaultName **
O nome do cofre de backup.
Tipo: string
Obrigatório: não
** CreationTime **
Esses são um ou mais itens nos resultados que correspondem aos valores de horários de criação retornados em uma pesquisa de metadados de backup do Amazon EBS.
Tipo: Carimbo de data/hora
Obrigatório: não
** FilePath **
Esses são um ou mais itens nos resultados que correspondem aos valores de caminhos de arquivo retornados em uma pesquisa de metadados de backup do Amazon EBS.
Tipo: string
Obrigatório: não
** FileSize **
Esses são um ou mais itens nos resultados que correspondem aos valores de tamanhos de arquivo retornados em uma pesquisa de metadados de backup do Amazon EBS.
Tipo: longo
Obrigatório: não
** FileSystemIdentifier **
Esses são um ou mais itens nos resultados que correspondem aos valores de sistemas de arquivo retornados em uma pesquisa de metadados de backup do Amazon EBS.
Tipo: string
Obrigatório: não
** LastModifiedTime **
Esses são um ou mais itens nos resultados que correspondem aos valores de horário da última modificação retornados em uma pesquisa de metadados de backup do Amazon EBS.
Tipo: Carimbo de data/hora
Obrigatório: não
** SourceResourceArn **
Esses são um ou mais itens nos resultados que correspondem aos valores do nome do recurso da Amazon (ARN) dos recursos de origem retornados em uma pesquisa de metadados de backup do Amazon EBS.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/EBSResultItem)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/EBSResultItem)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/EBSResultItem)
# ExportJobSummary
Esse é o resumo de um trabalho de exportação.
## Conteúdo
** ExportJobIdentifier **
Essa é a string exclusiva que identifica um trabalho de exportação específico.
Tipo: String
Obrigatório: Sim
** CompletionTime **
Esse é um carimbo de data e hora em que o trabalho de exportação foi concluído.
Tipo: Carimbo de data/hora
Obrigatório: não
** CreationTime **
Esse é um carimbo de data e hora em que o trabalho de exportação foi criado.
Tipo: Carimbo de data/hora
Obrigatório: não
** ExportJobArn **
Esse é o ARN (nome do recurso da Amazon) exclusivo que pertence ao novo trabalho de exportação.
Tipo: string
Obrigatório: não
** SearchJobArn **
A string exclusiva que identifica o nome do recurso da Amazon (ARN) do trabalho de pesquisa especificado.
Tipo: string
Obrigatório: não
** Status **
O status do trabalho de exportação é um dos seguintes:
`CREATED`;`RUNNING`;`FAILED`; ou`COMPLETED`.
Tipo: string
Valores válidos: `RUNNING | FAILED | COMPLETED`
Obrigatório: não
** StatusMessage **
Uma mensagem de status é uma string que é retornada para um trabalho de exportação.
Uma mensagem de status é incluída para qualquer status que não seja `COMPLETED` sem problemas.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ExportJobSummary)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ExportJobSummary)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ExportJobSummary)
# ExportSpecification
Contém o objeto de especificação de exportação.
## Conteúdo
**Importante**
Esse tipo de dados é uma UNIÃO, portanto, somente um dos membros a seguir pode ser especificado quando usado ou retornado.
** s3ExportSpecification **
Isso especifica o bucket de destino do Amazon S3 para o trabalho de exportação. E também especifica o prefixo de destino, se incluído.
Tipo: objeto [S3ExportSpecification](API_BKS_S3ExportSpecification.md)
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ExportSpecification)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ExportSpecification)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ExportSpecification)
# ItemFilters
Os filtros de itens representam todas as propriedades do item de entrada especificadas quando a pesquisa foi criada.
Contém EBSItem filtros ou S3 ItemFilters
## Conteúdo
** EBSItemFilters **
Essa matriz pode conter objetos CreationTimes FilePaths, LastModificationTimes, ou Sizes.
Tipo: matriz de objetos [EBSItemFilter](API_BKS_EBSItemFilter.md)
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10 itens.
Obrigatório: não
** S3ItemFilters **
Essa matriz pode conter CreationTimes, ETags, ObjectKeys, Tamanhos ou VersionIds objetos.
Tipo: matriz de objetos [S3ItemFilter](API_BKS_S3ItemFilter.md)
Membros da Matriz: número mínimo de 0 itens. Número máximo de 10 itens.
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ItemFilters)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ItemFilters)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ItemFilters)
# LongCondition
A condição longa contém um `Value` e, opcionalmente, pode conter um `Operator`.
## Conteúdo
** Value **
O valor de um item incluído em um dos filtros do item de pesquisa.
Tipo: longo
Obrigatório: Sim
** Operator **
Uma string que define quais valores serão retornados.
Se isso for incluído, evite combinações de operadores que retornarão todos os valores possíveis. Por exemplo, incluir `EQUALS_TO` e `NOT_EQUALS_TO` com um valor de `4` retorna todos os valores.
Tipo: string
Valores válidos: `EQUALS_TO | NOT_EQUALS_TO | LESS_THAN_EQUAL_TO | GREATER_THAN_EQUAL_TO`
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/LongCondition)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/LongCondition)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/LongCondition)
# ResultItem
Esse é um objeto que representa o item retornado nos resultados de uma pesquisa por um tipo de recurso específico.
## Conteúdo
**Importante**
Esse tipo de dados é uma UNIÃO, portanto, somente um dos membros a seguir pode ser especificado quando usado ou retornado.
** EBSResultItem **
Esses são os itens retornados nos resultados de uma pesquisa do Amazon EBS.
Tipo: objeto [EBSResultItem](API_BKS_EBSResultItem.md)
Obrigatório: não
** S3ResultItem **
Esses são os itens retornados nos resultados de uma pesquisa Amazon S3.
Tipo: objeto [S3ResultItem](API_BKS_S3ResultItem.md)
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/ResultItem)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/ResultItem)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/ResultItem)
# S3ExportSpecification
Essa especificação contém uma string obrigatória do bucket de destino. Se preferir, inclua o prefixo de destino.
## Conteúdo
** DestinationBucket **
Isso especifica o bucket de destino do Amazon S3 para o trabalho de exportação.
Tipo: String
Obrigatório: Sim
** DestinationPrefix **
Isso especifica o prefixo do bucket de destino do Amazon S3 para o trabalho de exportação.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/S3ExportSpecification)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/S3ExportSpecification)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/S3ExportSpecification)
# S3ItemFilter
Isso contém matrizes de objetos, que podem incluir ObjectKeys, Tamanhos,, CreationTimes VersionIds, and/or Etags.
## Conteúdo
** CreationTimes **
Você pode incluir de 1 a 10 valores.
Se apenas um for incluído, os resultados retornarão somente itens que correspondam ao valor.
Se mais de um valor for incluído, os resultados retornarão todos os itens que correspondam a qualquer um dos valores.
Tipo: matriz de objetos [TimeCondition](API_BKS_TimeCondition.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Obrigatório: não
** ETags **
Você pode incluir de 1 a 10 valores.
Se apenas um for incluído, os resultados retornarão somente itens que correspondam ao valor.
Se mais de um valor for incluído, os resultados retornarão todos os itens que correspondam a qualquer um dos valores.
Tipo: matriz de objetos [StringCondition](API_BKS_StringCondition.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Obrigatório: não
** ObjectKeys **
Você pode incluir de 1 a 10 valores.
Se apenas um for incluído, os resultados retornarão somente itens que correspondam ao valor.
Se mais de um valor for incluído, os resultados retornarão todos os itens que correspondam a qualquer um dos valores.
Tipo: matriz de objetos [StringCondition](API_BKS_StringCondition.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Obrigatório: não
** Sizes **
Você pode incluir de 1 a 10 valores.
Se apenas um for incluído, os resultados retornarão somente itens que correspondam ao valor.
Se mais de um valor for incluído, os resultados retornarão todos os itens que correspondam a qualquer um dos valores.
Tipo: matriz de objetos [LongCondition](API_BKS_LongCondition.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Obrigatório: não
** VersionIds **
Você pode incluir de 1 a 10 valores.
Se apenas um for incluído, os resultados retornarão somente itens que correspondam ao valor.
Se mais de um valor for incluído, os resultados retornarão todos os itens que correspondam a qualquer um dos valores.
Tipo: matriz de objetos [StringCondition](API_BKS_StringCondition.md)
Membros da matriz: número mínimo de 1 item. Número máximo de 10 itens.
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/S3ItemFilter)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/S3ItemFilter)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/S3ItemFilter)
# S3ResultItem
Esses são os itens retornados nos resultados de uma pesquisa de metadados de backup do Amazon S3.
## Conteúdo
** BackupResourceArn **
Esses são itens nos resultados retornados que correspondem à entrada do nome do recurso da Amazon (ARN) inserido durante uma pesquisa de metadados de backup do Amazon S3.
Tipo: string
Obrigatório: não
** BackupVaultName **
O nome do cofre de backup.
Tipo: string
Obrigatório: não
** CreationTime **
Esses são um ou mais itens nos resultados retornados que correspondem aos valores da entrada do tempo de criação do item durante uma pesquisa de metadados de backup do Amazon S3.
Tipo: Carimbo de data/hora
Obrigatório: não
** ETag **
Esses são um ou mais itens nos resultados retornados que correspondem aos valores de ETags entrada durante uma pesquisa nos metadados de backup do Amazon S3.
Tipo: string
Obrigatório: não
** ObjectKey **
Esse é um ou mais itens retornados nos resultados de uma pesquisa de metadados de backup do Amazon S3 que correspondem aos valores inseridos para a chave do objeto.
Tipo: string
Obrigatório: não
** ObjectSize **
Esses são itens nos resultados retornados que correspondem aos valores dos tamanhos dos objetos inseridos durante uma pesquisa de metadados de backup do Amazon S3.
Tipo: longo
Obrigatório: não
** SourceResourceArn **
Esses são itens nos resultados retornados que correspondem à entrada do nome do recurso da Amazon (ARN) de origem durante uma pesquisa de metadados de backup do Amazon S3.
Tipo: string
Obrigatório: não
** VersionId **
Esses são um ou mais itens nos resultados retornados que correspondem aos valores da IDs entrada da versão durante uma pesquisa nos metadados de backup do Amazon S3.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma linguagem específica AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/S3ResultItem)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/S3ResultItem)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/S3ResultItem)
# SearchJobBackupsResult
Contém as informações sobre os pontos de recuperação retornados nos resultados de um trabalho de pesquisa.
## Conteúdo
** BackupCreationTime **
Esse é o horário de criação do backup (ponto de recuperação).
Tipo: Carimbo de data/hora
Obrigatório: não
** BackupResourceArn **
O nome do recurso da Amazon (ARN) que identifica de forma exclusiva os recursos de backup.
Tipo: string
Obrigatório: não
** IndexCreationTime **
Esse é o horário de criação do índice de backup.
Tipo: Carimbo de data/hora
Obrigatório: não
** ResourceType **
Esse é o tipo de recurso da pesquisa.
Tipo: string
Valores válidos: `S3 | EBS`
Obrigatório: não
** SourceResourceArn **
O nome do recurso da Amazon (ARN) que identifica de forma exclusiva os recursos de origem.
Tipo: string
Obrigatório: não
** Status **
Esse é o status do resultado do backup do trabalho de pesquisa.
Tipo: string
Valores válidos: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`
Obrigatório: não
** StatusMessage **
Essa é a mensagem de status incluída nos resultados.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchJobBackupsResult)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchJobBackupsResult)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/SearchJobBackupsResult)
# SearchJobSummary
Essas são informações referentes a um trabalho de pesquisa.
## Conteúdo
** CompletionTime **
Esse é o horário de conclusão do trabalho de pesquisa.
Tipo: Carimbo de data/hora
Obrigatório: não
** CreationTime **
Esse é o horário de criação do trabalho de pesquisa.
Tipo: Carimbo de data/hora
Obrigatório: não
** Name **
Esse é o nome do trabalho de pesquisa.
Tipo: string
Obrigatório: não
** SearchJobArn **
A string exclusiva que identifica o nome do recurso da Amazon (ARN) do trabalho de pesquisa especificado.
Tipo: string
Obrigatório: não
** SearchJobIdentifier **
A string exclusiva que especifica o trabalho de pesquisa.
Tipo: string
Obrigatório: não
** SearchScopeSummary **
Resumo retornado do escopo do trabalho de pesquisa especificado, incluindo:
+ TotalBackupsToScanCount, o número de pontos de recuperação retornados pela pesquisa.
+ TotalItemsToScanCount, o número de itens retornados pela pesquisa.
Tipo: objeto [SearchScopeSummary](API_BKS_SearchScopeSummary.md)
Obrigatório: não
** Status **
Esse é o status do trabalho de pesquisa.
Tipo: string
Valores válidos: `RUNNING | COMPLETED | STOPPING | STOPPED | FAILED`
Obrigatório: não
** StatusMessage **
Uma mensagem de status será retornada para um trabalho de pesquisa com um status de `ERRORED` ou um status de trabalhos `COMPLETED` com problemas.
Por exemplo, uma mensagem pode dizer que uma pesquisa continha pontos de recuperação que não puderam ser verificados devido a um problema de permissões.
Tipo: string
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchJobSummary)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchJobSummary)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/SearchJobSummary)
# SearchScope
O escopo da pesquisa consiste em todas as propriedades de backup inseridas em uma pesquisa.
## Conteúdo
** BackupResourceTypes **
Os tipos de recursos incluídos em uma pesquisa.
Os tipos de recursos elegíveis incluem S3 e EBS.
Tipo: matriz de strings
Membros da matriz: número fixo de 1 item.
Valores válidos: `S3 | EBS`
Obrigatório: Sim
** BackupResourceArns **
O nome do recurso da Amazon (ARN) que identifica de forma exclusiva os recursos de backup.
Tipo: matriz de strings
Membros da matriz: número mínimo de 0 itens. Número máximo de 50 itens.
Obrigatório: não
** BackupResourceCreationTime **
Essa é o horário em que um recurso de backup foi criado.
Tipo: objeto [BackupCreationTimeFilter](API_BKS_BackupCreationTimeFilter.md)
Obrigatório: não
** BackupResourceTags **
Essas são uma ou mais tags no backup (ponto de recuperação).
Tipo: mapa de string para string
Obrigatório: não
** SourceResourceArns **
O nome do recurso da Amazon (ARN) que identifica de forma exclusiva os recursos de origem.
Tipo: matriz de strings
Membros da matriz: número mínimo de 0 itens. Número máximo de 50 itens.
Obrigatório: Não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchScope)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchScope)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/SearchScope)
# SearchScopeSummary
O resumo do escopo do trabalho de pesquisa especificado, incluindo:
+ TotalBackupsToScanCount, o número de pontos de recuperação retornados pela pesquisa.
+ TotalItemsToScanCount, o número de itens retornados pela pesquisa.
## Conteúdo
** TotalItemsToScanCount **
Essa é a contagem do número total de itens que serão verificados em uma pesquisa.
Tipo: longo
Obrigatório: não
** TotalRecoveryPointsToScanCount **
Essa é a contagem do número total de backups que serão verificados em uma pesquisa.
Tipo: inteiro
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/SearchScopeSummary)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/SearchScopeSummary)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/SearchScopeSummary)
# StringCondition
Contém o valor da string e pode conter um ou mais operadores.
## Conteúdo
** Value **
O valor da string.
Tipo: String
Obrigatório: Sim
** Operator **
Uma string que define quais valores serão retornados.
Se isso for incluído, evite combinações de operadores que retornarão todos os valores possíveis. Por exemplo, incluir `EQUALS_TO` e `NOT_EQUALS_TO` com um valor de `4` retorna todos os valores.
Tipo: string
Valores válidos: `EQUALS_TO | NOT_EQUALS_TO | CONTAINS | DOES_NOT_CONTAIN | BEGINS_WITH | ENDS_WITH | DOES_NOT_BEGIN_WITH | DOES_NOT_END_WITH`
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/StringCondition)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/StringCondition)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/StringCondition)
# TimeCondition
Uma condição de hora indica a hora de criação, hora da última modificação ou outra hora.
## Conteúdo
** Value **
Esse é o valor do carimbo de data e hora da condição de hora.
Tipo: Timestamp
Obrigatório: Sim
** Operator **
Uma string que define quais valores serão retornados.
Se isso for incluído, evite combinações de operadores que retornarão todos os valores possíveis. Por exemplo, incluir `EQUALS_TO` e `NOT_EQUALS_TO` com um valor de `4` retorna todos os valores.
Tipo: string
Valores válidos: `EQUALS_TO | NOT_EQUALS_TO | LESS_THAN_EQUAL_TO | GREATER_THAN_EQUAL_TO`
Obrigatório: não
## Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backupsearch-2018-05-10/TimeCondition)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backupsearch-2018-05-10/TimeCondition)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backupsearch-2018-05-10/TimeCondition)
# Parâmetros gerais
A lista a seguir contém os parâmetros que todas as ações usam para assinar solicitações do Signature versão 4 com uma string de consulta. Todos os parâmetros específicos de uma ação são listados no tópico para a ação. Para obter mais informações sobre o Signature versão 4, consulte [Solicitações de AWS API de assinatura](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) no *Guia do usuário do IAM*.
**X-Amz-Algorithm**
O algoritmo de hash que foi usado para criar a assinatura da solicitação.
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.
Tipo: string
Valores válidos: `AWS4-HMAC-SHA256`
Obrigatório: condicional
**X-Amz-Credential**
O valor de escopo da credencial, uma string que inclui a sua chave de acesso, a data, a região visada, o serviço que está sendo solicitado e uma sequência de encerramento ("aws4\$1request"). O valor é expresso no seguinte formato: *chave\$1acesso*/*AAAAMMDD*/*região*/*serviço*/aws4\$1request.
Para obter mais informações, consulte [Criar uma solicitação de AWS API assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no *Guia do usuário do IAM*.
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.
Tipo: string
Obrigatório: Condicional
**X-Amz-Date**
A data usada para criar a assinatura. O formato deve ser o formato básico ISO 8601 (AAAAMMDD'T'HHMMSS'Z'). Por exemplo, a data e hora a seguir é um X-Amz-Date valor válido:`20120325T120000Z`.
Condição: X-Amz-Date é opcional para todas as solicitações; ele pode ser usado para substituir a data usada em solicitações de assinatura. Se o cabeçalho da data for especificado no formato básico ISO 8601, não X-Amz-Date é necessário. Quando X-Amz-Date usado, ele sempre substitui o valor do cabeçalho da data. Para obter mais informações, consulte [Elementos de uma assinatura de solicitação de AWS API](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) no *Guia do usuário do IAM*.
Tipo: string
Obrigatório: Condicional
**X-Amz-Security-Token**
O token de segurança temporário obtido por meio de uma chamada para AWS Security Token Service (AWS STS). Para obter uma lista de serviços que oferecem suporte a credenciais de segurança temporárias do AWS STS, consulte [Serviços da AWS que funcionam com o IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) no *Guia do usuário do IAM*.
Condição: se você estiver usando credenciais de segurança temporárias do AWS STS, deverá incluir o token de segurança.
Tipo: string
Obrigatório: Condicional
**X-Amz-Signature**
Especifica a assinatura com codificação hexadecimal que foi calculada com base na string a ser assinada e na chave de assinatura derivada.
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.
Tipo: string
Obrigatório: Condicional
**X-Amz-SignedHeaders**
Especifica todos os cabeçalhos HTTP que foram incluídos como parte da solicitação canônica. Para obter mais informações sobre a especificação de cabeçalhos assinados, consulte [Criar uma solicitação de AWS API assinada](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) no Guia do *usuário do IAM*.
Condição: especifique esse parâmetro quando incluir as informações de autenticação em uma string de consulta em vez de no cabeçalho da autorização HTTP.
Tipo: string
Obrigatório: Condicional
# Tipos de erro comuns
Esta seção lista os tipos de erro comuns que esse AWS serviço pode retornar. Nem todos os serviços retornam todos os tipos de erro listados aqui. Para saber os erros específicos de uma ação de API para esse serviço, consulte o tópico sobre a ação de API em questão.
**AccessDeniedException**
Você não tem permissão para realizar esta ação. Verifique se sua política do IAM inclui as permissões necessárias.
Código de status HTTP: 403
**ExpiredTokenException**
O token de segurança incluído na solicitação expirou. Solicite um novo token de segurança e tente novamente.
Código de status HTTP: 403
**IncompleteSignature**
A assinatura da solicitação não está em conformidade com os AWS padrões. Verifique se você está usando AWS credenciais válidas e se sua solicitação está formatada corretamente. Se você estiver usando um SDK, verifique se ele está atualizado.
Código de status HTTP: 403
**InternalFailure**
A solicitação não pode ser processada no momento devido a um problema interno do servidor. Tente novamente mais tarde. Se o problema persistir, entre em contato com o AWS Support.
Código de status HTTP: 500
**MalformedHttpRequestException**
O corpo da solicitação não pode ser processado. Isso geralmente acontece quando o corpo da solicitação não pode ser descompactado usando o algoritmo de codificação de conteúdo especificado. Verifique se o cabeçalho da codificação do conteúdo corresponde ao formato de compactação usado.
Código de status HTTP: 400
**NotAuthorized**
Você não tem permissões para realizar essa ação. Verifique se sua política do IAM inclui as permissões necessárias.
Código de status HTTP: 401
**OptInRequired**
Sua AWS conta precisa de uma assinatura para esse serviço. Verifique se você ativou o serviço em sua conta.
Código de status HTTP: 403
**RequestAbortedException**
A solicitação foi cancelada antes que uma resposta pudesse ser retornada. Isso normalmente acontece quando o cliente fecha a conexão.
Código de status HTTP: 400
**RequestEntityTooLargeException**
A entidade de solicitação é muito grande. Reduza o tamanho do corpo da solicitação e tente novamente.
Código de status HTTP: 413
**RequestTimeoutException**
O tempo limite da solicitação atingiu o tempo limite. O servidor não recebeu a solicitação completa dentro do prazo esperado. Tente novamente.
Código de status HTTP: 408
**ServiceUnavailable**
O serviço está temporariamente indisponível. Tente novamente mais tarde.
Código de status HTTP: 503
**ThrottlingException**
Sua taxa de solicitação é muito alta. As solicitações de repetição AWS SDKs automática que recebem essa exceção. Reduza a frequência de solicitações.
Código de status HTTP: 400
**UnknownOperationException**
A ação ou operação não é reconhecida. Verifique se o nome da ação está escrito corretamente e se é compatível com a versão da API que você está usando.
Código de status HTTP: 404
**UnrecognizedClientException**
O certificado X.509 ou ID da chave de AWS acesso que você forneceu não existe em nossos registros. Verifique se você está usando credenciais válidas e se elas não expiraram.
Código de status HTTP: 403
**ValidationError**
A entrada não atende ao formato ou às restrições exigidas. Verifique se todos os parâmetros necessários estão incluídos e se os valores são válidos.
Código de status HTTP: 400