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

The following actions are supported by 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>

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

## Request Syntax
<a name="API_BGW_AssociateGatewayToServer_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_AssociateGatewayToServer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-request-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway. Use the `ListGateways` operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

 ** [ServerArn](#API_BGW_AssociateGatewayToServer_RequestSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-request-ServerArn"></a>
The Amazon Resource Name (ARN) of the server that hosts your virtual machines.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_AssociateGatewayToServer_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_AssociateGatewayToServer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayArn](#API_BGW_AssociateGatewayToServer_ResponseSyntax) **   <a name="Backup-BGW_AssociateGatewayToServer-response-GatewayArn"></a>
The Amazon Resource Name (ARN) of a gateway.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_AssociateGatewayToServer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The operation cannot proceed because it is not supported.    
 ** ErrorCode **   
A description of why the operation is not supported.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_AssociateGatewayToServer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/AssociateGatewayToServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/AssociateGatewayToServer) 

# CreateGateway
<a name="API_BGW_CreateGateway"></a>

Creates a backup gateway. After you create a gateway, you can associate it with a server using the `AssociateGatewayToServer` operation.

## Request Syntax
<a name="API_BGW_CreateGateway_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_CreateGateway_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ActivationKey](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-ActivationKey"></a>
The activation key of the created gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `[0-9a-zA-Z\-]+`   
Required: Yes

 ** [GatewayDisplayName](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-GatewayDisplayName"></a>
The display name of the created gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: Yes

 ** [GatewayType](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-GatewayType"></a>
The type of created gateway.  
Type: String  
Valid Values: `BACKUP_VM`   
Required: Yes

 ** [Tags](#API_BGW_CreateGateway_RequestSyntax) **   <a name="Backup-BGW_CreateGateway-request-Tags"></a>
A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.  
Type: Array of [Tag](API_BGW_Tag.md) objects  
Required: No

## Response Syntax
<a name="API_BGW_CreateGateway_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_CreateGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayArn](#API_BGW_CreateGateway_ResponseSyntax) **   <a name="Backup-BGW_CreateGateway-response-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway you create.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_CreateGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_CreateGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/CreateGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/CreateGateway) 

# DeleteGateway
<a name="API_BGW_DeleteGateway"></a>

Deletes a backup gateway.

## Request Syntax
<a name="API_BGW_DeleteGateway_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_DeleteGateway_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayArn](#API_BGW_DeleteGateway_RequestSyntax) **   <a name="Backup-BGW_DeleteGateway-request-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway to delete.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_DeleteGateway_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_DeleteGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayArn](#API_BGW_DeleteGateway_ResponseSyntax) **   <a name="Backup-BGW_DeleteGateway-response-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway you deleted.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_DeleteGateway_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_DeleteGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DeleteGateway) 

# DeleteHypervisor
<a name="API_BGW_DeleteHypervisor"></a>

Deletes a hypervisor.

## Request Syntax
<a name="API_BGW_DeleteHypervisor_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_DeleteHypervisor_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HypervisorArn](#API_BGW_DeleteHypervisor_RequestSyntax) **   <a name="Backup-BGW_DeleteHypervisor-request-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor to delete.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_DeleteHypervisor_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_DeleteHypervisor_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HypervisorArn](#API_BGW_DeleteHypervisor_ResponseSyntax) **   <a name="Backup-BGW_DeleteHypervisor-response-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor you deleted.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_DeleteHypervisor_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The operation cannot proceed because you have insufficient permissions.    
 ** ErrorCode **   
A description of why you have insufficient permissions.
HTTP Status Code: 400

 ** ConflictException **   
The operation cannot proceed because it is not supported.    
 ** ErrorCode **   
A description of why the operation is not supported.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_DeleteHypervisor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DeleteHypervisor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DeleteHypervisor) 

# DisassociateGatewayFromServer
<a name="API_BGW_DisassociateGatewayFromServer"></a>

Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

## Request Syntax
<a name="API_BGW_DisassociateGatewayFromServer_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_DisassociateGatewayFromServer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_RequestSyntax) **   <a name="Backup-BGW_DisassociateGatewayFromServer-request-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway to disassociate.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_DisassociateGatewayFromServer_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_DisassociateGatewayFromServer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayArn](#API_BGW_DisassociateGatewayFromServer_ResponseSyntax) **   <a name="Backup-BGW_DisassociateGatewayFromServer-response-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway you disassociated.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_DisassociateGatewayFromServer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The operation cannot proceed because it is not supported.    
 ** ErrorCode **   
A description of why the operation is not supported.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_DisassociateGatewayFromServer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/DisassociateGatewayFromServer) 

# GetBandwidthRateLimitSchedule
<a name="API_BGW_GetBandwidthRateLimitSchedule"></a>

Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.

## Request Syntax
<a name="API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_GetBandwidthRateLimitSchedule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-request-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [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) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_GetBandwidthRateLimitSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [BandwidthRateLimitIntervals](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-BandwidthRateLimitIntervals"></a>
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.  
Type: Array of [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

 ** [GatewayArn](#API_BGW_GetBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_GetBandwidthRateLimitSchedule-response-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [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) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_GetBandwidthRateLimitSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_GetBandwidthRateLimitSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule) 

# GetGateway
<a name="API_BGW_GetGateway"></a>

By providing the ARN (Amazon Resource Name), this API returns the gateway.

## Request Syntax
<a name="API_BGW_GetGateway_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_GetGateway_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayArn](#API_BGW_GetGateway_RequestSyntax) **   <a name="Backup-BGW_GetGateway-request-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<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"
   }
}
```

## Response Elements
<a name="API_BGW_GetGateway_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Gateway](#API_BGW_GetGateway_ResponseSyntax) **   <a name="Backup-BGW_GetGateway-response-Gateway"></a>
By providing the ARN (Amazon Resource Name), this API returns the gateway.  
Type: [GatewayDetails](API_BGW_GatewayDetails.md) object

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

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_GetGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetGateway) 

# GetHypervisor
<a name="API_BGW_GetHypervisor"></a>

This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

## Request Syntax
<a name="API_BGW_GetHypervisor_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_GetHypervisor_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HypervisorArn](#API_BGW_GetHypervisor_RequestSyntax) **   <a name="Backup-BGW_GetHypervisor-request-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<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"
   }
}
```

## Response Elements
<a name="API_BGW_GetHypervisor_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Hypervisor](#API_BGW_GetHypervisor_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisor-response-Hypervisor"></a>
Details about the requested hypervisor.  
Type: [HypervisorDetails](API_BGW_HypervisorDetails.md) object

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

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_GetHypervisor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetHypervisor) 

# GetHypervisorPropertyMappings
<a name="API_BGW_GetHypervisorPropertyMappings"></a>

This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in AWS.

## Request Syntax
<a name="API_BGW_GetHypervisorPropertyMappings_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_GetHypervisorPropertyMappings_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-request-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_GetHypervisorPropertyMappings_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_GetHypervisorPropertyMappings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HypervisorArn](#API_BGW_GetHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_GetHypervisorPropertyMappings-response-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `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>
The Amazon Resource Name (ARN) of the IAM role.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `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>
This is a display of the mappings of VMware tags to the AWS tags.  
Type: Array of [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) objects

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

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_GetHypervisorPropertyMappings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetHypervisorPropertyMappings) 

# GetVirtualMachine
<a name="API_BGW_GetVirtualMachine"></a>

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

## Request Syntax
<a name="API_BGW_GetVirtualMachine_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_GetVirtualMachine_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_BGW_GetVirtualMachine_RequestSyntax) **   <a name="Backup-BGW_GetVirtualMachine-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the virtual machine.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<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"
         }
      ]
   }
}
```

## Response Elements
<a name="API_BGW_GetVirtualMachine_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [VirtualMachine](#API_BGW_GetVirtualMachine_ResponseSyntax) **   <a name="Backup-BGW_GetVirtualMachine-response-VirtualMachine"></a>
This object contains the basic attributes of `VirtualMachine` contained by the output of `GetVirtualMachine`   
Type: [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md) object

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

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_GetVirtualMachine_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/GetVirtualMachine) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GetVirtualMachine) 

# ImportHypervisorConfiguration
<a name="API_BGW_ImportHypervisorConfiguration"></a>

Connect to a hypervisor by importing its configuration.

## Request Syntax
<a name="API_BGW_ImportHypervisorConfiguration_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_ImportHypervisorConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Host](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Host"></a>
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `.+`   
Required: Yes

 ** [KmsKeyArn](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-KmsKeyArn"></a>
The AWS Key Management Service for the hypervisor.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)`   
Required: No

 ** [Name](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Name"></a>
The name of the hypervisor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: Yes

 ** [Password](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Password"></a>
The password for the hypervisor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[ -~]+`   
Required: No

 ** [Tags](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Tags"></a>
The tags of the hypervisor configuration to import.  
Type: Array of [Tag](API_BGW_Tag.md) objects  
Required: No

 ** [Username](#API_BGW_ImportHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-request-Username"></a>
The username for the hypervisor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`   
Required: No

## Response Syntax
<a name="API_BGW_ImportHypervisorConfiguration_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_ImportHypervisorConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HypervisorArn](#API_BGW_ImportHypervisorConfiguration_ResponseSyntax) **   <a name="Backup-BGW_ImportHypervisorConfiguration-response-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor you disassociated.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_ImportHypervisorConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The operation cannot proceed because you have insufficient permissions.    
 ** ErrorCode **   
A description of why you have insufficient permissions.
HTTP Status Code: 400

 ** ConflictException **   
The operation cannot proceed because it is not supported.    
 ** ErrorCode **   
A description of why the operation is not supported.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_ImportHypervisorConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ImportHypervisorConfiguration) 

# ListGateways
<a name="API_BGW_ListGateways"></a>

Lists backup gateways owned by an AWS account in an AWS Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

## Request Syntax
<a name="API_BGW_ListGateways_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_ListGateways_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_BGW_ListGateways_RequestSyntax) **   <a name="Backup-BGW_ListGateways-request-MaxResults"></a>
The maximum number of gateways to list.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_BGW_ListGateways_RequestSyntax) **   <a name="Backup-BGW_ListGateways-request-NextToken"></a>
The next item following a partial list of returned resources. For example, if a request is made to return `MaxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.+`   
Required: No

## Response Syntax
<a name="API_BGW_ListGateways_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_ListGateways_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Gateways](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-Gateways"></a>
A list of your gateways.  
Type: Array of [Gateway](API_BGW_Gateway.md) objects

 ** [NextToken](#API_BGW_ListGateways_ResponseSyntax) **   <a name="Backup-BGW_ListGateways-response-NextToken"></a>
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.+` 

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

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_ListGateways_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListGateways) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListGateways) 

# ListHypervisors
<a name="API_BGW_ListHypervisors"></a>

Lists your hypervisors.

## Request Syntax
<a name="API_BGW_ListHypervisors_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_ListHypervisors_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_BGW_ListHypervisors_RequestSyntax) **   <a name="Backup-BGW_ListHypervisors-request-MaxResults"></a>
The maximum number of hypervisors to list.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_BGW_ListHypervisors_RequestSyntax) **   <a name="Backup-BGW_ListHypervisors-request-NextToken"></a>
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.+`   
Required: No

## Response Syntax
<a name="API_BGW_ListHypervisors_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_ListHypervisors_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Hypervisors](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-Hypervisors"></a>
A list of your `Hypervisor` objects, ordered by their Amazon Resource Names (ARNs).  
Type: Array of [Hypervisor](API_BGW_Hypervisor.md) objects

 ** [NextToken](#API_BGW_ListHypervisors_ResponseSyntax) **   <a name="Backup-BGW_ListHypervisors-response-NextToken"></a>
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.+` 

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

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_ListHypervisors_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListHypervisors) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListHypervisors) 

# ListTagsForResource
<a name="API_BGW_ListTagsForResource"></a>

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

