

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

# AWS Backup gateway
<a name="API_Operations_AWS_Backup_Gateway"></a>

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
<a name="API_BGW_AssociateGatewayToServer"></a>

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
<a name="API_BGW_AssociateGatewayToServer_RequestSyntax"></a>

```
{
   "GatewayArn": "string",
   "ServerArn": "string"
}
```

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

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) **   <a name="Backup-BGW_AssociateGatewayToServer-request-GatewayArn"></a>
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) **   <a name="Backup-BGW_AssociateGatewayToServer-request-ServerArn"></a>
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
<a name="API_BGW_AssociateGatewayToServer_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_AssociateGatewayToServer_ResponseSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-response-GatewayArn"></a>
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
<a name="API_BGW_AssociateGatewayToServer_Errors"></a>

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
<a name="API_BGW_AssociateGatewayToServer_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_CreateGateway"></a>

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
<a name="API_BGW_CreateGateway_RequestSyntax"></a>

```
{
   "ActivationKey": "string",
   "GatewayDisplayName": "string",
   "GatewayType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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 name="Backup-BGW_CreateGateway-request-ActivationKey"></a>
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) **   <a name="Backup-BGW_CreateGateway-request-GatewayDisplayName"></a>
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) **   <a name="Backup-BGW_CreateGateway-request-GatewayType"></a>
O tipo de gateway criado.  
Tipo: string  
Valores válidos: `BACKUP_VM`   
Obrigatório: Sim

 ** [Tags](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-Tags"></a>
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
<a name="API_BGW_CreateGateway_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_CreateGateway_ResponseSyntax) **   <a name="Backup-BGW_CreateGateway-response-GatewayArn"></a>
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
<a name="API_BGW_CreateGateway_Errors"></a>

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
<a name="API_BGW_CreateGateway_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_DeleteGateway"></a>

Exclui um gateway de backup.

## Sintaxe da solicitação
<a name="API_BGW_DeleteGateway_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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) **   <a name="Backup-BGW_DeleteGateway-request-GatewayArn"></a>
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
<a name="API_BGW_DeleteGateway_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_DeleteGateway_ResponseSyntax) **   <a name="Backup-BGW_DeleteGateway-response-GatewayArn"></a>
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
<a name="API_BGW_DeleteGateway_Errors"></a>

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
<a name="API_BGW_DeleteGateway_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_DeleteHypervisor"></a>

Exclui um hipervisor.

## Sintaxe da solicitação
<a name="API_BGW_DeleteHypervisor_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

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

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) **   <a name="Backup-BGW_DeleteHypervisor-request-HypervisorArn"></a>
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
<a name="API_BGW_DeleteHypervisor_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_DeleteHypervisor_ResponseSyntax) **   <a name="Backup-BGW_DeleteHypervisor-response-HypervisorArn"></a>
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
<a name="API_BGW_DeleteHypervisor_Errors"></a>

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
<a name="API_BGW_DeleteHypervisor_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_DisassociateGatewayFromServer"></a>

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
<a name="API_BGW_DisassociateGatewayFromServer_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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) **   <a name="Backup-BGW_DisassociateGatewayFromServer-request-GatewayArn"></a>
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
<a name="API_BGW_DisassociateGatewayFromServer_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_ResponseSyntax) **   <a name="Backup-BGW_DisassociateGatewayFromServer-response-GatewayArn"></a>
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
<a name="API_BGW_DisassociateGatewayFromServer_Errors"></a>

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
<a name="API_BGW_DisassociateGatewayFromServer_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_GetBandwidthRateLimitSchedule"></a>

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
<a name="API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-request-GatewayArn"></a>
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
<a name="API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax"></a>

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayArn": "string"
}
```

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

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

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

 ** [BandwidthRateLimitIntervals](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-BandwidthRateLimitIntervals"></a>
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) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-GatewayArn"></a>
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
<a name="API_BGW_GetBandwidthRateLimitSchedule_Errors"></a>

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
<a name="API_BGW_GetBandwidthRateLimitSchedule_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_GetGateway"></a>

