2021/11/30 - AWS Backup Gateway - 16 new api methods
Changes Initial release of AWS Backup gateway which enables you to centralize and automate protection of on-premises VMware and VMware Cloud on AWS workloads using AWS Backup.
Lists your hypervisors.
See also: AWS API Documentation
Request Syntax
client.list_hypervisors(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of hypervisors 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
{
'Hypervisors': [
{
'Host': 'string',
'HypervisorArn': 'string',
'KmsKeyArn': 'string',
'Name': 'string',
'State': 'PENDING'|'ONLINE'|'OFFLINE'|'ERROR'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Hypervisors (list) --
A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).
(dict) --
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.
Host (string) --
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
HypervisorArn (string) --
The Amazon Resource Name (ARN) of the hypervisor.
KmsKeyArn (string) --
The Amazon Resource Name (ARN) of the Key Management Service used to encrypt the hypervisor.
Name (string) --
The name of the hypervisor.
State (string) --
The state of the hypervisor.
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.
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
client.list_gateways(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of gateways 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
{
'Gateways': [
{
'GatewayArn': 'string',
'GatewayDisplayName': 'string',
'GatewayType': 'BACKUP_VM',
'HypervisorId': 'string',
'LastSeenTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Gateways (list) --
A list of your gateways.
(dict) --
A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.
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.
HypervisorId (string) --
The hypervisor ID of the gateway.
LastSeenTime (datetime) --
The last time Backup gateway communicated with the gateway, in Unix format and UTC time.
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.
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.
See also: AWS API Documentation
Request Syntax
client.update_hypervisor(
Host='string',
HypervisorArn='string',
Password='string',
Username='string'
)
string
The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
string
[REQUIRED]
The Amazon Resource Name (ARN) of the hypervisor to update.
string
The updated password for the hypervisor.
string
The updated username for the hypervisor.
dict
Response Syntax
{
'HypervisorArn': 'string'
}
Response Structure
(dict) --
HypervisorArn (string) --
The Amazon Resource Name (ARN) of the hypervisor you updated.
Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.
See also: AWS API Documentation
Request Syntax
client.update_gateway_information(
GatewayArn='string',
GatewayDisplayName='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway to update.
string
The updated display name of the gateway.
dict
Response Syntax
{
'GatewayArn': 'string'
}
Response Structure
(dict) --
GatewayArn (string) --
The Amazon Resource Name (ARN) of the gateway you updated.
Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.
See also: AWS API Documentation
Request Syntax
client.associate_gateway_to_server(
GatewayArn='string',
ServerArn='string'
)
string
[REQUIRED]
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
[REQUIRED]
The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
dict
Response Syntax
{
'GatewayArn': 'string'
}
Response Structure
(dict) --
GatewayArn (string) --
The Amazon Resource Name (ARN) of a gateway.
Removes tags from the resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource from which to remove tags.
list
[REQUIRED]
The list of tag keys specifying which tags to remove.
(string) --
dict
Response Syntax
{
'ResourceARN': 'string'
}
Response Structure
(dict) --
ResourceARN (string) --
The Amazon Resource Name (ARN) of the resource from which you removed tags.
Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.
See also: AWS API Documentation
Request Syntax
client.create_gateway(
ActivationKey='string',
GatewayDisplayName='string',
GatewayType='BACKUP_VM',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The activation key of the created gateway.
string
[REQUIRED]
The display name of the created gateway.
string
[REQUIRED]
The type of created gateway.
list
A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
(dict) --
A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
Key (string) -- [REQUIRED]
The key part of a tag's key-value pair. The key can't start with aws: .
Value (string) -- [REQUIRED]
The key part of a value's key-value pair.
dict
Response Syntax
{
'GatewayArn': 'string'
}
Response Structure
(dict) --
GatewayArn (string) --
The Amazon Resource Name (ARN) of the gateway you create.
Deletes a hypervisor.
See also: AWS API Documentation
Request Syntax
client.delete_hypervisor(
HypervisorArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the hypervisor to delete.
dict
Response Syntax
{
'HypervisorArn': 'string'
}
Response Structure
(dict) --
HypervisorArn (string) --
The Amazon Resource Name (ARN) of the hypervisor you deleted.
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.
See also: AWS API Documentation
Request Syntax
client.disassociate_gateway_from_server(
GatewayArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway to disassociate.
dict
Response Syntax
{
'GatewayArn': 'string'
}
Response Structure
(dict) --
GatewayArn (string) --
The Amazon Resource Name (ARN) of the gateway you disassociated.
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
See also: AWS API Documentation
Request Syntax
client.test_hypervisor_configuration(
GatewayArn='string',
Host='string',
Password='string',
Username='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
string
[REQUIRED]
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
string
The password for the hypervisor.
string
The username for the hypervisor.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists your virtual machines.
See also: AWS API Documentation
Request Syntax
client.list_virtual_machines(
MaxResults=123,
NextToken='string'
)
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.
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource's tags to list.
dict
Response Syntax
{
'ResourceArn': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource's tags that you listed.
Tags (list) --
A list of the resource's tags.
(dict) --
A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
Key (string) --
The key part of a tag's key-value pair. The key can't start with aws: .
Value (string) --
The key part of a value's key-value pair.
Deletes a backup gateway.
See also: AWS API Documentation
Request Syntax
client.delete_gateway(
GatewayArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the gateway to delete.
dict
Response Syntax
{
'GatewayArn': 'string'
}
Response Structure
(dict) --
GatewayArn (string) --
The Amazon Resource Name (ARN) of the gateway you deleted.
Tag the resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to tag.
list
[REQUIRED]
A list of tags to assign to the resource.
(dict) --
A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
Key (string) -- [REQUIRED]
The key part of a tag's key-value pair. The key can't start with aws: .
Value (string) -- [REQUIRED]
The key part of a value's key-value pair.
dict
Response Syntax
{
'ResourceARN': 'string'
}
Response Structure
(dict) --
ResourceARN (string) --
The Amazon Resource Name (ARN) of the resource you tagged.
Connect to a hypervisor by importing its configuration.
See also: AWS API Documentation
Request Syntax
client.import_hypervisor_configuration(
Host='string',
KmsKeyArn='string',
Name='string',
Password='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Username='string'
)
string
[REQUIRED]
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
string
The Key Management Service for the hypervisor.
string
[REQUIRED]
The name of the hypervisor.
string
The password for the hypervisor.
list
The tags of the hypervisor configuration to import.
(dict) --
A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
Key (string) -- [REQUIRED]
The key part of a tag's key-value pair. The key can't start with aws: .
Value (string) -- [REQUIRED]
The key part of a value's key-value pair.
string
The username for the hypervisor.
dict
Response Syntax
{
'HypervisorArn': 'string'
}
Response Structure
(dict) --
HypervisorArn (string) --
The Amazon Resource Name (ARN) of the hypervisor you disassociated.
Set the maintenance start time for a gateway.
See also: AWS API Documentation
Request Syntax
client.put_maintenance_start_time(
DayOfMonth=123,
DayOfWeek=123,
GatewayArn='string',
HourOfDay=123,
MinuteOfHour=123
)
integer
The day of the month start maintenance on a gateway.
Valid values range from Sunday to Saturday .
integer
The day of the week to start maintenance on a gateway.
string
[REQUIRED]
The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.
integer
[REQUIRED]
The hour of the day to start maintenance on a gateway.
integer
[REQUIRED]
The minute of the hour to start maintenance on a gateway.
dict
Response Syntax
{
'GatewayArn': 'string'
}
Response Structure
(dict) --
GatewayArn (string) --
The Amazon Resource Name (ARN) of a gateway for which you set the maintenance start time.