Skip to content

Type definitions#

Index > BackupGateway > Type definitions

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

BandwidthRateLimitIntervalUnionTypeDef#

# BandwidthRateLimitIntervalUnionTypeDef definition

BandwidthRateLimitIntervalUnionTypeDef = Union[
    BandwidthRateLimitIntervalTypeDef,  # (1)
    BandwidthRateLimitIntervalOutputTypeDef,  # (2)
]
  1. See BandwidthRateLimitIntervalTypeDef
  2. See BandwidthRateLimitIntervalOutputTypeDef

AssociateGatewayToServerInputRequestTypeDef#

# AssociateGatewayToServerInputRequestTypeDef definition

class AssociateGatewayToServerInputRequestTypeDef(TypedDict):
    GatewayArn: str,
    ServerArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BandwidthRateLimitIntervalOutputTypeDef#

# BandwidthRateLimitIntervalOutputTypeDef definition

class BandwidthRateLimitIntervalOutputTypeDef(TypedDict):
    DaysOfWeek: List[int],
    EndHourOfDay: int,
    EndMinuteOfHour: int,
    StartHourOfDay: int,
    StartMinuteOfHour: int,
    AverageUploadRateLimitInBitsPerSec: NotRequired[int],

BandwidthRateLimitIntervalTypeDef#

# BandwidthRateLimitIntervalTypeDef definition

class BandwidthRateLimitIntervalTypeDef(TypedDict):
    DaysOfWeek: Sequence[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],
  1. 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)
  1. See SyncMetadataStatusType
  2. See HypervisorStateType

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)
  1. See HypervisorStateType

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)
  1. See ResponseMetadataTypeDef

CreateGatewayOutputTypeDef#

# CreateGatewayOutputTypeDef definition

class CreateGatewayOutputTypeDef(TypedDict):
    GatewayArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteGatewayOutputTypeDef#

# DeleteGatewayOutputTypeDef definition

class DeleteGatewayOutputTypeDef(TypedDict):
    GatewayArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteHypervisorOutputTypeDef#

# DeleteHypervisorOutputTypeDef definition

class DeleteHypervisorOutputTypeDef(TypedDict):
    HypervisorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisassociateGatewayFromServerOutputTypeDef#

# DisassociateGatewayFromServerOutputTypeDef definition

class DisassociateGatewayFromServerOutputTypeDef(TypedDict):
    GatewayArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ImportHypervisorConfigurationOutputTypeDef#

# ImportHypervisorConfigurationOutputTypeDef definition

class ImportHypervisorConfigurationOutputTypeDef(TypedDict):
    HypervisorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutBandwidthRateLimitScheduleOutputTypeDef#

# PutBandwidthRateLimitScheduleOutputTypeDef definition

class PutBandwidthRateLimitScheduleOutputTypeDef(TypedDict):
    GatewayArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutHypervisorPropertyMappingsOutputTypeDef#

# PutHypervisorPropertyMappingsOutputTypeDef definition

class PutHypervisorPropertyMappingsOutputTypeDef(TypedDict):
    HypervisorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutMaintenanceStartTimeOutputTypeDef#

# PutMaintenanceStartTimeOutputTypeDef definition

class PutMaintenanceStartTimeOutputTypeDef(TypedDict):
    GatewayArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartVirtualMachinesMetadataSyncOutputTypeDef#

# StartVirtualMachinesMetadataSyncOutputTypeDef definition

class StartVirtualMachinesMetadataSyncOutputTypeDef(TypedDict):
    HypervisorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagResourceOutputTypeDef#

# TagResourceOutputTypeDef definition

class TagResourceOutputTypeDef(TypedDict):
    ResourceARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UntagResourceOutputTypeDef#

# UntagResourceOutputTypeDef definition

class UntagResourceOutputTypeDef(TypedDict):
    ResourceARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateGatewayInformationOutputTypeDef#

# UpdateGatewayInformationOutputTypeDef definition

class UpdateGatewayInformationOutputTypeDef(TypedDict):
    GatewayArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateGatewaySoftwareNowOutputTypeDef#

# UpdateGatewaySoftwareNowOutputTypeDef definition

class UpdateGatewaySoftwareNowOutputTypeDef(TypedDict):
    GatewayArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateHypervisorOutputTypeDef#

# UpdateHypervisorOutputTypeDef definition

class UpdateHypervisorOutputTypeDef(TypedDict):
    HypervisorArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetBandwidthRateLimitScheduleOutputTypeDef#

# GetBandwidthRateLimitScheduleOutputTypeDef definition

class GetBandwidthRateLimitScheduleOutputTypeDef(TypedDict):
    BandwidthRateLimitIntervals: List[BandwidthRateLimitIntervalOutputTypeDef],  # (1)
    GatewayArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BandwidthRateLimitIntervalOutputTypeDef
  2. See ResponseMetadataTypeDef

CreateGatewayInputRequestTypeDef#

# CreateGatewayInputRequestTypeDef definition

class CreateGatewayInputRequestTypeDef(TypedDict):
    ActivationKey: str,
    GatewayDisplayName: str,
    GatewayType: GatewayTypeType,  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See GatewayTypeType
  2. 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],
  1. See TagTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    ResourceArn: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  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],
  1. See GatewayTypeType
  2. See MaintenanceStartTimeTypeDef

ListGatewaysOutputTypeDef#

# ListGatewaysOutputTypeDef definition

class ListGatewaysOutputTypeDef(TypedDict):
    Gateways: List[GatewayTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See GatewayTypeDef
  2. See ResponseMetadataTypeDef

GetHypervisorOutputTypeDef#

# GetHypervisorOutputTypeDef definition

class GetHypervisorOutputTypeDef(TypedDict):
    Hypervisor: HypervisorDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HypervisorDetailsTypeDef
  2. See ResponseMetadataTypeDef

GetHypervisorPropertyMappingsOutputTypeDef#

# GetHypervisorPropertyMappingsOutputTypeDef definition

class GetHypervisorPropertyMappingsOutputTypeDef(TypedDict):
    HypervisorArn: str,
    IamRoleArn: str,
    VmwareToAwsTagMappings: List[VmwareToAwsTagMappingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VmwareToAwsTagMappingTypeDef
  2. See ResponseMetadataTypeDef

PutHypervisorPropertyMappingsInputRequestTypeDef#

# PutHypervisorPropertyMappingsInputRequestTypeDef definition

class PutHypervisorPropertyMappingsInputRequestTypeDef(TypedDict):
    HypervisorArn: str,
    IamRoleArn: str,
    VmwareToAwsTagMappings: Sequence[VmwareToAwsTagMappingTypeDef],  # (1)
  1. See VmwareToAwsTagMappingTypeDef

ListHypervisorsOutputTypeDef#

# ListHypervisorsOutputTypeDef definition

class ListHypervisorsOutputTypeDef(TypedDict):
    Hypervisors: List[HypervisorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See HypervisorTypeDef
  2. See ResponseMetadataTypeDef

ListGatewaysInputListGatewaysPaginateTypeDef#

# ListGatewaysInputListGatewaysPaginateTypeDef definition

class ListGatewaysInputListGatewaysPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListHypervisorsInputListHypervisorsPaginateTypeDef#

# ListHypervisorsInputListHypervisorsPaginateTypeDef definition

class ListHypervisorsInputListHypervisorsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef