Skip to content

BackupGatewayClient#

Index > BackupGateway > BackupGatewayClient

Auto-generated documentation for BackupGateway type annotations stubs module types-boto3-backup-gateway.

BackupGatewayClient#

Type annotations and code completion for boto3.client("backup-gateway"). boto3 documentation

# BackupGatewayClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("backup-gateway")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_backup_gateway.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("backup-gateway").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("backup-gateway").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

# associate_gateway_to_server method definition

def associate_gateway_to_server(
    self,
    *,
    GatewayArn: str,
    ServerArn: str,
) -> AssociateGatewayToServerOutputTypeDef:  # (1)
    ...
  1. See AssociateGatewayToServerOutputTypeDef 
# associate_gateway_to_server method usage example with argument unpacking

kwargs: AssociateGatewayToServerInputRequestTypeDef = {  # (1)
    "GatewayArn": ...,
    "ServerArn": ...,
}

parent.associate_gateway_to_server(**kwargs)
  1. See AssociateGatewayToServerInputRequestTypeDef

create_gateway#

Creates a backup gateway.

Type annotations and code completion for boto3.client("backup-gateway").create_gateway method. boto3 documentation

# create_gateway method definition

def create_gateway(
    self,
    *,
    ActivationKey: str,
    GatewayDisplayName: str,
    GatewayType: GatewayTypeType,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateGatewayOutputTypeDef:  # (3)
    ...
  1. See GatewayTypeType
  2. See TagTypeDef
  3. See CreateGatewayOutputTypeDef 
# create_gateway method usage example with argument unpacking

kwargs: CreateGatewayInputRequestTypeDef = {  # (1)
    "ActivationKey": ...,
    "GatewayDisplayName": ...,
    "GatewayType": ...,
}

parent.create_gateway(**kwargs)
  1. See CreateGatewayInputRequestTypeDef

delete_gateway#

Deletes a backup gateway.

Type annotations and code completion for boto3.client("backup-gateway").delete_gateway method. boto3 documentation

# delete_gateway method definition

def delete_gateway(
    self,
    *,
    GatewayArn: str,
) -> DeleteGatewayOutputTypeDef:  # (1)
    ...
  1. See DeleteGatewayOutputTypeDef 
# delete_gateway method usage example with argument unpacking

kwargs: DeleteGatewayInputRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.delete_gateway(**kwargs)
  1. See DeleteGatewayInputRequestTypeDef

delete_hypervisor#

Deletes a hypervisor.

Type annotations and code completion for boto3.client("backup-gateway").delete_hypervisor method. boto3 documentation

# delete_hypervisor method definition

def delete_hypervisor(
    self,
    *,
    HypervisorArn: str,
) -> DeleteHypervisorOutputTypeDef:  # (1)
    ...
  1. See DeleteHypervisorOutputTypeDef 
# delete_hypervisor method usage example with argument unpacking

kwargs: DeleteHypervisorInputRequestTypeDef = {  # (1)
    "HypervisorArn": ...,
}

parent.delete_hypervisor(**kwargs)
  1. See DeleteHypervisorInputRequestTypeDef

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

# disassociate_gateway_from_server method definition

def disassociate_gateway_from_server(
    self,
    *,
    GatewayArn: str,
) -> DisassociateGatewayFromServerOutputTypeDef:  # (1)
    ...
  1. See DisassociateGatewayFromServerOutputTypeDef 
# disassociate_gateway_from_server method usage example with argument unpacking

kwargs: DisassociateGatewayFromServerInputRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.disassociate_gateway_from_server(**kwargs)
  1. See DisassociateGatewayFromServerInputRequestTypeDef

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

# get_bandwidth_rate_limit_schedule method definition

def get_bandwidth_rate_limit_schedule(
    self,
    *,
    GatewayArn: str,
) -> GetBandwidthRateLimitScheduleOutputTypeDef:  # (1)
    ...
  1. See GetBandwidthRateLimitScheduleOutputTypeDef 
# get_bandwidth_rate_limit_schedule method usage example with argument unpacking

kwargs: GetBandwidthRateLimitScheduleInputRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.get_bandwidth_rate_limit_schedule(**kwargs)
  1. See GetBandwidthRateLimitScheduleInputRequestTypeDef

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

# get_gateway method definition

def get_gateway(
    self,
    *,
    GatewayArn: str,
) -> GetGatewayOutputTypeDef:  # (1)
    ...
  1. See GetGatewayOutputTypeDef 
# get_gateway method usage example with argument unpacking

kwargs: GetGatewayInputRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.get_gateway(**kwargs)
  1. See GetGatewayInputRequestTypeDef

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

# get_hypervisor method definition

def get_hypervisor(
    self,
    *,
    HypervisorArn: str,
) -> GetHypervisorOutputTypeDef:  # (1)
    ...
  1. See GetHypervisorOutputTypeDef 
# get_hypervisor method usage example with argument unpacking

kwargs: GetHypervisorInputRequestTypeDef = {  # (1)
    "HypervisorArn": ...,
}

parent.get_hypervisor(**kwargs)
  1. See GetHypervisorInputRequestTypeDef

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

# get_hypervisor_property_mappings method definition

def get_hypervisor_property_mappings(
    self,
    *,
    HypervisorArn: str,
) -> GetHypervisorPropertyMappingsOutputTypeDef:  # (1)
    ...
  1. See GetHypervisorPropertyMappingsOutputTypeDef 
# get_hypervisor_property_mappings method usage example with argument unpacking

kwargs: GetHypervisorPropertyMappingsInputRequestTypeDef = {  # (1)
    "HypervisorArn": ...,
}

parent.get_hypervisor_property_mappings(**kwargs)
  1. See GetHypervisorPropertyMappingsInputRequestTypeDef

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

# get_virtual_machine method definition

def get_virtual_machine(
    self,
    *,
    ResourceArn: str,
) -> GetVirtualMachineOutputTypeDef:  # (1)
    ...
  1. See GetVirtualMachineOutputTypeDef 
# get_virtual_machine method usage example with argument unpacking

kwargs: GetVirtualMachineInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_virtual_machine(**kwargs)
  1. See GetVirtualMachineInputRequestTypeDef

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

# import_hypervisor_configuration method definition

def import_hypervisor_configuration(
    self,
    *,
    Host: str,
    Name: str,
    KmsKeyArn: str = ...,
    Password: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    Username: str = ...,
) -> ImportHypervisorConfigurationOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See ImportHypervisorConfigurationOutputTypeDef 
# import_hypervisor_configuration method usage example with argument unpacking

kwargs: ImportHypervisorConfigurationInputRequestTypeDef = {  # (1)
    "Host": ...,
    "Name": ...,
}

parent.import_hypervisor_configuration(**kwargs)
  1. See ImportHypervisorConfigurationInputRequestTypeDef

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

# list_gateways method definition

def list_gateways(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGatewaysOutputTypeDef:  # (1)
    ...
  1. See ListGatewaysOutputTypeDef 
# list_gateways method usage example with argument unpacking

kwargs: ListGatewaysInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_gateways(**kwargs)
  1. See ListGatewaysInputRequestTypeDef

list_hypervisors#

Lists your hypervisors.

Type annotations and code completion for boto3.client("backup-gateway").list_hypervisors method. boto3 documentation

# list_hypervisors method definition

def list_hypervisors(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHypervisorsOutputTypeDef:  # (1)
    ...
  1. See ListHypervisorsOutputTypeDef 
# list_hypervisors method usage example with argument unpacking

kwargs: ListHypervisorsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_hypervisors(**kwargs)
  1. See ListHypervisorsInputRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

list_virtual_machines#

Lists your virtual machines.

Type annotations and code completion for boto3.client("backup-gateway").list_virtual_machines method. boto3 documentation

# list_virtual_machines method definition

def list_virtual_machines(
    self,
    *,
    HypervisorArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListVirtualMachinesOutputTypeDef:  # (1)
    ...
  1. See ListVirtualMachinesOutputTypeDef 
# list_virtual_machines method usage example with argument unpacking

kwargs: ListVirtualMachinesInputRequestTypeDef = {  # (1)
    "HypervisorArn": ...,
}

parent.list_virtual_machines(**kwargs)
  1. See ListVirtualMachinesInputRequestTypeDef

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

# put_bandwidth_rate_limit_schedule method definition

def put_bandwidth_rate_limit_schedule(
    self,
    *,
    BandwidthRateLimitIntervals: Sequence[BandwidthRateLimitIntervalUnionTypeDef],  # (1)
    GatewayArn: str,
) -> PutBandwidthRateLimitScheduleOutputTypeDef:  # (2)
    ...
  1. See BandwidthRateLimitIntervalTypeDef BandwidthRateLimitIntervalOutputTypeDef
  2. See PutBandwidthRateLimitScheduleOutputTypeDef 
# put_bandwidth_rate_limit_schedule method usage example with argument unpacking

kwargs: PutBandwidthRateLimitScheduleInputRequestTypeDef = {  # (1)
    "BandwidthRateLimitIntervals": ...,
    "GatewayArn": ...,
}

parent.put_bandwidth_rate_limit_schedule(**kwargs)
  1. See PutBandwidthRateLimitScheduleInputRequestTypeDef

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

# put_hypervisor_property_mappings method definition

def put_hypervisor_property_mappings(
    self,
    *,
    HypervisorArn: str,
    IamRoleArn: str,
    VmwareToAwsTagMappings: Sequence[VmwareToAwsTagMappingTypeDef],  # (1)
) -> PutHypervisorPropertyMappingsOutputTypeDef:  # (2)
    ...
  1. See VmwareToAwsTagMappingTypeDef
  2. See PutHypervisorPropertyMappingsOutputTypeDef 
# put_hypervisor_property_mappings method usage example with argument unpacking

kwargs: PutHypervisorPropertyMappingsInputRequestTypeDef = {  # (1)
    "HypervisorArn": ...,
    "IamRoleArn": ...,
    "VmwareToAwsTagMappings": ...,
}

parent.put_hypervisor_property_mappings(**kwargs)
  1. See PutHypervisorPropertyMappingsInputRequestTypeDef

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

# put_maintenance_start_time method definition

def put_maintenance_start_time(
    self,
    *,
    GatewayArn: str,
    HourOfDay: int,
    MinuteOfHour: int,
    DayOfMonth: int = ...,
    DayOfWeek: int = ...,
) -> PutMaintenanceStartTimeOutputTypeDef:  # (1)
    ...
  1. See PutMaintenanceStartTimeOutputTypeDef 
# put_maintenance_start_time method usage example with argument unpacking

kwargs: PutMaintenanceStartTimeInputRequestTypeDef = {  # (1)
    "GatewayArn": ...,
    "HourOfDay": ...,
    "MinuteOfHour": ...,
}

parent.put_maintenance_start_time(**kwargs)
  1. See PutMaintenanceStartTimeInputRequestTypeDef

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

# start_virtual_machines_metadata_sync method definition

def start_virtual_machines_metadata_sync(
    self,
    *,
    HypervisorArn: str,
) -> StartVirtualMachinesMetadataSyncOutputTypeDef:  # (1)
    ...
  1. See StartVirtualMachinesMetadataSyncOutputTypeDef 
# start_virtual_machines_metadata_sync method usage example with argument unpacking

kwargs: StartVirtualMachinesMetadataSyncInputRequestTypeDef = {  # (1)
    "HypervisorArn": ...,
}

parent.start_virtual_machines_metadata_sync(**kwargs)
  1. See StartVirtualMachinesMetadataSyncInputRequestTypeDef

tag_resource#

Tag the resource.

Type annotations and code completion for boto3.client("backup-gateway").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> TagResourceOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See TagResourceOutputTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

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

# test_hypervisor_configuration method definition

def test_hypervisor_configuration(
    self,
    *,
    GatewayArn: str,
    Host: str,
    Password: str = ...,
    Username: str = ...,
) -> dict[str, Any]:
    ...
# test_hypervisor_configuration method usage example with argument unpacking

kwargs: TestHypervisorConfigurationInputRequestTypeDef = {  # (1)
    "GatewayArn": ...,
    "Host": ...,
}

parent.test_hypervisor_configuration(**kwargs)
  1. See TestHypervisorConfigurationInputRequestTypeDef

untag_resource#

Removes tags from the resource.

Type annotations and code completion for boto3.client("backup-gateway").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> UntagResourceOutputTypeDef:  # (1)
    ...
  1. See UntagResourceOutputTypeDef 
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

update_gateway_information#

Updates a gateway's name.

Type annotations and code completion for boto3.client("backup-gateway").update_gateway_information method. boto3 documentation

# update_gateway_information method definition

def update_gateway_information(
    self,
    *,
    GatewayArn: str,
    GatewayDisplayName: str = ...,
) -> UpdateGatewayInformationOutputTypeDef:  # (1)
    ...
  1. See UpdateGatewayInformationOutputTypeDef 
# update_gateway_information method usage example with argument unpacking

kwargs: UpdateGatewayInformationInputRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.update_gateway_information(**kwargs)
  1. See UpdateGatewayInformationInputRequestTypeDef

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

# update_gateway_software_now method definition

def update_gateway_software_now(
    self,
    *,
    GatewayArn: str,
) -> UpdateGatewaySoftwareNowOutputTypeDef:  # (1)
    ...
  1. See UpdateGatewaySoftwareNowOutputTypeDef 
# update_gateway_software_now method usage example with argument unpacking

kwargs: UpdateGatewaySoftwareNowInputRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.update_gateway_software_now(**kwargs)
  1. See UpdateGatewaySoftwareNowInputRequestTypeDef

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

# update_hypervisor method definition

def update_hypervisor(
    self,
    *,
    HypervisorArn: str,
    Host: str = ...,
    LogGroupArn: str = ...,
    Name: str = ...,
    Password: str = ...,
    Username: str = ...,
) -> UpdateHypervisorOutputTypeDef:  # (1)
    ...
  1. See UpdateHypervisorOutputTypeDef 
# update_hypervisor method usage example with argument unpacking

kwargs: UpdateHypervisorInputRequestTypeDef = {  # (1)
    "HypervisorArn": ...,
}

parent.update_hypervisor(**kwargs)
  1. See UpdateHypervisorInputRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("backup-gateway").get_paginator method with overloads.