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
# BackupGatewayClient usage example
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.
# 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 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
# associate_gateway_to_server method definition
def associate_gateway_to_server(
self,
*,
GatewayArn: str,
ServerArn: str,
) -> AssociateGatewayToServerOutputTypeDef: # (1)
...# associate_gateway_to_server method usage example with argument unpacking
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
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("backup-gateway").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...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)
...- See GatewayTypeType
- See TagTypeDef
- See CreateGatewayOutputTypeDef
# create_gateway method usage example with argument unpacking
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
# delete_gateway method definition
def delete_gateway(
self,
*,
GatewayArn: str,
) -> DeleteGatewayOutputTypeDef: # (1)
...# delete_gateway method usage example with argument unpacking
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
# delete_hypervisor method definition
def delete_hypervisor(
self,
*,
HypervisorArn: str,
) -> DeleteHypervisorOutputTypeDef: # (1)
...# delete_hypervisor method usage example with argument unpacking
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
# disassociate_gateway_from_server method definition
def disassociate_gateway_from_server(
self,
*,
GatewayArn: str,
) -> DisassociateGatewayFromServerOutputTypeDef: # (1)
...# disassociate_gateway_from_server method usage example with argument unpacking
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
# generate_presigned_url method definition
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
# get_bandwidth_rate_limit_schedule method definition
def get_bandwidth_rate_limit_schedule(
self,
*,
GatewayArn: str,
) -> GetBandwidthRateLimitScheduleOutputTypeDef: # (1)
...# get_bandwidth_rate_limit_schedule method usage example with argument unpacking
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
# get_gateway method definition
def get_gateway(
self,
*,
GatewayArn: str,
) -> GetGatewayOutputTypeDef: # (1)
...# get_gateway method usage example with argument unpacking
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
# get_hypervisor method definition
def get_hypervisor(
self,
*,
HypervisorArn: str,
) -> GetHypervisorOutputTypeDef: # (1)
...# get_hypervisor method usage example with argument unpacking
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
# get_hypervisor_property_mappings method definition
def get_hypervisor_property_mappings(
self,
*,
HypervisorArn: str,
) -> GetHypervisorPropertyMappingsOutputTypeDef: # (1)
...# get_hypervisor_property_mappings method usage example with argument unpacking
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
# get_virtual_machine method definition
def get_virtual_machine(
self,
*,
ResourceArn: str,
) -> GetVirtualMachineOutputTypeDef: # (1)
...# get_virtual_machine method usage example with argument unpacking
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
# 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)
...# import_hypervisor_configuration method usage example with argument unpacking
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
# list_gateways method definition
def list_gateways(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListGatewaysOutputTypeDef: # (1)
...# list_gateways method usage example with argument unpacking
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
# list_hypervisors method definition
def list_hypervisors(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListHypervisorsOutputTypeDef: # (1)
...# list_hypervisors method usage example with argument unpacking
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
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
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.