## Request Syntax
<a name="API_BGW_ListTagsForResource_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_BGW_ListTagsForResource_RequestSyntax) **   <a name="Backup-BGW_ListTagsForResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource's tags to list.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_ListTagsForResource_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ResourceArn](#API_BGW_ListTagsForResource_ResponseSyntax) **   <a name="Backup-BGW_ListTagsForResource-response-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource's tags that you listed.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `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>
A list of the resource's tags.  
Type: Array of [Tag](API_BGW_Tag.md) objects

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

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListTagsForResource) 

# ListVirtualMachines
<a name="API_BGW_ListVirtualMachines"></a>

Lists your virtual machines.

## Request Syntax
<a name="API_BGW_ListVirtualMachines_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_ListVirtualMachines_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HypervisorArn](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: No

 ** [MaxResults](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-MaxResults"></a>
The maximum number of virtual machines to list.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_BGW_ListVirtualMachines_RequestSyntax) **   <a name="Backup-BGW_ListVirtualMachines-request-NextToken"></a>
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.+`   
Required: No

## Response Syntax
<a name="API_BGW_ListVirtualMachines_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_ListVirtualMachines_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-NextToken"></a>
The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.+` 

 ** [VirtualMachines](#API_BGW_ListVirtualMachines_ResponseSyntax) **   <a name="Backup-BGW_ListVirtualMachines-response-VirtualMachines"></a>
A list of your `VirtualMachine` objects, ordered by their Amazon Resource Names (ARNs).  
Type: Array of [VirtualMachine](API_BGW_VirtualMachine.md) objects

## Errors
<a name="API_BGW_ListVirtualMachines_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_ListVirtualMachines_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/ListVirtualMachines) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/ListVirtualMachines) 

# PutBandwidthRateLimitSchedule
<a name="API_BGW_PutBandwidthRateLimitSchedule"></a>

This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.

## Request Syntax
<a name="API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_PutBandwidthRateLimitSchedule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [BandwidthRateLimitIntervals](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-BandwidthRateLimitIntervals"></a>
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.  
Type: Array of [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.  
Required: Yes

 ** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_RequestSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-request-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [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) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_PutBandwidthRateLimitSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayArn](#API_BGW_PutBandwidthRateLimitSchedule_ResponseSyntax) **   <a name="Backup-BGW_PutBandwidthRateLimitSchedule-response-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway. Use the [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) operation to return a list of gateways for your account and AWS Region.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_PutBandwidthRateLimitSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_PutBandwidthRateLimitSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule) 

# PutHypervisorPropertyMappings
<a name="API_BGW_PutHypervisorPropertyMappings"></a>

This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in AWS.

## Request Syntax
<a name="API_BGW_PutHypervisorPropertyMappings_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_PutHypervisorPropertyMappings_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

 ** [IamRoleArn](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-IamRoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\S+)`   
Required: Yes

 ** [VmwareToAwsTagMappings](#API_BGW_PutHypervisorPropertyMappings_RequestSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-request-VmwareToAwsTagMappings"></a>
This action requests the mappings of VMware tags to the AWS tags.  
Type: Array of [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) objects  
Required: Yes

## Response Syntax
<a name="API_BGW_PutHypervisorPropertyMappings_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_PutHypervisorPropertyMappings_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HypervisorArn](#API_BGW_PutHypervisorPropertyMappings_ResponseSyntax) **   <a name="Backup-BGW_PutHypervisorPropertyMappings-response-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_PutHypervisorPropertyMappings_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The operation cannot proceed because you have insufficient permissions.    
 ** ErrorCode **   
A description of why you have insufficient permissions.
HTTP Status Code: 400

 ** ConflictException **   
The operation cannot proceed because it is not supported.    
 ** ErrorCode **   
A description of why the operation is not supported.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_PutHypervisorPropertyMappings_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutHypervisorPropertyMappings) 

# PutMaintenanceStartTime
<a name="API_BGW_PutMaintenanceStartTime"></a>

Set the maintenance start time for a gateway.