Ao fornecer o ARN (Nome do recurso da Amazon), essa API retorna o gateway.

## Sintaxe da solicitação
<a name="API_BGW_GetGateway_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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) **   <a name="Backup-BGW_GetGateway-request-GatewayArn"></a>
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
<a name="API_BGW_GetGateway_ResponseSyntax"></a>

```
{
   "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
<a name="API_BGW_GetGateway_ResponseElements"></a>

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

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

 ** [Gateway](#API_BGW_GetGateway_ResponseSyntax) **   <a name="Backup-BGW_GetGateway-response-Gateway"></a>
Ao fornecer o ARN (Nome do recurso da Amazon), essa API retorna o gateway.  
Tipo: objeto [GatewayDetails](API_BGW_GatewayDetails.md)

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

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
<a name="API_BGW_GetGateway_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_GetHypervisor"></a>

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
<a name="API_BGW_GetHypervisor_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

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

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) **   <a name="Backup-BGW_GetHypervisor-request-HypervisorArn"></a>
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
<a name="API_BGW_GetHypervisor_ResponseSyntax"></a>

```
{
   "Hypervisor": { 
      "Host": "string",
      "HypervisorArn": "string",
      "KmsKeyArn": "string",
      "LastSuccessfulMetadataSyncTime": number,
      "LatestMetadataSyncStatus": "string",
      "LatestMetadataSyncStatusMessage": "string",
      "LogGroupArn": "string",
      "Name": "string",
      "State": "string"
   }
}
```

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

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

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

 ** [Hypervisor](#API_BGW_GetHypervisor_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisor-response-Hypervisor"></a>
Detalhes sobre o hipervisor solicitado.  
Tipo: objeto [HypervisorDetails](API_BGW_HypervisorDetails.md)

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

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
<a name="API_BGW_GetHypervisor_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_GetHypervisorPropertyMappings"></a>

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
<a name="API_BGW_GetHypervisorPropertyMappings_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

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

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) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-request-HypervisorArn"></a>
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
<a name="API_BGW_GetHypervisorPropertyMappings_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string",
   "IamRoleArn": "string",
   "VmwareToAwsTagMappings": [ 
      { 
         "AwsTagKey": "string",
         "AwsTagValue": "string",
         "VmwareCategory": "string",
         "VmwareTagName": "string"
      }
   ]
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-HypervisorArn"></a>
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) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-IamRoleArn"></a>
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) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-VmwareToAwsTagMappings"></a>
Essa é uma exibição dos mapeamentos das VMware tags para as AWS tags.  
Tipo: matriz de objetos [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md)

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

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
<a name="API_BGW_GetHypervisorPropertyMappings_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_GetVirtualMachine"></a>

Ao fornecer o ARN (Nome do recurso da Amazon), essa API retorna a máquina virtual.

## Sintaxe da solicitação
<a name="API_BGW_GetVirtualMachine_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

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

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) **   <a name="Backup-BGW_GetVirtualMachine-request-ResourceArn"></a>
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
<a name="API_BGW_GetVirtualMachine_ResponseSyntax"></a>

```
{
   "VirtualMachine": { 
      "HostName": "string",
      "HypervisorId": "string",
      "LastBackupDate": number,
      "Name": "string",
      "Path": "string",
      "ResourceArn": "string",
      "VmwareTags": [ 
         { 
            "VmwareCategory": "string",
            "VmwareTagDescription": "string",
            "VmwareTagName": "string"
         }
      ]
   }
}
```

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

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

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

 ** [VirtualMachine](#API_BGW_GetVirtualMachine_ResponseSyntax) **   <a name="Backup-BGW_GetVirtualMachine-response-VirtualMachine"></a>
Este objeto contém os atributos básicos da `VirtualMachine` contidos na saída da `GetVirtualMachine`   
Tipo: objeto [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md)

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

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
<a name="API_BGW_GetVirtualMachine_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_ImportHypervisorConfiguration"></a>

Conecte-se a um hipervisor importando sua configuração.

## Sintaxe da solicitação
<a name="API_BGW_ImportHypervisorConfiguration_RequestSyntax"></a>

```
{
   "Host": "string",
   "KmsKeyArn": "string",
   "Name": "string",
   "Password": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Username": "string"
}
```

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

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) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Host"></a>
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) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-KmsKeyArn"></a>
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) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Name"></a>
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 name="Backup-BGW_ImportHypervisorConfiguration-request-Password"></a>
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) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Tags"></a>
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) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Username"></a>
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
<a name="API_BGW_ImportHypervisorConfiguration_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_ImportHypervisorConfiguration_ResponseSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-response-HypervisorArn"></a>
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
<a name="API_BGW_ImportHypervisorConfiguration_Errors"></a>

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
<a name="API_BGW_ImportHypervisorConfiguration_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_ListGateways"></a>

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
<a name="API_BGW_ListGateways_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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) **   <a name="Backup-BGW_ListGateways-request-MaxResults"></a>
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) **   <a name="Backup-BGW_ListGateways-request-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `MaxResults` de recursos, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "Gateways": [ 
      { 
         "GatewayArn": "string",
         "GatewayDisplayName": "string",
         "GatewayType": "string",
         "HypervisorId": "string",
         "LastSeenTime": number
      }
   ],
   "NextToken": "string"
}
```

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

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

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

 ** [Gateways](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-Gateways"></a>
Uma lista dos seus gateways.  
Tipo: matriz de objetos [Gateway](API_BGW_Gateway.md)

 ** [NextToken](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `maxResults` de recursos, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.  
Padrão: `.+` 

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

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
<a name="API_BGW_ListGateways_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_ListHypervisors"></a>

Lista seus hipervisores.

## Sintaxe da solicitação
<a name="API_BGW_ListHypervisors_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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) **   <a name="Backup-BGW_ListHypervisors-request-MaxResults"></a>
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) **   <a name="Backup-BGW_ListHypervisors-request-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `maxResults` de recursos, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "Hypervisors": [ 
      { 
         "Host": "string",
         "HypervisorArn": "string",
         "KmsKeyArn": "string",
         "Name": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

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

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

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

 ** [Hypervisors](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-Hypervisors"></a>
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) **   <a name="Backup-BGW_ListHypervisors-response-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `maxResults` de recursos, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.  
Padrão: `.+` 

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

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
<a name="API_BGW_ListHypervisors_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_ListTagsForResource"></a>

Lista as tags aplicadas ao recurso identificado pelo seu Nome do recurso da Amazon (ARN).

## Sintaxe da solicitação
<a name="API_BGW_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

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

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) **   <a name="Backup-BGW_ListTagsForResource-request-ResourceArn"></a>
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
<a name="API_BGW_ListTagsForResource_ResponseSyntax"></a>

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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

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

 ** [ResourceArn](#API_BGW_ListTagsForResource_ResponseSyntax) **   <a name="Backup-BGW_ListTagsForResource-response-ResourceArn"></a>
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) **   <a name="Backup-BGW_ListTagsForResource-response-Tags"></a>
Listar as tags do recurso.  
Tipo: matriz de objetos [Tag](API_BGW_Tag.md)

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

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
<a name="API_BGW_ListTagsForResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_ListVirtualMachines"></a>

Lista suas máquinas virtuais.

## Sintaxe da solicitação
<a name="API_BGW_ListVirtualMachines_RequestSyntax"></a>

```
{
   "HypervisorArn": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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) **   <a name="Backup-BGW_ListVirtualMachines-request-HypervisorArn"></a>
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) **   <a name="Backup-BGW_ListVirtualMachines-request-MaxResults"></a>
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) **   <a name="Backup-BGW_ListVirtualMachines-request-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `maxResults` de recursos, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.  
Padrão: `.+`   
Obrigatório: Não

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

```
{
   "NextToken": "string",
   "VirtualMachines": [ 
      { 
         "HostName": "string",
         "HypervisorId": "string",
         "LastBackupDate": number,
         "Name": "string",
         "Path": "string",
         "ResourceArn": "string"
      }
   ]
}
```

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

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

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

 ** [NextToken](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-NextToken"></a>
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número `maxResults` de recursos, o `NextToken` permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.000.  
Padrão: `.+` 

 ** [VirtualMachines](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-VirtualMachines"></a>
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
<a name="API_BGW_ListVirtualMachines_Errors"></a>

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
<a name="API_BGW_ListVirtualMachines_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_PutBandwidthRateLimitSchedule"></a>

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
<a name="API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax"></a>

```
{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "GatewayArn": "string"
}
```

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

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) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-BandwidthRateLimitIntervals"></a>
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) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-GatewayArn"></a>
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
<a name="API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-response-GatewayArn"></a>
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
<a name="API_BGW_PutBandwidthRateLimitSchedule_Errors"></a>

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
<a name="API_BGW_PutBandwidthRateLimitSchedule_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_PutHypervisorPropertyMappings"></a>

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
<a name="API_BGW_PutHypervisorPropertyMappings_RequestSyntax"></a>

```
{
   "HypervisorArn": "string",
   "IamRoleArn": "string",
   "VmwareToAwsTagMappings": [ 
      { 
         "AwsTagKey": "string",
         "AwsTagValue": "string",
         "VmwareCategory": "string",
         "VmwareTagName": "string"
      }
   ]
}
```

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

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) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-HypervisorArn"></a>
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) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-IamRoleArn"></a>
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) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-VmwareToAwsTagMappings"></a>
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
<a name="API_BGW_PutHypervisorPropertyMappings_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-response-HypervisorArn"></a>
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
<a name="API_BGW_PutHypervisorPropertyMappings_Errors"></a>

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
<a name="API_BGW_PutHypervisorPropertyMappings_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_PutMaintenanceStartTime"></a>

Defina o horário de início da manutenção de um gateway.

## Sintaxe da solicitação
<a name="API_BGW_PutMaintenanceStartTime_RequestSyntax"></a>

```
{
   "DayOfMonth": number,
   "DayOfWeek": number,
   "GatewayArn": "string",
   "HourOfDay": number,
   "MinuteOfHour": number
}
```

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

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) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfMonth"></a>
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) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfWeek"></a>
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) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-GatewayArn"></a>
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 name="Backup-BGW_PutMaintenanceStartTime-request-HourOfDay"></a>
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) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-MinuteOfHour"></a>
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
<a name="API_BGW_PutMaintenanceStartTime_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_PutMaintenanceStartTime_ResponseSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-response-GatewayArn"></a>
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
<a name="API_BGW_PutMaintenanceStartTime_Errors"></a>

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
<a name="API_BGW_PutMaintenanceStartTime_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_StartVirtualMachinesMetadataSync"></a>

Essa ação envia uma solicitação para sincronizar metadados nas máquinas virtuais especificadas.

## Sintaxe da solicitação
<a name="API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

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

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) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-request-HypervisorArn"></a>
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
<a name="API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-response-HypervisorArn"></a>
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
<a name="API_BGW_StartVirtualMachinesMetadataSync_Errors"></a>

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
<a name="API_BGW_StartVirtualMachinesMetadataSync_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_TagResource"></a>

Marca o recurso.

## Sintaxe da solicitação
<a name="API_BGW_TagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

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

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) **   <a name="Backup-BGW_TagResource-request-ResourceARN"></a>
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 name="Backup-BGW_TagResource-request-Tags"></a>
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
<a name="API_BGW_TagResource_ResponseSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

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

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

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

 ** [ResourceARN](#API_BGW_TagResource_ResponseSyntax) **   <a name="Backup-BGW_TagResource-response-ResourceARN"></a>
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
<a name="API_BGW_TagResource_Errors"></a>

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
<a name="API_BGW_TagResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_TestHypervisorConfiguration"></a>

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
<a name="API_BGW_TestHypervisorConfiguration_RequestSyntax"></a>

```
{
   "GatewayArn": "string",
   "Host": "string",
   "Password": "string",
   "Username": "string"
}
```

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

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) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-GatewayArn"></a>
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) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Host"></a>
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 name="Backup-BGW_TestHypervisorConfiguration-request-Password"></a>
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) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Username"></a>
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
<a name="API_BGW_TestHypervisorConfiguration_ResponseElements"></a>

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

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

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
<a name="API_BGW_TestHypervisorConfiguration_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_UntagResource"></a>

Remove tags do recurso.

## Sintaxe da solicitação
<a name="API_BGW_UntagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

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

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) **   <a name="Backup-BGW_UntagResource-request-ResourceARN"></a>
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 name="Backup-BGW_UntagResource-request-TagKeys"></a>
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
<a name="API_BGW_UntagResource_ResponseSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

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

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

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

 ** [ResourceARN](#API_BGW_UntagResource_ResponseSyntax) **   <a name="Backup-BGW_UntagResource-response-ResourceARN"></a>
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
<a name="API_BGW_UntagResource_Errors"></a>

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
<a name="API_BGW_UntagResource_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_UpdateGatewayInformation"></a>

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
<a name="API_BGW_UpdateGatewayInformation_RequestSyntax"></a>

```
{
   "GatewayArn": "string",
   "GatewayDisplayName": "string"
}
```

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

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) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayArn"></a>
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) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayDisplayName"></a>
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
<a name="API_BGW_UpdateGatewayInformation_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_UpdateGatewayInformation_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-response-GatewayArn"></a>
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
<a name="API_BGW_UpdateGatewayInformation_Errors"></a>

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
<a name="API_BGW_UpdateGatewayInformation_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_UpdateGatewaySoftwareNow"></a>

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
<a name="API_BGW_UpdateGatewaySoftwareNow_RequestSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-request-GatewayArn"></a>
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
<a name="API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax"></a>

```
{
   "GatewayArn": "string"
}
```

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

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

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

 ** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-response-GatewayArn"></a>
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
<a name="API_BGW_UpdateGatewaySoftwareNow_Errors"></a>

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
<a name="API_BGW_UpdateGatewaySoftwareNow_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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
<a name="API_BGW_UpdateHypervisor"></a>

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
<a name="API_BGW_UpdateHypervisor_RequestSyntax"></a>

```
{
   "Host": "string",
   "HypervisorArn": "string",
   "LogGroupArn": "string",
   "Name": "string",
   "Password": "string",
   "Username": "string"
}
```

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

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) **   <a name="Backup-BGW_UpdateHypervisor-request-Host"></a>
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) **   <a name="Backup-BGW_UpdateHypervisor-request-HypervisorArn"></a>
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) **   <a name="Backup-BGW_UpdateHypervisor-request-LogGroupArn"></a>
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) **   <a name="Backup-BGW_UpdateHypervisor-request-Name"></a>
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 name="Backup-BGW_UpdateHypervisor-request-Password"></a>
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) **   <a name="Backup-BGW_UpdateHypervisor-request-Username"></a>
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
<a name="API_BGW_UpdateHypervisor_ResponseSyntax"></a>

```
{
   "HypervisorArn": "string"
}
```

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

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

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

 ** [HypervisorArn](#API_BGW_UpdateHypervisor_ResponseSyntax) **   <a name="Backup-BGW_UpdateHypervisor-response-HypervisorArn"></a>
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
<a name="API_BGW_UpdateHypervisor_Errors"></a>

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
<a name="API_BGW_UpdateHypervisor_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/backup-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) 