BackupGatewayClient
Index > BackupGateway > BackupGatewayClient
Auto-generated documentation for BackupGateway type annotations stubs module mypy-boto3-backup-gateway.
BackupGatewayClient
Type annotations and code completion for boto3.client("backup-gateway")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_backup_gateway.client import BackupGatewayClient
def get_backup-gateway_client() -> BackupGatewayClient:
return Session().client("backup-gateway")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("backup-gateway").exceptions
structure.
client = boto3.client("backup-gateway")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_backup_gateway.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
associate_gateway_to_server
Associates a backup gateway with your server.
Type annotations and code completion for boto3.client("backup-gateway").associate_gateway_to_server
method.
boto3 documentation
def associate_gateway_to_server(
self,
*,
GatewayArn: str,
ServerArn: str,
) -> AssociateGatewayToServerOutputTypeDef: # (1)
...
kwargs: AssociateGatewayToServerInputRequestTypeDef = { # (1)
"GatewayArn": ...,
"ServerArn": ...,
}
parent.associate_gateway_to_server(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("backup-gateway").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("backup-gateway").close
method.
boto3 documentation
create_gateway
Creates a backup gateway.
Type annotations and code completion for boto3.client("backup-gateway").create_gateway
method.
boto3 documentation
def create_gateway(
self,
*,
ActivationKey: str,
GatewayDisplayName: str,
GatewayType: GatewayTypeType, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateGatewayOutputTypeDef: # (3)
...
- See GatewayTypeType
- See TagTypeDef
- See CreateGatewayOutputTypeDef
kwargs: CreateGatewayInputRequestTypeDef = { # (1)
"ActivationKey": ...,
"GatewayDisplayName": ...,
"GatewayType": ...,
}
parent.create_gateway(**kwargs)
delete_gateway
Deletes a backup gateway.
Type annotations and code completion for boto3.client("backup-gateway").delete_gateway
method.
boto3 documentation
def delete_gateway(
self,
*,
GatewayArn: str,
) -> DeleteGatewayOutputTypeDef: # (1)
...
kwargs: DeleteGatewayInputRequestTypeDef = { # (1)
"GatewayArn": ...,
}
parent.delete_gateway(**kwargs)
delete_hypervisor
Deletes a hypervisor.
Type annotations and code completion for boto3.client("backup-gateway").delete_hypervisor
method.
boto3 documentation
def delete_hypervisor(
self,
*,
HypervisorArn: str,
) -> DeleteHypervisorOutputTypeDef: # (1)
...
kwargs: DeleteHypervisorInputRequestTypeDef = { # (1)
"HypervisorArn": ...,
}
parent.delete_hypervisor(**kwargs)
disassociate_gateway_from_server
Disassociates a backup gateway from the specified server.
Type annotations and code completion for boto3.client("backup-gateway").disassociate_gateway_from_server
method.
boto3 documentation
def disassociate_gateway_from_server(
self,
*,
GatewayArn: str,
) -> DisassociateGatewayFromServerOutputTypeDef: # (1)
...
kwargs: DisassociateGatewayFromServerInputRequestTypeDef = { # (1)
"GatewayArn": ...,
}
parent.disassociate_gateway_from_server(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("backup-gateway").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_bandwidth_rate_limit_schedule
Retrieves the bandwidth rate limit schedule for a specified gateway.
Type annotations and code completion for boto3.client("backup-gateway").get_bandwidth_rate_limit_schedule
method.
boto3 documentation
def get_bandwidth_rate_limit_schedule(
self,
*,
GatewayArn: str,
) -> GetBandwidthRateLimitScheduleOutputTypeDef: # (1)
...
kwargs: GetBandwidthRateLimitScheduleInputRequestTypeDef = { # (1)
"GatewayArn": ...,
}
parent.get_bandwidth_rate_limit_schedule(**kwargs)
get_gateway
By providing the ARN (Amazon Resource Name), this API returns the gateway.
Type annotations and code completion for boto3.client("backup-gateway").get_gateway
method.
boto3 documentation
kwargs: GetGatewayInputRequestTypeDef = { # (1)
"GatewayArn": ...,
}
parent.get_gateway(**kwargs)
get_hypervisor
This action requests information about the specified hypervisor to which the gateway will connect.
Type annotations and code completion for boto3.client("backup-gateway").get_hypervisor
method.
boto3 documentation
def get_hypervisor(
self,
*,
HypervisorArn: str,
) -> GetHypervisorOutputTypeDef: # (1)
...
kwargs: GetHypervisorInputRequestTypeDef = { # (1)
"HypervisorArn": ...,
}
parent.get_hypervisor(**kwargs)
get_hypervisor_property_mappings
This action retrieves the property mappings for the specified hypervisor.
Type annotations and code completion for boto3.client("backup-gateway").get_hypervisor_property_mappings
method.
boto3 documentation
def get_hypervisor_property_mappings(
self,
*,
HypervisorArn: str,
) -> GetHypervisorPropertyMappingsOutputTypeDef: # (1)
...
kwargs: GetHypervisorPropertyMappingsInputRequestTypeDef = { # (1)
"HypervisorArn": ...,
}
parent.get_hypervisor_property_mappings(**kwargs)
get_virtual_machine
By providing the ARN (Amazon Resource Name), this API returns the virtual machine.
Type annotations and code completion for boto3.client("backup-gateway").get_virtual_machine
method.
boto3 documentation
def get_virtual_machine(
self,
*,
ResourceArn: str,
) -> GetVirtualMachineOutputTypeDef: # (1)
...
kwargs: GetVirtualMachineInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_virtual_machine(**kwargs)
import_hypervisor_configuration
Connect to a hypervisor by importing its configuration.
Type annotations and code completion for boto3.client("backup-gateway").import_hypervisor_configuration
method.
boto3 documentation
def import_hypervisor_configuration(
self,
*,
Host: str,
Name: str,
KmsKeyArn: str = ...,
Password: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
Username: str = ...,
) -> ImportHypervisorConfigurationOutputTypeDef: # (2)
...
kwargs: ImportHypervisorConfigurationInputRequestTypeDef = { # (1)
"Host": ...,
"Name": ...,
}
parent.import_hypervisor_configuration(**kwargs)
list_gateways
Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region.
Type annotations and code completion for boto3.client("backup-gateway").list_gateways
method.
boto3 documentation
def list_gateways(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListGatewaysOutputTypeDef: # (1)
...
kwargs: ListGatewaysInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_gateways(**kwargs)
list_hypervisors
Lists your hypervisors.
Type annotations and code completion for boto3.client("backup-gateway").list_hypervisors
method.
boto3 documentation
def list_hypervisors(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListHypervisorsOutputTypeDef: # (1)
...
kwargs: ListHypervisorsInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_hypervisors(**kwargs)
list_tags_for_resource
Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("backup-gateway").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_virtual_machines
Lists your virtual machines.
Type annotations and code completion for boto3.client("backup-gateway").list_virtual_machines
method.
boto3 documentation
def list_virtual_machines(
self,
*,
HypervisorArn: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListVirtualMachinesOutputTypeDef: # (1)
...
kwargs: ListVirtualMachinesInputRequestTypeDef = { # (1)
"HypervisorArn": ...,
}
parent.list_virtual_machines(**kwargs)
put_bandwidth_rate_limit_schedule
This action sets the bandwidth rate limit schedule for a specified gateway.
Type annotations and code completion for boto3.client("backup-gateway").put_bandwidth_rate_limit_schedule
method.
boto3 documentation
def put_bandwidth_rate_limit_schedule(
self,
*,
BandwidthRateLimitIntervals: Sequence[BandwidthRateLimitIntervalTypeDef], # (1)
GatewayArn: str,
) -> PutBandwidthRateLimitScheduleOutputTypeDef: # (2)
...
kwargs: PutBandwidthRateLimitScheduleInputRequestTypeDef = { # (1)
"BandwidthRateLimitIntervals": ...,
"GatewayArn": ...,
}
parent.put_bandwidth_rate_limit_schedule(**kwargs)
put_hypervisor_property_mappings
This action sets the property mappings for the specified hypervisor.
Type annotations and code completion for boto3.client("backup-gateway").put_hypervisor_property_mappings
method.
boto3 documentation
def put_hypervisor_property_mappings(
self,
*,
HypervisorArn: str,
IamRoleArn: str,
VmwareToAwsTagMappings: Sequence[VmwareToAwsTagMappingTypeDef], # (1)
) -> PutHypervisorPropertyMappingsOutputTypeDef: # (2)
...
kwargs: PutHypervisorPropertyMappingsInputRequestTypeDef = { # (1)
"HypervisorArn": ...,
"IamRoleArn": ...,
"VmwareToAwsTagMappings": ...,
}
parent.put_hypervisor_property_mappings(**kwargs)
put_maintenance_start_time
Set the maintenance start time for a gateway.
Type annotations and code completion for boto3.client("backup-gateway").put_maintenance_start_time
method.
boto3 documentation
def put_maintenance_start_time(
self,
*,
GatewayArn: str,
HourOfDay: int,
MinuteOfHour: int,
DayOfMonth: int = ...,
DayOfWeek: int = ...,
) -> PutMaintenanceStartTimeOutputTypeDef: # (1)
...
kwargs: PutMaintenanceStartTimeInputRequestTypeDef = { # (1)
"GatewayArn": ...,
"HourOfDay": ...,
"MinuteOfHour": ...,
}
parent.put_maintenance_start_time(**kwargs)
start_virtual_machines_metadata_sync
This action sends a request to sync metadata across the specified virtual machines.
Type annotations and code completion for boto3.client("backup-gateway").start_virtual_machines_metadata_sync
method.
boto3 documentation
def start_virtual_machines_metadata_sync(
self,
*,
HypervisorArn: str,
) -> StartVirtualMachinesMetadataSyncOutputTypeDef: # (1)
...
kwargs: StartVirtualMachinesMetadataSyncInputRequestTypeDef = { # (1)
"HypervisorArn": ...,
}
parent.start_virtual_machines_metadata_sync(**kwargs)
tag_resource
Tag the resource.
Type annotations and code completion for boto3.client("backup-gateway").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> TagResourceOutputTypeDef: # (2)
...
- See TagTypeDef
- See TagResourceOutputTypeDef
kwargs: TagResourceInputRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
test_hypervisor_configuration
Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.
Type annotations and code completion for boto3.client("backup-gateway").test_hypervisor_configuration
method.
boto3 documentation
def test_hypervisor_configuration(
self,
*,
GatewayArn: str,
Host: str,
Password: str = ...,
Username: str = ...,
) -> Dict[str, Any]:
...
kwargs: TestHypervisorConfigurationInputRequestTypeDef = { # (1)
"GatewayArn": ...,
"Host": ...,
}
parent.test_hypervisor_configuration(**kwargs)
untag_resource
Removes tags from the resource.
Type annotations and code completion for boto3.client("backup-gateway").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> UntagResourceOutputTypeDef: # (1)
...
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_gateway_information
Updates a gateway's name.
Type annotations and code completion for boto3.client("backup-gateway").update_gateway_information
method.
boto3 documentation
def update_gateway_information(
self,
*,
GatewayArn: str,
GatewayDisplayName: str = ...,
) -> UpdateGatewayInformationOutputTypeDef: # (1)
...
kwargs: UpdateGatewayInformationInputRequestTypeDef = { # (1)
"GatewayArn": ...,
}
parent.update_gateway_information(**kwargs)
update_gateway_software_now
Updates the gateway virtual machine (VM) software.
Type annotations and code completion for boto3.client("backup-gateway").update_gateway_software_now
method.
boto3 documentation
def update_gateway_software_now(
self,
*,
GatewayArn: str,
) -> UpdateGatewaySoftwareNowOutputTypeDef: # (1)
...
kwargs: UpdateGatewaySoftwareNowInputRequestTypeDef = { # (1)
"GatewayArn": ...,
}
parent.update_gateway_software_now(**kwargs)
update_hypervisor
Updates a hypervisor metadata, including its host, username, and password.
Type annotations and code completion for boto3.client("backup-gateway").update_hypervisor
method.
boto3 documentation
def update_hypervisor(
self,
*,
HypervisorArn: str,
Host: str = ...,
LogGroupArn: str = ...,
Name: str = ...,
Password: str = ...,
Username: str = ...,
) -> UpdateHypervisorOutputTypeDef: # (1)
...
kwargs: UpdateHypervisorInputRequestTypeDef = { # (1)
"HypervisorArn": ...,
}
parent.update_hypervisor(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("backup-gateway").get_paginator
method with overloads.
client.get_paginator("list_gateways")
-> ListGatewaysPaginatorclient.get_paginator("list_hypervisors")
-> ListHypervisorsPaginatorclient.get_paginator("list_virtual_machines")
-> ListVirtualMachinesPaginator