## Request Syntax
<a name="API_BGW_PutMaintenanceStartTime_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_PutMaintenanceStartTime_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DayOfMonth](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfMonth"></a>
The day of the month start maintenance on a gateway.  
Valid values range from `Sunday` to `Saturday`.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 31.  
Required: No

 ** [DayOfWeek](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-DayOfWeek"></a>
The day of the week to start maintenance on a gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 6.  
Required: No

 ** [GatewayArn](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-GatewayArn"></a>
The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

 ** [HourOfDay](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-HourOfDay"></a>
The hour of the day to start maintenance on a gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: Yes

 ** [MinuteOfHour](#API_BGW_PutMaintenanceStartTime_RequestSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-request-MinuteOfHour"></a>
The minute of the hour to start maintenance on a gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 59.  
Required: Yes

## Response Syntax
<a name="API_BGW_PutMaintenanceStartTime_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_PutMaintenanceStartTime_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayArn](#API_BGW_PutMaintenanceStartTime_ResponseSyntax) **   <a name="Backup-BGW_PutMaintenanceStartTime-response-GatewayArn"></a>
The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_PutMaintenanceStartTime_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The operation cannot proceed because it is not supported.    
 ** ErrorCode **   
A description of why the operation is not supported.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_PutMaintenanceStartTime_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/PutMaintenanceStartTime) 

# StartVirtualMachinesMetadataSync
<a name="API_BGW_StartVirtualMachinesMetadataSync"></a>

This action sends a request to sync metadata across the specified virtual machines.

## Request Syntax
<a name="API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_StartVirtualMachinesMetadataSync_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_RequestSyntax) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-request-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_StartVirtualMachinesMetadataSync_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HypervisorArn](#API_BGW_StartVirtualMachinesMetadataSync_ResponseSyntax) **   <a name="Backup-BGW_StartVirtualMachinesMetadataSync-response-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_StartVirtualMachinesMetadataSync_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The operation cannot proceed because you have insufficient permissions.    
 ** ErrorCode **   
A description of why you have insufficient permissions.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_StartVirtualMachinesMetadataSync_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync) 

# TagResource
<a name="API_BGW_TagResource"></a>

Tag the resource.

## Request Syntax
<a name="API_BGW_TagResource_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_BGW_TagResource_RequestSyntax) **   <a name="Backup-BGW_TagResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource to tag.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

 ** [Tags](#API_BGW_TagResource_RequestSyntax) **   <a name="Backup-BGW_TagResource-request-Tags"></a>
A list of tags to assign to the resource.  
Type: Array of [Tag](API_BGW_Tag.md) objects  
Required: Yes

## Response Syntax
<a name="API_BGW_TagResource_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ResourceARN](#API_BGW_TagResource_ResponseSyntax) **   <a name="Backup-BGW_TagResource-response-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource you tagged.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/TagResource) 

# TestHypervisorConfiguration
<a name="API_BGW_TestHypervisorConfiguration"></a>

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

## Request Syntax
<a name="API_BGW_TestHypervisorConfiguration_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_TestHypervisorConfiguration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayArn](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

 ** [Host](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Host"></a>
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `.+`   
Required: Yes

 ** [Password](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Password"></a>
The password for the hypervisor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[ -~]+`   
Required: No

 ** [Username](#API_BGW_TestHypervisorConfiguration_RequestSyntax) **   <a name="Backup-BGW_TestHypervisorConfiguration-request-Username"></a>
The username for the hypervisor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`   
Required: No

## Response Elements
<a name="API_BGW_TestHypervisorConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The operation cannot proceed because it is not supported.    
 ** ErrorCode **   
A description of why the operation is not supported.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_TestHypervisorConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/TestHypervisorConfiguration) 

# UntagResource
<a name="API_BGW_UntagResource"></a>

Removes tags from the resource.

## Request Syntax
<a name="API_BGW_UntagResource_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_BGW_UntagResource_RequestSyntax) **   <a name="Backup-BGW_UntagResource-request-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource from which to remove tags.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

 ** [TagKeys](#API_BGW_UntagResource_RequestSyntax) **   <a name="Backup-BGW_UntagResource-request-TagKeys"></a>
The list of tag keys specifying which tags to remove.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## Response Syntax
<a name="API_BGW_UntagResource_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ResourceARN](#API_BGW_UntagResource_ResponseSyntax) **   <a name="Backup-BGW_UntagResource-response-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource from which you removed tags.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UntagResource) 

# UpdateGatewayInformation
<a name="API_BGW_UpdateGatewayInformation"></a>

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

## Request Syntax
<a name="API_BGW_UpdateGatewayInformation_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_UpdateGatewayInformation_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayArn](#API_BGW_UpdateGatewayInformation_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway to update.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

 ** [GatewayDisplayName](#API_BGW_UpdateGatewayInformation_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-request-GatewayDisplayName"></a>
The updated display name of the gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: No

## Response Syntax
<a name="API_BGW_UpdateGatewayInformation_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_UpdateGatewayInformation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayArn](#API_BGW_UpdateGatewayInformation_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewayInformation-response-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway you updated.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_UpdateGatewayInformation_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConflictException **   
The operation cannot proceed because it is not supported.    
 ** ErrorCode **   
A description of why the operation is not supported.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_UpdateGatewayInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewayInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateGatewayInformation) 

# UpdateGatewaySoftwareNow
<a name="API_BGW_UpdateGatewaySoftwareNow"></a>

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

**Note**  
When you make this request, you get a `200 OK` success response immediately. However, it might take some time for the update to complete.

## Request Syntax
<a name="API_BGW_UpdateGatewaySoftwareNow_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_UpdateGatewaySoftwareNow_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_RequestSyntax) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-request-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway to be updated.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

## Response Syntax
<a name="API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_UpdateGatewaySoftwareNow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GatewayArn](#API_BGW_UpdateGatewaySoftwareNow_ResponseSyntax) **   <a name="Backup-BGW_UpdateGatewaySoftwareNow-response-GatewayArn"></a>
The Amazon Resource Name (ARN) of the gateway you updated.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 180.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_UpdateGatewaySoftwareNow_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_UpdateGatewaySoftwareNow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow) 

# UpdateHypervisor
<a name="API_BGW_UpdateHypervisor"></a>

Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.

## Request Syntax
<a name="API_BGW_UpdateHypervisor_RequestSyntax"></a>

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

## Request Parameters
<a name="API_BGW_UpdateHypervisor_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Host](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Host"></a>
The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `.+`   
Required: No

 ** [HypervisorArn](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor to update.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+`   
Required: Yes

 ** [LogGroupArn](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-LogGroupArn"></a>
The Amazon Resource Name (ARN) of the group of gateways within the requested log.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.  
Pattern: `$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*`   
Required: No

 ** [Name](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Name"></a>
The updated name for the hypervisor  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: No

 ** [Password](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Password"></a>
The updated password for the hypervisor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[ -~]+`   
Required: No

 ** [Username](#API_BGW_UpdateHypervisor_RequestSyntax) **   <a name="Backup-BGW_UpdateHypervisor-request-Username"></a>
The updated username for the hypervisor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*`   
Required: No

## Response Syntax
<a name="API_BGW_UpdateHypervisor_ResponseSyntax"></a>

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

## Response Elements
<a name="API_BGW_UpdateHypervisor_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HypervisorArn](#API_BGW_UpdateHypervisor_ResponseSyntax) **   <a name="Backup-BGW_UpdateHypervisor-response-HypervisorArn"></a>
The Amazon Resource Name (ARN) of the hypervisor you updated.  
Type: String  
Length Constraints: Minimum length of 50. Maximum length of 500.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+` 

## Errors
<a name="API_BGW_UpdateHypervisor_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
The operation cannot proceed because you have insufficient permissions.    
 ** ErrorCode **   
A description of why you have insufficient permissions.
HTTP Status Code: 400

 ** ConflictException **   
The operation cannot proceed because it is not supported.    
 ** ErrorCode **   
A description of why the operation is not supported.
HTTP Status Code: 400

 ** InternalServerException **   
The operation did not succeed because an internal error occurred. Try again later.    
 ** ErrorCode **   
A description of which internal error occured.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
A resource that is required for the action wasn't found.    
 ** ErrorCode **   
A description of which resource wasn't found.
HTTP Status Code: 400

 ** ThrottlingException **   
TPS has been limited to protect against intentional or unintentional high request volumes.    
 ** ErrorCode **   
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
HTTP Status Code: 400

 ** ValidationException **   
The operation did not succeed because a validation error occurred.    
 ** ErrorCode **   
A description of what caused the validation error.
HTTP Status Code: 400

## See Also
<a name="API_BGW_UpdateHypervisor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/backup-gateway-2021-01-01/UpdateHypervisor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/UpdateHypervisor)