2022/09/22 - AWS Backup Gateway - 1 new 2 updated api methods
Changes Changes include: new GetVirtualMachineApi to fetch a single user's VM, improving ListVirtualMachines to fetch filtered VMs as well as all VMs, and improving GetGatewayApi to now also return the gateway's MaintenanceStartTime.
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
See also: AWS API Documentation
Request Syntax
client.get_virtual_machine(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the virtual machine.
dict
Response Syntax
{
'VirtualMachine': {
'HostName': 'string',
'HypervisorId': 'string',
'LastBackupDate': datetime(2015, 1, 1),
'Name': 'string',
'Path': 'string',
'ResourceArn': 'string'
}
}
Response Structure
(dict) --
VirtualMachine (dict) --
This object contains the basic attributes of VirtualMachine contained by the output of GetVirtualMachine
HostName (string) --
The host name of the virtual machine.
HypervisorId (string) --
The ID of the virtual machine's hypervisor.
LastBackupDate (datetime) --
The most recent date a virtual machine was backed up, in Unix format and UTC time.
Name (string) --
The name of the virtual machine.
Path (string) --
The path of the virtual machine.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL .
{'Gateway': {'MaintenanceStartTime': {'DayOfMonth': 'integer',
'DayOfWeek': 'integer',
'HourOfDay': 'integer',
'MinuteOfHour': 'integer'}}}
By providing the ARN (Amazon Resource Name), this API returns the gateway.
See also: AWS API Documentation
Request Syntax
client.get_gateway(
GatewayArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway.
dict
Response Syntax
{
'Gateway': {
'GatewayArn': 'string',
'GatewayDisplayName': 'string',
'GatewayType': 'BACKUP_VM',
'HypervisorId': 'string',
'LastSeenTime': datetime(2015, 1, 1),
'MaintenanceStartTime': {
'DayOfMonth': 123,
'DayOfWeek': 123,
'HourOfDay': 123,
'MinuteOfHour': 123
},
'NextUpdateAvailabilityTime': datetime(2015, 1, 1),
'VpcEndpoint': 'string'
}
}
Response Structure
(dict) --
Gateway (dict) --
By providing the ARN (Amazon Resource Name), this API returns the gateway.
GatewayArn (string) --
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.
GatewayDisplayName (string) --
The display name of the gateway.
GatewayType (string) --
The type of the gateway type.
HypervisorId (string) --
The hypervisor ID of the gateway.
LastSeenTime (datetime) --
Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.
MaintenanceStartTime (dict) --
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.
DayOfMonth (integer) --
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.
DayOfWeek (integer) --
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.
HourOfDay (integer) --
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.
MinuteOfHour (integer) --
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.
NextUpdateAvailabilityTime (datetime) --
Details showing the next update availability time of the gateway.
VpcEndpoint (string) --
The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to connect to the cloud for backup gateway.
{'HypervisorArn': 'string'}
Lists your virtual machines.
See also: AWS API Documentation
Request Syntax
client.list_virtual_machines(
HypervisorArn='string',
MaxResults=123,
NextToken='string'
)
string
The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.
integer
The maximum number of virtual machines to list.
string
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.
dict
Response Syntax
{
'NextToken': 'string',
'VirtualMachines': [
{
'HostName': 'string',
'HypervisorId': 'string',
'LastBackupDate': datetime(2015, 1, 1),
'Name': 'string',
'Path': 'string',
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
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.
VirtualMachines (list) --
A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).
(dict) --
A virtual machine that is on a hypervisor.
HostName (string) --
The host name of the virtual machine.
HypervisorId (string) --
The ID of the virtual machine's hypervisor.
LastBackupDate (datetime) --
The most recent date a virtual machine was backed up, in Unix format and UTC time.
Name (string) --
The name of the virtual machine.
Path (string) --
The path of the virtual machine.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL .