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

The following data types are supported by AWS Backup gateway:
+  [BandwidthRateLimitInterval](API_BGW_BandwidthRateLimitInterval.md) 
+  [Gateway](API_BGW_Gateway.md) 
+  [GatewayDetails](API_BGW_GatewayDetails.md) 
+  [Hypervisor](API_BGW_Hypervisor.md) 
+  [HypervisorDetails](API_BGW_HypervisorDetails.md) 
+  [MaintenanceStartTime](API_BGW_MaintenanceStartTime.md) 
+  [Tag](API_BGW_Tag.md) 
+  [VirtualMachine](API_BGW_VirtualMachine.md) 
+  [VirtualMachineDetails](API_BGW_VirtualMachineDetails.md) 
+  [VmwareTag](API_BGW_VmwareTag.md) 
+  [VmwareToAwsTagMapping](API_BGW_VmwareToAwsTagMapping.md) 

# BandwidthRateLimitInterval
<a name="API_BGW_BandwidthRateLimitInterval"></a>

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading.

## Contents
<a name="API_BGW_BandwidthRateLimitInterval_Contents"></a>

 ** DaysOfWeek **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-DaysOfWeek"></a>
The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.  
Type: Array of integers  
Array Members: Minimum number of 1 item. Maximum number of 7 items.  
Valid Range: Minimum value of 0. Maximum value of 6.  
Required: Yes

 ** EndHourOfDay **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-EndHourOfDay"></a>
The hour of the day to end the bandwidth rate limit interval.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: Yes

 ** EndMinuteOfHour **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-EndMinuteOfHour"></a>
The minute of the hour to end the bandwidth rate limit interval.  
The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value `59`.
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 59.  
Required: Yes

 ** StartHourOfDay **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-StartHourOfDay"></a>
The hour of the day to start the bandwidth rate limit interval.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: Yes

 ** StartMinuteOfHour **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-StartMinuteOfHour"></a>
The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value `0`.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 59.  
Required: Yes

 ** AverageUploadRateLimitInBitsPerSec **   <a name="Backup-Type-BGW_BandwidthRateLimitInterval-AverageUploadRateLimitInBitsPerSec"></a>
The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.  
Type: Long  
Valid Range: Minimum value of 51200. Maximum value of 8000000000000.  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/BandwidthRateLimitInterval) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/BandwidthRateLimitInterval) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/BandwidthRateLimitInterval) 

# Gateway
<a name="API_BGW_Gateway"></a>

A gateway is an AWS Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the AWS Cloud.

## Contents
<a name="API_BGW_Gateway_Contents"></a>

 ** GatewayArn **   <a name="Backup-Type-BGW_Gateway-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: No

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

 ** GatewayType **   <a name="Backup-Type-BGW_Gateway-GatewayType"></a>
The type of the gateway.  
Type: String  
Valid Values: `BACKUP_VM`   
Required: No

 ** HypervisorId **   <a name="Backup-Type-BGW_Gateway-HypervisorId"></a>
The hypervisor ID of the gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** LastSeenTime **   <a name="Backup-Type-BGW_Gateway-LastSeenTime"></a>
The last time AWS Backup gateway communicated with the gateway, in Unix format and UTC time.  
Type: Timestamp  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Gateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Gateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/Gateway) 

# GatewayDetails
<a name="API_BGW_GatewayDetails"></a>

The details of gateway.

## Contents
<a name="API_BGW_GatewayDetails_Contents"></a>

 ** DeprecationDate **   <a name="Backup-Type-BGW_GatewayDetails-DeprecationDate"></a>
Date after which this gateway will not receive software updates for new features and bug fixes.  
Type: Timestamp  
Required: No

 ** GatewayArn **   <a name="Backup-Type-BGW_GatewayDetails-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: No

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

 ** GatewayType **   <a name="Backup-Type-BGW_GatewayDetails-GatewayType"></a>
The type of the gateway type.  
Type: String  
Valid Values: `BACKUP_VM`   
Required: No

 ** HypervisorId **   <a name="Backup-Type-BGW_GatewayDetails-HypervisorId"></a>
The hypervisor ID of the gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** LastSeenTime **   <a name="Backup-Type-BGW_GatewayDetails-LastSeenTime"></a>
Details showing the last time AWS Backup gateway communicated with the cloud, in Unix format and UTC time.  
Type: Timestamp  
Required: No

 ** MaintenanceStartTime **   <a name="Backup-Type-BGW_GatewayDetails-MaintenanceStartTime"></a>
Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.  
Type: [MaintenanceStartTime](API_BGW_MaintenanceStartTime.md) object  
Required: No

 ** NextUpdateAvailabilityTime **   <a name="Backup-Type-BGW_GatewayDetails-NextUpdateAvailabilityTime"></a>
Details showing the next update availability time of the gateway.  
Type: Timestamp  
Required: No

 ** SoftwareVersion **   <a name="Backup-Type-BGW_GatewayDetails-SoftwareVersion"></a>
The version number of the software running on the gateway appliance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: No

 ** VpcEndpoint **   <a name="Backup-Type-BGW_GatewayDetails-VpcEndpoint"></a>
The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/GatewayDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/GatewayDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/GatewayDetails) 

# Hypervisor
<a name="API_BGW_Hypervisor"></a>

Represents the hypervisor's permissions to which the gateway will connect.

A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

## Contents
<a name="API_BGW_Hypervisor_Contents"></a>

 ** Host **   <a name="Backup-Type-BGW_Hypervisor-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: No

 ** HypervisorArn **   <a name="Backup-Type-BGW_Hypervisor-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: No

 ** KmsKeyArn **   <a name="Backup-Type-BGW_Hypervisor-KmsKeyArn"></a>
The Amazon Resource Name (ARN) of the AWS Key Management Service used to encrypt 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 **   <a name="Backup-Type-BGW_Hypervisor-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: No

 ** State **   <a name="Backup-Type-BGW_Hypervisor-State"></a>
The state of the hypervisor.  
Type: String  
Valid Values: `PENDING | ONLINE | OFFLINE | ERROR`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Hypervisor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Hypervisor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/Hypervisor) 

# HypervisorDetails
<a name="API_BGW_HypervisorDetails"></a>

These are the details of the specified hypervisor. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

## Contents
<a name="API_BGW_HypervisorDetails_Contents"></a>

 ** Host **   <a name="Backup-Type-BGW_HypervisorDetails-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: No

 ** HypervisorArn **   <a name="Backup-Type-BGW_HypervisorDetails-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: No

 ** KmsKeyArn **   <a name="Backup-Type-BGW_HypervisorDetails-KmsKeyArn"></a>
The Amazon Resource Name (ARN) of the AWS KMS used to encrypt 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

 ** LastSuccessfulMetadataSyncTime **   <a name="Backup-Type-BGW_HypervisorDetails-LastSuccessfulMetadataSyncTime"></a>
This is the time when the most recent successful sync of metadata occurred.  
Type: Timestamp  
Required: No

 ** LatestMetadataSyncStatus **   <a name="Backup-Type-BGW_HypervisorDetails-LatestMetadataSyncStatus"></a>
This is the most recent status for the indicated metadata sync.  
Type: String  
Valid Values: `CREATED | RUNNING | FAILED | PARTIALLY_FAILED | SUCCEEDED`   
Required: No

 ** LatestMetadataSyncStatusMessage **   <a name="Backup-Type-BGW_HypervisorDetails-LatestMetadataSyncStatusMessage"></a>
This is the most recent status for the indicated metadata sync.  
Type: String  
Required: No

 ** LogGroupArn **   <a name="Backup-Type-BGW_HypervisorDetails-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 **   <a name="Backup-Type-BGW_HypervisorDetails-Name"></a>
This is the name of the specified hypervisor.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: No

 ** State **   <a name="Backup-Type-BGW_HypervisorDetails-State"></a>
This is the current state of the specified hypervisor.  
The possible states are `PENDING`, `ONLINE`, `OFFLINE`, or `ERROR`.  
Type: String  
Valid Values: `PENDING | ONLINE | OFFLINE | ERROR`   
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/HypervisorDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/HypervisorDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/HypervisorDetails) 

# MaintenanceStartTime
<a name="API_BGW_MaintenanceStartTime"></a>

This is your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

## Contents
<a name="API_BGW_MaintenanceStartTime_Contents"></a>

 ** HourOfDay **   <a name="Backup-Type-BGW_MaintenanceStartTime-HourOfDay"></a>
The hour component of the maintenance start time represented as *hh*, where *hh* is the hour (0 to 23). The hour of the day is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: Yes

 ** MinuteOfHour **   <a name="Backup-Type-BGW_MaintenanceStartTime-MinuteOfHour"></a>
The minute component of the maintenance start time represented as *mm*, where *mm* is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 59.  
Required: Yes

 ** DayOfMonth **   <a name="Backup-Type-BGW_MaintenanceStartTime-DayOfMonth"></a>
The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 31.  
Required: No

 ** DayOfWeek **   <a name="Backup-Type-BGW_MaintenanceStartTime-DayOfWeek"></a>
An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 6.  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/MaintenanceStartTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/MaintenanceStartTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/MaintenanceStartTime) 

# Tag
<a name="API_BGW_Tag"></a>

A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, and the following characters: \$1 - = . \$1 : /. Spaces are not allowed in tag values.

## Contents
<a name="API_BGW_Tag_Contents"></a>

 ** Key **   <a name="Backup-Type-BGW_Tag-Key"></a>
The key part of a tag's key-value pair. The key can't start with `aws:`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

 ** Value **   <a name="Backup-Type-BGW_Tag-Value"></a>
The value part of a tag's key-value pair.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `[^\x00]*`   
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/Tag) 

# VirtualMachine
<a name="API_BGW_VirtualMachine"></a>

A virtual machine that is on a hypervisor.

## Contents
<a name="API_BGW_VirtualMachine_Contents"></a>

 ** HostName **   <a name="Backup-Type-BGW_VirtualMachine-HostName"></a>
The host name of the virtual machine.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: No

 ** HypervisorId **   <a name="Backup-Type-BGW_VirtualMachine-HypervisorId"></a>
The ID of the virtual machine's hypervisor.  
Type: String  
Required: No

 ** LastBackupDate **   <a name="Backup-Type-BGW_VirtualMachine-LastBackupDate"></a>
The most recent date a virtual machine was backed up, in Unix format and UTC time.  
Type: Timestamp  
Required: No

 ** Name **   <a name="Backup-Type-BGW_VirtualMachine-Name"></a>
The name of the virtual machine.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: No

 ** Path **   <a name="Backup-Type-BGW_VirtualMachine-Path"></a>
The path of the virtual machine.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[^\x00]+`   
Required: No

 ** ResourceArn **   <a name="Backup-Type-BGW_VirtualMachine-ResourceArn"></a>
The Amazon Resource Name (ARN) of the virtual machine. For example, `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.  
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

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VirtualMachine) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VirtualMachine) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VirtualMachine) 

# VirtualMachineDetails
<a name="API_BGW_VirtualMachineDetails"></a>

Your `VirtualMachine` objects, ordered by their Amazon Resource Names (ARNs).

## Contents
<a name="API_BGW_VirtualMachineDetails_Contents"></a>

 ** HostName **   <a name="Backup-Type-BGW_VirtualMachineDetails-HostName"></a>
The host name of the virtual machine.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: No

 ** HypervisorId **   <a name="Backup-Type-BGW_VirtualMachineDetails-HypervisorId"></a>
The ID of the virtual machine's hypervisor.  
Type: String  
Required: No

 ** LastBackupDate **   <a name="Backup-Type-BGW_VirtualMachineDetails-LastBackupDate"></a>
The most recent date a virtual machine was backed up, in Unix format and UTC time.  
Type: Timestamp  
Required: No

 ** Name **   <a name="Backup-Type-BGW_VirtualMachineDetails-Name"></a>
The name of the virtual machine.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9-]*`   
Required: No

 ** Path **   <a name="Backup-Type-BGW_VirtualMachineDetails-Path"></a>
The path of the virtual machine.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `[^\x00]+`   
Required: No

 ** ResourceArn **   <a name="Backup-Type-BGW_VirtualMachineDetails-ResourceArn"></a>
The Amazon Resource Name (ARN) of the virtual machine. For example, `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.  
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

 ** VmwareTags **   <a name="Backup-Type-BGW_VirtualMachineDetails-VmwareTags"></a>
These are the details of the VMware tags associated with the specified virtual machine.  
Type: Array of [VmwareTag](API_BGW_VmwareTag.md) objects  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VirtualMachineDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VirtualMachineDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VirtualMachineDetails) 

# VmwareTag
<a name="API_BGW_VmwareTag"></a>

A VMware tag is a tag attached to a specific virtual machine. A [tag](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html) is a key-value pair you can use to manage, filter, and search for your resources.

The content of VMware tags can be matched to AWS tags.

## Contents
<a name="API_BGW_VmwareTag_Contents"></a>

 ** VmwareCategory **   <a name="Backup-Type-BGW_VmwareTag-VmwareCategory"></a>
The is the category of VMware.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Required: No

 ** VmwareTagDescription **   <a name="Backup-Type-BGW_VmwareTag-VmwareTagDescription"></a>
This is a user-defined description of a VMware tag.  
Type: String  
Required: No

 ** VmwareTagName **   <a name="Backup-Type-BGW_VmwareTag-VmwareTagName"></a>
This is the user-defined name of a VMware tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Required: No

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VmwareTag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VmwareTag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VmwareTag) 

# VmwareToAwsTagMapping
<a name="API_BGW_VmwareToAwsTagMapping"></a>

This displays the mapping of VMware tags to the corresponding AWS tags.

## Contents
<a name="API_BGW_VmwareToAwsTagMapping_Contents"></a>

 ** AwsTagKey **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-AwsTagKey"></a>
The key part of the AWS tag's key-value pair.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

 ** AwsTagValue **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-AwsTagValue"></a>
The value part of the AWS tag's key-value pair.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `[^\x00]*`   
Required: Yes

 ** VmwareCategory **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-VmwareCategory"></a>
The is the category of VMware.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Required: Yes

 ** VmwareTagName **   <a name="Backup-Type-BGW_VmwareToAwsTagMapping-VmwareTagName"></a>
This is the user-defined name of a VMware tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 80.  
Required: Yes

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

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-gateway-2021-01-01/VmwareToAwsTagMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-gateway-2021-01-01/VmwareToAwsTagMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-gateway-2021-01-01/VmwareToAwsTagMapping)