Type definitions#
Index > BackupGateway > Type definitions
Auto-generated documentation for BackupGateway type annotations stubs module mypy-boto3-backup-gateway.
AssociateGatewayToServerInputRequestTypeDef#
# AssociateGatewayToServerInputRequestTypeDef definition
class AssociateGatewayToServerInputRequestTypeDef(TypedDict):
GatewayArn: str,
ServerArn: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
BandwidthRateLimitIntervalTypeDef#
# BandwidthRateLimitIntervalTypeDef definition
class BandwidthRateLimitIntervalTypeDef(TypedDict):
DaysOfWeek: List[int],
EndHourOfDay: int,
EndMinuteOfHour: int,
StartHourOfDay: int,
StartMinuteOfHour: int,
AverageUploadRateLimitInBitsPerSec: NotRequired[int],
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
DeleteGatewayInputRequestTypeDef#
# DeleteGatewayInputRequestTypeDef definition
class DeleteGatewayInputRequestTypeDef(TypedDict):
GatewayArn: str,
DeleteHypervisorInputRequestTypeDef#
# DeleteHypervisorInputRequestTypeDef definition
class DeleteHypervisorInputRequestTypeDef(TypedDict):
HypervisorArn: str,
DisassociateGatewayFromServerInputRequestTypeDef#
# DisassociateGatewayFromServerInputRequestTypeDef definition
class DisassociateGatewayFromServerInputRequestTypeDef(TypedDict):
GatewayArn: str,
MaintenanceStartTimeTypeDef#
# MaintenanceStartTimeTypeDef definition
class MaintenanceStartTimeTypeDef(TypedDict):
HourOfDay: int,
MinuteOfHour: int,
DayOfMonth: NotRequired[int],
DayOfWeek: NotRequired[int],
GatewayTypeDef#
# GatewayTypeDef definition
class GatewayTypeDef(TypedDict):
GatewayArn: NotRequired[str],
GatewayDisplayName: NotRequired[str],
GatewayType: NotRequired[GatewayTypeType], # (1)
HypervisorId: NotRequired[str],
LastSeenTime: NotRequired[datetime],
- See GatewayTypeType
GetBandwidthRateLimitScheduleInputRequestTypeDef#
# GetBandwidthRateLimitScheduleInputRequestTypeDef definition
class GetBandwidthRateLimitScheduleInputRequestTypeDef(TypedDict):
GatewayArn: str,
GetGatewayInputRequestTypeDef#
# GetGatewayInputRequestTypeDef definition
class GetGatewayInputRequestTypeDef(TypedDict):
GatewayArn: str,
GetHypervisorInputRequestTypeDef#
# GetHypervisorInputRequestTypeDef definition
class GetHypervisorInputRequestTypeDef(TypedDict):
HypervisorArn: str,
HypervisorDetailsTypeDef#
# HypervisorDetailsTypeDef definition
class HypervisorDetailsTypeDef(TypedDict):
Host: NotRequired[str],
HypervisorArn: NotRequired[str],
KmsKeyArn: NotRequired[str],
LastSuccessfulMetadataSyncTime: NotRequired[datetime],
LatestMetadataSyncStatus: NotRequired[SyncMetadataStatusType], # (1)
LatestMetadataSyncStatusMessage: NotRequired[str],
LogGroupArn: NotRequired[str],
Name: NotRequired[str],
State: NotRequired[HypervisorStateType], # (2)
GetHypervisorPropertyMappingsInputRequestTypeDef#
# GetHypervisorPropertyMappingsInputRequestTypeDef definition
class GetHypervisorPropertyMappingsInputRequestTypeDef(TypedDict):
HypervisorArn: str,
VmwareToAwsTagMappingTypeDef#
# VmwareToAwsTagMappingTypeDef definition
class VmwareToAwsTagMappingTypeDef(TypedDict):
AwsTagKey: str,
AwsTagValue: str,
VmwareCategory: str,
VmwareTagName: str,
GetVirtualMachineInputRequestTypeDef#
# GetVirtualMachineInputRequestTypeDef definition
class GetVirtualMachineInputRequestTypeDef(TypedDict):
ResourceArn: str,
HypervisorTypeDef#
# HypervisorTypeDef definition
class HypervisorTypeDef(TypedDict):
Host: NotRequired[str],
HypervisorArn: NotRequired[str],
KmsKeyArn: NotRequired[str],
Name: NotRequired[str],
State: NotRequired[HypervisorStateType], # (1)
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListGatewaysInputRequestTypeDef#
# ListGatewaysInputRequestTypeDef definition
class ListGatewaysInputRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListHypervisorsInputRequestTypeDef#
# ListHypervisorsInputRequestTypeDef definition
class ListHypervisorsInputRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsForResourceInputRequestTypeDef#
# ListTagsForResourceInputRequestTypeDef definition
class ListTagsForResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
ListVirtualMachinesInputRequestTypeDef#
# ListVirtualMachinesInputRequestTypeDef definition
class ListVirtualMachinesInputRequestTypeDef(TypedDict):
HypervisorArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
VirtualMachineTypeDef#
# VirtualMachineTypeDef definition
class VirtualMachineTypeDef(TypedDict):
HostName: NotRequired[str],
HypervisorId: NotRequired[str],
LastBackupDate: NotRequired[datetime],
Name: NotRequired[str],
Path: NotRequired[str],
ResourceArn: NotRequired[str],
PutMaintenanceStartTimeInputRequestTypeDef#
# PutMaintenanceStartTimeInputRequestTypeDef definition
class PutMaintenanceStartTimeInputRequestTypeDef(TypedDict):
GatewayArn: str,
HourOfDay: int,
MinuteOfHour: int,
DayOfMonth: NotRequired[int],
DayOfWeek: NotRequired[int],
StartVirtualMachinesMetadataSyncInputRequestTypeDef#
# StartVirtualMachinesMetadataSyncInputRequestTypeDef definition
class StartVirtualMachinesMetadataSyncInputRequestTypeDef(TypedDict):
HypervisorArn: str,
TestHypervisorConfigurationInputRequestTypeDef#
# TestHypervisorConfigurationInputRequestTypeDef definition
class TestHypervisorConfigurationInputRequestTypeDef(TypedDict):
GatewayArn: str,
Host: str,
Password: NotRequired[str],
Username: NotRequired[str],
UntagResourceInputRequestTypeDef#
# UntagResourceInputRequestTypeDef definition
class UntagResourceInputRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateGatewayInformationInputRequestTypeDef#
# UpdateGatewayInformationInputRequestTypeDef definition
class UpdateGatewayInformationInputRequestTypeDef(TypedDict):
GatewayArn: str,
GatewayDisplayName: NotRequired[str],
UpdateGatewaySoftwareNowInputRequestTypeDef#
# UpdateGatewaySoftwareNowInputRequestTypeDef definition
class UpdateGatewaySoftwareNowInputRequestTypeDef(TypedDict):
GatewayArn: str,
UpdateHypervisorInputRequestTypeDef#
# UpdateHypervisorInputRequestTypeDef definition
class UpdateHypervisorInputRequestTypeDef(TypedDict):
HypervisorArn: str,
Host: NotRequired[str],
LogGroupArn: NotRequired[str],
Name: NotRequired[str],
Password: NotRequired[str],
Username: NotRequired[str],
VmwareTagTypeDef#
# VmwareTagTypeDef definition
class VmwareTagTypeDef(TypedDict):
VmwareCategory: NotRequired[str],
VmwareTagDescription: NotRequired[str],
VmwareTagName: NotRequired[str],
AssociateGatewayToServerOutputTypeDef#
# AssociateGatewayToServerOutputTypeDef definition
class AssociateGatewayToServerOutputTypeDef(TypedDict):
GatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateGatewayOutputTypeDef#
# CreateGatewayOutputTypeDef definition
class CreateGatewayOutputTypeDef(TypedDict):
GatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteGatewayOutputTypeDef#
# DeleteGatewayOutputTypeDef definition
class DeleteGatewayOutputTypeDef(TypedDict):
GatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteHypervisorOutputTypeDef#
# DeleteHypervisorOutputTypeDef definition
class DeleteHypervisorOutputTypeDef(TypedDict):
HypervisorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DisassociateGatewayFromServerOutputTypeDef#
# DisassociateGatewayFromServerOutputTypeDef definition
class DisassociateGatewayFromServerOutputTypeDef(TypedDict):
GatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ImportHypervisorConfigurationOutputTypeDef#
# ImportHypervisorConfigurationOutputTypeDef definition
class ImportHypervisorConfigurationOutputTypeDef(TypedDict):
HypervisorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutBandwidthRateLimitScheduleOutputTypeDef#
# PutBandwidthRateLimitScheduleOutputTypeDef definition
class PutBandwidthRateLimitScheduleOutputTypeDef(TypedDict):
GatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutHypervisorPropertyMappingsOutputTypeDef#
# PutHypervisorPropertyMappingsOutputTypeDef definition
class PutHypervisorPropertyMappingsOutputTypeDef(TypedDict):
HypervisorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PutMaintenanceStartTimeOutputTypeDef#
# PutMaintenanceStartTimeOutputTypeDef definition
class PutMaintenanceStartTimeOutputTypeDef(TypedDict):
GatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartVirtualMachinesMetadataSyncOutputTypeDef#
# StartVirtualMachinesMetadataSyncOutputTypeDef definition
class StartVirtualMachinesMetadataSyncOutputTypeDef(TypedDict):
HypervisorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TagResourceOutputTypeDef#
# TagResourceOutputTypeDef definition
class TagResourceOutputTypeDef(TypedDict):
ResourceARN: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UntagResourceOutputTypeDef#
# UntagResourceOutputTypeDef definition
class UntagResourceOutputTypeDef(TypedDict):
ResourceARN: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateGatewayInformationOutputTypeDef#
# UpdateGatewayInformationOutputTypeDef definition
class UpdateGatewayInformationOutputTypeDef(TypedDict):
GatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateGatewaySoftwareNowOutputTypeDef#
# UpdateGatewaySoftwareNowOutputTypeDef definition
class UpdateGatewaySoftwareNowOutputTypeDef(TypedDict):
GatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateHypervisorOutputTypeDef#
# UpdateHypervisorOutputTypeDef definition
class UpdateHypervisorOutputTypeDef(TypedDict):
HypervisorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBandwidthRateLimitScheduleOutputTypeDef#
# GetBandwidthRateLimitScheduleOutputTypeDef definition
class GetBandwidthRateLimitScheduleOutputTypeDef(TypedDict):
BandwidthRateLimitIntervals: List[BandwidthRateLimitIntervalTypeDef], # (1)
GatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutBandwidthRateLimitScheduleInputRequestTypeDef#
# PutBandwidthRateLimitScheduleInputRequestTypeDef definition
class PutBandwidthRateLimitScheduleInputRequestTypeDef(TypedDict):
BandwidthRateLimitIntervals: Sequence[BandwidthRateLimitIntervalTypeDef], # (1)
GatewayArn: str,
CreateGatewayInputRequestTypeDef#
# CreateGatewayInputRequestTypeDef definition
class CreateGatewayInputRequestTypeDef(TypedDict):
ActivationKey: str,
GatewayDisplayName: str,
GatewayType: GatewayTypeType, # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See GatewayTypeType
- See TagTypeDef
ImportHypervisorConfigurationInputRequestTypeDef#
# ImportHypervisorConfigurationInputRequestTypeDef definition
class ImportHypervisorConfigurationInputRequestTypeDef(TypedDict):
Host: str,
Name: str,
KmsKeyArn: NotRequired[str],
Password: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
Username: NotRequired[str],
- See TagTypeDef
ListTagsForResourceOutputTypeDef#
# ListTagsForResourceOutputTypeDef definition
class ListTagsForResourceOutputTypeDef(TypedDict):
ResourceArn: str,
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceInputRequestTypeDef#
# TagResourceInputRequestTypeDef definition
class TagResourceInputRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
GatewayDetailsTypeDef#
# GatewayDetailsTypeDef definition
class GatewayDetailsTypeDef(TypedDict):
GatewayArn: NotRequired[str],
GatewayDisplayName: NotRequired[str],
GatewayType: NotRequired[GatewayTypeType], # (1)
HypervisorId: NotRequired[str],
LastSeenTime: NotRequired[datetime],
MaintenanceStartTime: NotRequired[MaintenanceStartTimeTypeDef], # (2)
NextUpdateAvailabilityTime: NotRequired[datetime],
VpcEndpoint: NotRequired[str],
ListGatewaysOutputTypeDef#
# ListGatewaysOutputTypeDef definition
class ListGatewaysOutputTypeDef(TypedDict):
Gateways: List[GatewayTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetHypervisorOutputTypeDef#
# GetHypervisorOutputTypeDef definition
class GetHypervisorOutputTypeDef(TypedDict):
Hypervisor: HypervisorDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetHypervisorPropertyMappingsOutputTypeDef#
# GetHypervisorPropertyMappingsOutputTypeDef definition
class GetHypervisorPropertyMappingsOutputTypeDef(TypedDict):
HypervisorArn: str,
IamRoleArn: str,
VmwareToAwsTagMappings: List[VmwareToAwsTagMappingTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutHypervisorPropertyMappingsInputRequestTypeDef#
# PutHypervisorPropertyMappingsInputRequestTypeDef definition
class PutHypervisorPropertyMappingsInputRequestTypeDef(TypedDict):
HypervisorArn: str,
IamRoleArn: str,
VmwareToAwsTagMappings: Sequence[VmwareToAwsTagMappingTypeDef], # (1)
ListHypervisorsOutputTypeDef#
# ListHypervisorsOutputTypeDef definition
class ListHypervisorsOutputTypeDef(TypedDict):
Hypervisors: List[HypervisorTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListGatewaysInputListGatewaysPaginateTypeDef#
# ListGatewaysInputListGatewaysPaginateTypeDef definition
class ListGatewaysInputListGatewaysPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListHypervisorsInputListHypervisorsPaginateTypeDef#
# ListHypervisorsInputListHypervisorsPaginateTypeDef definition
class ListHypervisorsInputListHypervisorsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListVirtualMachinesInputListVirtualMachinesPaginateTypeDef#
# ListVirtualMachinesInputListVirtualMachinesPaginateTypeDef definition
class ListVirtualMachinesInputListVirtualMachinesPaginateTypeDef(TypedDict):
HypervisorArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListVirtualMachinesOutputTypeDef#
# ListVirtualMachinesOutputTypeDef definition
class ListVirtualMachinesOutputTypeDef(TypedDict):
NextToken: str,
VirtualMachines: List[VirtualMachineTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
VirtualMachineDetailsTypeDef#
# VirtualMachineDetailsTypeDef definition
class VirtualMachineDetailsTypeDef(TypedDict):
HostName: NotRequired[str],
HypervisorId: NotRequired[str],
LastBackupDate: NotRequired[datetime],
Name: NotRequired[str],
Path: NotRequired[str],
ResourceArn: NotRequired[str],
VmwareTags: NotRequired[List[VmwareTagTypeDef]], # (1)
- See VmwareTagTypeDef
GetGatewayOutputTypeDef#
# GetGatewayOutputTypeDef definition
class GetGatewayOutputTypeDef(TypedDict):
Gateway: GatewayDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetVirtualMachineOutputTypeDef#
# GetVirtualMachineOutputTypeDef definition
class GetVirtualMachineOutputTypeDef(TypedDict):
VirtualMachine: VirtualMachineDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)