String errorCode
A description of why you have insufficient permissions.
String gatewayArn
The Amazon Resource Name (ARN) of a gateway.
Long averageUploadRateLimitInBitsPerSec
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.
For Backup Gateway, the minimum value is (Value).
List<E> daysOfWeek
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.
Integer endHourOfDay
The hour of the day to end the bandwidth rate limit interval.
Integer endMinuteOfHour
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.
Integer startHourOfDay
The hour of the day to start the bandwidth rate limit interval.
Integer startMinuteOfHour
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.
String errorCode
A description of why the operation is not supported.
String activationKey
The activation key of the created gateway.
String gatewayDisplayName
The display name of the created gateway.
String gatewayType
The type of created gateway.
List<E> tags
A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway you create.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway to delete.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway you deleted.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor to delete.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor you deleted.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway to disassociate.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway you disassociated.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of
gateways for your account and Amazon Web Services Region.
String gatewayDisplayName
The display name of the gateway.
String gatewayType
The type of the gateway.
String hypervisorId
The hypervisor ID of the gateway.
Date lastSeenTime
The last time Backup gateway communicated with the gateway, in Unix format and UTC time.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of
gateways for your account and Amazon Web Services Region.
String gatewayDisplayName
The display name of the gateway.
String gatewayType
The type of the gateway type.
String hypervisorId
The hypervisor ID of the gateway.
Date lastSeenTime
Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.
MaintenanceStartTime maintenanceStartTime
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.
Date nextUpdateAvailabilityTime
Details showing the next update availability time of the gateway.
String vpcEndpoint
The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway. Use the
ListGateways operation to return a list of gateways for your account and Amazon Web Services
Region.
List<E> bandwidthRateLimitIntervals
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway. Use the
ListGateways operation to return a list of gateways for your account and Amazon Web Services
Region.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway.
GatewayDetails gateway
By providing the ARN (Amazon Resource Name), this API returns the gateway.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor.
String iamRoleArn
The Amazon Resource Name (ARN) of the IAM role.
List<E> vmwareToAwsTagMappings
This is a display of the mappings of on-premises VMware tags to the Amazon Web Services tags.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor.
HypervisorDetails hypervisor
Details about the requested hypervisor.
String resourceArn
The Amazon Resource Name (ARN) of the virtual machine.
VirtualMachineDetails virtualMachine
This object contains the basic attributes of VirtualMachine contained by the output of
GetVirtualMachine
String host
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor.
String kmsKeyArn
The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.
String name
The name of the hypervisor.
String state
The state of the hypervisor.
String host
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor.
String kmsKeyArn
The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor.
Date lastSuccessfulMetadataSyncTime
This is the time when the most recent successful sync of metadata occurred.
String latestMetadataSyncStatus
This is the most recent status for the indicated metadata sync.
String latestMetadataSyncStatusMessage
This is the most recent status for the indicated metadata sync.
String logGroupArn
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
String name
This is the name of the specified hypervisor.
String state
This is the current state of the specified hypervisor.
The possible states are PENDING, ONLINE, OFFLINE, or ERROR.
String host
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
String kmsKeyArn
The Key Management Service for the hypervisor.
String name
The name of the hypervisor.
String password
The password for the hypervisor.
List<E> tags
The tags of the hypervisor configuration to import.
String username
The username for the hypervisor.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor you disassociated.
String errorCode
A description of which internal error occured.
Integer maxResults
The maximum number of gateways to list.
String nextToken
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.
List<E> gateways
A list of your gateways.
String nextToken
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.
Integer maxResults
The maximum number of hypervisors to list.
String nextToken
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.
List<E> hypervisors
A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).
String nextToken
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.
String resourceArn
The Amazon Resource Name (ARN) of the resource's tags to list.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.
Integer maxResults
The maximum number of virtual machines to list.
String nextToken
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.
String nextToken
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.
List<E> virtualMachines
A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).
Integer dayOfMonth
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.
Integer dayOfWeek
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.
Integer hourOfDay
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.
Integer minuteOfHour
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.
List<E> bandwidthRateLimitIntervals
An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway. Use the
ListGateways operation to return a list of gateways for your account and Amazon Web Services
Region.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway. Use the
ListGateways operation to return a list of gateways for your account and Amazon Web Services
Region.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor.
String iamRoleArn
The Amazon Resource Name (ARN) of the IAM role.
List<E> vmwareToAwsTagMappings
This action requests the mappings of on-premises VMware tags to the Amazon Web Services tags.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor.
Integer dayOfMonth
The day of the month start maintenance on a gateway.
Valid values range from Sunday to Saturday.
Integer dayOfWeek
The day of the week to start maintenance on a gateway.
String gatewayArn
The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.
Integer hourOfDay
The hour of the day to start maintenance on a gateway.
Integer minuteOfHour
The minute of the hour to start maintenance on a gateway.
String gatewayArn
The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.
String errorCode
A description of which resource wasn't found.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor.
String resourceARN
The Amazon Resource Name (ARN) of the resource you tagged.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
String host
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
String password
The password for the hypervisor.
String username
The username for the hypervisor.
String errorCode
Error: TPS has been limited to protect against intentional or unintentional high request volumes.
String resourceARN
The Amazon Resource Name (ARN) of the resource from which you removed tags.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway you updated.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway to be updated.
String gatewayArn
The Amazon Resource Name (ARN) of the gateway you updated.
String host
The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor to update.
String logGroupArn
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
String name
The updated name for the hypervisor
String password
The updated password for the hypervisor.
String username
The updated username for the hypervisor.
String hypervisorArn
The Amazon Resource Name (ARN) of the hypervisor you updated.
String errorCode
A description of what caused the validation error.
String hostName
The host name of the virtual machine.
String hypervisorId
The ID of the virtual machine's hypervisor.
Date lastBackupDate
The most recent date a virtual machine was backed up, in Unix format and UTC time.
String name
The name of the virtual machine.
String path
The path of the virtual machine.
String resourceArn
The Amazon Resource Name (ARN) of the virtual machine. For example,
arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.
String hostName
The host name of the virtual machine.
String hypervisorId
The ID of the virtual machine's hypervisor.
Date lastBackupDate
The most recent date a virtual machine was backed up, in Unix format and UTC time.
String name
The name of the virtual machine.
String path
The path of the virtual machine.
String resourceArn
The Amazon Resource Name (ARN) of the virtual machine. For example,
arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.
List<E> vmwareTags
These are the details of the VMware tags associated with the specified virtual machine.
String awsTagKey
The key part of the Amazon Web Services tag's key-value pair.
String awsTagValue
The value part of the Amazon Web Services tag's key-value pair.
String vmwareCategory
The is the category of VMware.
String vmwareTagName
This is the user-defined name of a VMware tag.
Copyright © 2025. All rights reserved.