Skip to content

Type definitions#

Index > BackupGateway > Type definitions

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

BandwidthRateLimitIntervalUnionTypeDef#

# BandwidthRateLimitIntervalUnionTypeDef Union usage example

from mypy_boto3_backup_gateway.type_defs import BandwidthRateLimitIntervalUnionTypeDef


def get_value() -> BandwidthRateLimitIntervalUnionTypeDef:
    return ...


# BandwidthRateLimitIntervalUnionTypeDef definition

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

AssociateGatewayToServerInputTypeDef#

# AssociateGatewayToServerInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import AssociateGatewayToServerInputTypeDef


def get_value() -> AssociateGatewayToServerInputTypeDef:
    return {
        "GatewayArn": ...,
    }


# AssociateGatewayToServerInputTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

BandwidthRateLimitIntervalOutputTypeDef#

# BandwidthRateLimitIntervalOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import BandwidthRateLimitIntervalOutputTypeDef


def get_value() -> BandwidthRateLimitIntervalOutputTypeDef:
    return {
        "AverageUploadRateLimitInBitsPerSec": ...,
    }


# BandwidthRateLimitIntervalOutputTypeDef definition

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

BandwidthRateLimitIntervalTypeDef#

# BandwidthRateLimitIntervalTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import BandwidthRateLimitIntervalTypeDef


def get_value() -> BandwidthRateLimitIntervalTypeDef:
    return {
        "AverageUploadRateLimitInBitsPerSec": ...,
    }


# BandwidthRateLimitIntervalTypeDef definition

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

TagTypeDef#

# TagTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

DeleteGatewayInputTypeDef#

# DeleteGatewayInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import DeleteGatewayInputTypeDef


def get_value() -> DeleteGatewayInputTypeDef:
    return {
        "GatewayArn": ...,
    }


# DeleteGatewayInputTypeDef definition

class DeleteGatewayInputTypeDef(TypedDict):
    GatewayArn: str,

DeleteHypervisorInputTypeDef#

# DeleteHypervisorInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import DeleteHypervisorInputTypeDef


def get_value() -> DeleteHypervisorInputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# DeleteHypervisorInputTypeDef definition

class DeleteHypervisorInputTypeDef(TypedDict):
    HypervisorArn: str,

DisassociateGatewayFromServerInputTypeDef#

# DisassociateGatewayFromServerInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import DisassociateGatewayFromServerInputTypeDef


def get_value() -> DisassociateGatewayFromServerInputTypeDef:
    return {
        "GatewayArn": ...,
    }


# DisassociateGatewayFromServerInputTypeDef definition

class DisassociateGatewayFromServerInputTypeDef(TypedDict):
    GatewayArn: str,

MaintenanceStartTimeTypeDef#

# MaintenanceStartTimeTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import MaintenanceStartTimeTypeDef


def get_value() -> MaintenanceStartTimeTypeDef:
    return {
        "DayOfMonth": ...,
    }


# MaintenanceStartTimeTypeDef definition

class MaintenanceStartTimeTypeDef(TypedDict):
    HourOfDay: int,
    MinuteOfHour: int,
    DayOfMonth: NotRequired[int],
    DayOfWeek: NotRequired[int],

GatewayTypeDef#

# GatewayTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GatewayTypeDef


def get_value() -> GatewayTypeDef:
    return {
        "GatewayArn": ...,
    }


# GatewayTypeDef definition

class GatewayTypeDef(TypedDict):
    GatewayArn: NotRequired[str],
    GatewayDisplayName: NotRequired[str],
    GatewayType: NotRequired[GatewayTypeType],  # (1)
    HypervisorId: NotRequired[str],
    LastSeenTime: NotRequired[datetime.datetime],
  1. See GatewayTypeType

GetBandwidthRateLimitScheduleInputTypeDef#

# GetBandwidthRateLimitScheduleInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetBandwidthRateLimitScheduleInputTypeDef


def get_value() -> GetBandwidthRateLimitScheduleInputTypeDef:
    return {
        "GatewayArn": ...,
    }


# GetBandwidthRateLimitScheduleInputTypeDef definition

class GetBandwidthRateLimitScheduleInputTypeDef(TypedDict):
    GatewayArn: str,

GetGatewayInputTypeDef#

# GetGatewayInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetGatewayInputTypeDef


def get_value() -> GetGatewayInputTypeDef:
    return {
        "GatewayArn": ...,
    }


# GetGatewayInputTypeDef definition

class GetGatewayInputTypeDef(TypedDict):
    GatewayArn: str,

GetHypervisorInputTypeDef#

# GetHypervisorInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetHypervisorInputTypeDef


def get_value() -> GetHypervisorInputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# GetHypervisorInputTypeDef definition

class GetHypervisorInputTypeDef(TypedDict):
    HypervisorArn: str,

HypervisorDetailsTypeDef#

# HypervisorDetailsTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import HypervisorDetailsTypeDef


def get_value() -> HypervisorDetailsTypeDef:
    return {
        "Host": ...,
    }


# HypervisorDetailsTypeDef definition

class HypervisorDetailsTypeDef(TypedDict):
    Host: NotRequired[str],
    HypervisorArn: NotRequired[str],
    KmsKeyArn: NotRequired[str],
    LastSuccessfulMetadataSyncTime: NotRequired[datetime.datetime],
    LatestMetadataSyncStatus: NotRequired[SyncMetadataStatusType],  # (1)
    LatestMetadataSyncStatusMessage: NotRequired[str],
    LogGroupArn: NotRequired[str],
    Name: NotRequired[str],
    State: NotRequired[HypervisorStateType],  # (2)
  1. See SyncMetadataStatusType
  2. See HypervisorStateType

GetHypervisorPropertyMappingsInputTypeDef#

# GetHypervisorPropertyMappingsInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetHypervisorPropertyMappingsInputTypeDef


def get_value() -> GetHypervisorPropertyMappingsInputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# GetHypervisorPropertyMappingsInputTypeDef definition

class GetHypervisorPropertyMappingsInputTypeDef(TypedDict):
    HypervisorArn: str,

VmwareToAwsTagMappingTypeDef#

# VmwareToAwsTagMappingTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import VmwareToAwsTagMappingTypeDef


def get_value() -> VmwareToAwsTagMappingTypeDef:
    return {
        "AwsTagKey": ...,
    }


# VmwareToAwsTagMappingTypeDef definition

class VmwareToAwsTagMappingTypeDef(TypedDict):
    AwsTagKey: str,
    AwsTagValue: str,
    VmwareCategory: str,
    VmwareTagName: str,

GetVirtualMachineInputTypeDef#

# GetVirtualMachineInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetVirtualMachineInputTypeDef


def get_value() -> GetVirtualMachineInputTypeDef:
    return {
        "ResourceArn": ...,
    }


# GetVirtualMachineInputTypeDef definition

class GetVirtualMachineInputTypeDef(TypedDict):
    ResourceArn: str,

HypervisorTypeDef#

# HypervisorTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import HypervisorTypeDef


def get_value() -> HypervisorTypeDef:
    return {
        "Host": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListGatewaysInputTypeDef#

# ListGatewaysInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListGatewaysInputTypeDef


def get_value() -> ListGatewaysInputTypeDef:
    return {
        "MaxResults": ...,
    }


# ListGatewaysInputTypeDef definition

class ListGatewaysInputTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListHypervisorsInputTypeDef#

# ListHypervisorsInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListHypervisorsInputTypeDef


def get_value() -> ListHypervisorsInputTypeDef:
    return {
        "MaxResults": ...,
    }


# ListHypervisorsInputTypeDef definition

class ListHypervisorsInputTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceInputTypeDef#

# ListTagsForResourceInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListTagsForResourceInputTypeDef


def get_value() -> ListTagsForResourceInputTypeDef:
    return {
        "ResourceArn": ...,
    }


# ListTagsForResourceInputTypeDef definition

class ListTagsForResourceInputTypeDef(TypedDict):
    ResourceArn: str,

ListVirtualMachinesInputTypeDef#

# ListVirtualMachinesInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListVirtualMachinesInputTypeDef


def get_value() -> ListVirtualMachinesInputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# ListVirtualMachinesInputTypeDef definition

class ListVirtualMachinesInputTypeDef(TypedDict):
    HypervisorArn: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

VirtualMachineTypeDef#

# VirtualMachineTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import VirtualMachineTypeDef


def get_value() -> VirtualMachineTypeDef:
    return {
        "HostName": ...,
    }


# VirtualMachineTypeDef definition

class VirtualMachineTypeDef(TypedDict):
    HostName: NotRequired[str],
    HypervisorId: NotRequired[str],
    LastBackupDate: NotRequired[datetime.datetime],
    Name: NotRequired[str],
    Path: NotRequired[str],
    ResourceArn: NotRequired[str],

PutMaintenanceStartTimeInputTypeDef#

# PutMaintenanceStartTimeInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import PutMaintenanceStartTimeInputTypeDef


def get_value() -> PutMaintenanceStartTimeInputTypeDef:
    return {
        "GatewayArn": ...,
    }


# PutMaintenanceStartTimeInputTypeDef definition

class PutMaintenanceStartTimeInputTypeDef(TypedDict):
    GatewayArn: str,
    HourOfDay: int,
    MinuteOfHour: int,
    DayOfMonth: NotRequired[int],
    DayOfWeek: NotRequired[int],

StartVirtualMachinesMetadataSyncInputTypeDef#

# StartVirtualMachinesMetadataSyncInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import StartVirtualMachinesMetadataSyncInputTypeDef


def get_value() -> StartVirtualMachinesMetadataSyncInputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# StartVirtualMachinesMetadataSyncInputTypeDef definition

class StartVirtualMachinesMetadataSyncInputTypeDef(TypedDict):
    HypervisorArn: str,

TestHypervisorConfigurationInputTypeDef#

# TestHypervisorConfigurationInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import TestHypervisorConfigurationInputTypeDef


def get_value() -> TestHypervisorConfigurationInputTypeDef:
    return {
        "GatewayArn": ...,
    }


# TestHypervisorConfigurationInputTypeDef definition

class TestHypervisorConfigurationInputTypeDef(TypedDict):
    GatewayArn: str,
    Host: str,
    Password: NotRequired[str],
    Username: NotRequired[str],

UntagResourceInputTypeDef#

# UntagResourceInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import UntagResourceInputTypeDef


def get_value() -> UntagResourceInputTypeDef:
    return {
        "ResourceARN": ...,
    }


# UntagResourceInputTypeDef definition

class UntagResourceInputTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateGatewayInformationInputTypeDef#

# UpdateGatewayInformationInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import UpdateGatewayInformationInputTypeDef


def get_value() -> UpdateGatewayInformationInputTypeDef:
    return {
        "GatewayArn": ...,
    }


# UpdateGatewayInformationInputTypeDef definition

class UpdateGatewayInformationInputTypeDef(TypedDict):
    GatewayArn: str,
    GatewayDisplayName: NotRequired[str],

UpdateGatewaySoftwareNowInputTypeDef#

# UpdateGatewaySoftwareNowInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import UpdateGatewaySoftwareNowInputTypeDef


def get_value() -> UpdateGatewaySoftwareNowInputTypeDef:
    return {
        "GatewayArn": ...,
    }


# UpdateGatewaySoftwareNowInputTypeDef definition

class UpdateGatewaySoftwareNowInputTypeDef(TypedDict):
    GatewayArn: str,

UpdateHypervisorInputTypeDef#

# UpdateHypervisorInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import UpdateHypervisorInputTypeDef


def get_value() -> UpdateHypervisorInputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# UpdateHypervisorInputTypeDef definition

class UpdateHypervisorInputTypeDef(TypedDict):
    HypervisorArn: str,
    Host: NotRequired[str],
    LogGroupArn: NotRequired[str],
    Name: NotRequired[str],
    Password: NotRequired[str],
    Username: NotRequired[str],

VmwareTagTypeDef#

# VmwareTagTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import VmwareTagTypeDef


def get_value() -> VmwareTagTypeDef:
    return {
        "VmwareCategory": ...,
    }


# VmwareTagTypeDef definition

class VmwareTagTypeDef(TypedDict):
    VmwareCategory: NotRequired[str],
    VmwareTagDescription: NotRequired[str],
    VmwareTagName: NotRequired[str],

AssociateGatewayToServerOutputTypeDef#

# AssociateGatewayToServerOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import AssociateGatewayToServerOutputTypeDef


def get_value() -> AssociateGatewayToServerOutputTypeDef:
    return {
        "GatewayArn": ...,
    }


# AssociateGatewayToServerOutputTypeDef definition

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

CreateGatewayOutputTypeDef#

# CreateGatewayOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import CreateGatewayOutputTypeDef


def get_value() -> CreateGatewayOutputTypeDef:
    return {
        "GatewayArn": ...,
    }


# CreateGatewayOutputTypeDef definition

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

DeleteGatewayOutputTypeDef#

# DeleteGatewayOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import DeleteGatewayOutputTypeDef


def get_value() -> DeleteGatewayOutputTypeDef:
    return {
        "GatewayArn": ...,
    }


# DeleteGatewayOutputTypeDef definition

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

DeleteHypervisorOutputTypeDef#

# DeleteHypervisorOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import DeleteHypervisorOutputTypeDef


def get_value() -> DeleteHypervisorOutputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# DeleteHypervisorOutputTypeDef definition

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

DisassociateGatewayFromServerOutputTypeDef#

# DisassociateGatewayFromServerOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import DisassociateGatewayFromServerOutputTypeDef


def get_value() -> DisassociateGatewayFromServerOutputTypeDef:
    return {
        "GatewayArn": ...,
    }


# DisassociateGatewayFromServerOutputTypeDef definition

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

ImportHypervisorConfigurationOutputTypeDef#

# ImportHypervisorConfigurationOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ImportHypervisorConfigurationOutputTypeDef


def get_value() -> ImportHypervisorConfigurationOutputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# ImportHypervisorConfigurationOutputTypeDef definition

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

PutBandwidthRateLimitScheduleOutputTypeDef#

# PutBandwidthRateLimitScheduleOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import PutBandwidthRateLimitScheduleOutputTypeDef


def get_value() -> PutBandwidthRateLimitScheduleOutputTypeDef:
    return {
        "GatewayArn": ...,
    }


# PutBandwidthRateLimitScheduleOutputTypeDef definition

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

PutHypervisorPropertyMappingsOutputTypeDef#

# PutHypervisorPropertyMappingsOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import PutHypervisorPropertyMappingsOutputTypeDef


def get_value() -> PutHypervisorPropertyMappingsOutputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# PutHypervisorPropertyMappingsOutputTypeDef definition

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

PutMaintenanceStartTimeOutputTypeDef#

# PutMaintenanceStartTimeOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import PutMaintenanceStartTimeOutputTypeDef


def get_value() -> PutMaintenanceStartTimeOutputTypeDef:
    return {
        "GatewayArn": ...,
    }


# PutMaintenanceStartTimeOutputTypeDef definition

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

StartVirtualMachinesMetadataSyncOutputTypeDef#

# StartVirtualMachinesMetadataSyncOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import StartVirtualMachinesMetadataSyncOutputTypeDef


def get_value() -> StartVirtualMachinesMetadataSyncOutputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# StartVirtualMachinesMetadataSyncOutputTypeDef definition

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

TagResourceOutputTypeDef#

# TagResourceOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import TagResourceOutputTypeDef


def get_value() -> TagResourceOutputTypeDef:
    return {
        "ResourceARN": ...,
    }


# TagResourceOutputTypeDef definition

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

UntagResourceOutputTypeDef#

# UntagResourceOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import UntagResourceOutputTypeDef


def get_value() -> UntagResourceOutputTypeDef:
    return {
        "ResourceARN": ...,
    }


# UntagResourceOutputTypeDef definition

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

UpdateGatewayInformationOutputTypeDef#

# UpdateGatewayInformationOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import UpdateGatewayInformationOutputTypeDef


def get_value() -> UpdateGatewayInformationOutputTypeDef:
    return {
        "GatewayArn": ...,
    }


# UpdateGatewayInformationOutputTypeDef definition

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

UpdateGatewaySoftwareNowOutputTypeDef#

# UpdateGatewaySoftwareNowOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import UpdateGatewaySoftwareNowOutputTypeDef


def get_value() -> UpdateGatewaySoftwareNowOutputTypeDef:
    return {
        "GatewayArn": ...,
    }


# UpdateGatewaySoftwareNowOutputTypeDef definition

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

UpdateHypervisorOutputTypeDef#

# UpdateHypervisorOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import UpdateHypervisorOutputTypeDef


def get_value() -> UpdateHypervisorOutputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# UpdateHypervisorOutputTypeDef definition

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

GetBandwidthRateLimitScheduleOutputTypeDef#

# GetBandwidthRateLimitScheduleOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetBandwidthRateLimitScheduleOutputTypeDef


def get_value() -> GetBandwidthRateLimitScheduleOutputTypeDef:
    return {
        "BandwidthRateLimitIntervals": ...,
    }


# GetBandwidthRateLimitScheduleOutputTypeDef definition

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

CreateGatewayInputTypeDef#

# CreateGatewayInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import CreateGatewayInputTypeDef


def get_value() -> CreateGatewayInputTypeDef:
    return {
        "ActivationKey": ...,
    }


# CreateGatewayInputTypeDef definition

class CreateGatewayInputTypeDef(TypedDict):
    ActivationKey: str,
    GatewayDisplayName: str,
    GatewayType: GatewayTypeType,  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See GatewayTypeType
  2. See Sequence[TagTypeDef]

ImportHypervisorConfigurationInputTypeDef#

# ImportHypervisorConfigurationInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ImportHypervisorConfigurationInputTypeDef


def get_value() -> ImportHypervisorConfigurationInputTypeDef:
    return {
        "Host": ...,
    }


# ImportHypervisorConfigurationInputTypeDef definition

class ImportHypervisorConfigurationInputTypeDef(TypedDict):
    Host: str,
    Name: str,
    KmsKeyArn: NotRequired[str],
    Password: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    Username: NotRequired[str],
  1. See Sequence[TagTypeDef]

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListTagsForResourceOutputTypeDef


def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "ResourceArn": ...,
    }


# ListTagsForResourceOutputTypeDef definition

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

TagResourceInputTypeDef#

# TagResourceInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import TagResourceInputTypeDef


def get_value() -> TagResourceInputTypeDef:
    return {
        "ResourceARN": ...,
    }


# TagResourceInputTypeDef definition

class TagResourceInputTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See Sequence[TagTypeDef]

GatewayDetailsTypeDef#

# GatewayDetailsTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GatewayDetailsTypeDef


def get_value() -> GatewayDetailsTypeDef:
    return {
        "GatewayArn": ...,
    }


# GatewayDetailsTypeDef definition

class GatewayDetailsTypeDef(TypedDict):
    GatewayArn: NotRequired[str],
    GatewayDisplayName: NotRequired[str],
    GatewayType: NotRequired[GatewayTypeType],  # (1)
    HypervisorId: NotRequired[str],
    LastSeenTime: NotRequired[datetime.datetime],
    MaintenanceStartTime: NotRequired[MaintenanceStartTimeTypeDef],  # (2)
    NextUpdateAvailabilityTime: NotRequired[datetime.datetime],
    VpcEndpoint: NotRequired[str],
  1. See GatewayTypeType
  2. See MaintenanceStartTimeTypeDef

ListGatewaysOutputTypeDef#

# ListGatewaysOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListGatewaysOutputTypeDef


def get_value() -> ListGatewaysOutputTypeDef:
    return {
        "Gateways": ...,
    }


# ListGatewaysOutputTypeDef definition

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

GetHypervisorOutputTypeDef#

# GetHypervisorOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetHypervisorOutputTypeDef


def get_value() -> GetHypervisorOutputTypeDef:
    return {
        "Hypervisor": ...,
    }


# GetHypervisorOutputTypeDef definition

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

GetHypervisorPropertyMappingsOutputTypeDef#

# GetHypervisorPropertyMappingsOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetHypervisorPropertyMappingsOutputTypeDef


def get_value() -> GetHypervisorPropertyMappingsOutputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# GetHypervisorPropertyMappingsOutputTypeDef definition

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

PutHypervisorPropertyMappingsInputTypeDef#

# PutHypervisorPropertyMappingsInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import PutHypervisorPropertyMappingsInputTypeDef


def get_value() -> PutHypervisorPropertyMappingsInputTypeDef:
    return {
        "HypervisorArn": ...,
    }


# PutHypervisorPropertyMappingsInputTypeDef definition

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

ListHypervisorsOutputTypeDef#

# ListHypervisorsOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListHypervisorsOutputTypeDef


def get_value() -> ListHypervisorsOutputTypeDef:
    return {
        "Hypervisors": ...,
    }


# ListHypervisorsOutputTypeDef definition

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

ListGatewaysInputPaginateTypeDef#

# ListGatewaysInputPaginateTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListGatewaysInputPaginateTypeDef


def get_value() -> ListGatewaysInputPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListGatewaysInputPaginateTypeDef definition

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

ListHypervisorsInputPaginateTypeDef#

# ListHypervisorsInputPaginateTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListHypervisorsInputPaginateTypeDef


def get_value() -> ListHypervisorsInputPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListHypervisorsInputPaginateTypeDef definition

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

ListVirtualMachinesInputPaginateTypeDef#

# ListVirtualMachinesInputPaginateTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListVirtualMachinesInputPaginateTypeDef


def get_value() -> ListVirtualMachinesInputPaginateTypeDef:
    return {
        "HypervisorArn": ...,
    }


# ListVirtualMachinesInputPaginateTypeDef definition

class ListVirtualMachinesInputPaginateTypeDef(TypedDict):
    HypervisorArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListVirtualMachinesOutputTypeDef#

# ListVirtualMachinesOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import ListVirtualMachinesOutputTypeDef


def get_value() -> ListVirtualMachinesOutputTypeDef:
    return {
        "NextToken": ...,
    }


# ListVirtualMachinesOutputTypeDef definition

class ListVirtualMachinesOutputTypeDef(TypedDict):
    VirtualMachines: List[VirtualMachineTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[VirtualMachineTypeDef]
  2. See ResponseMetadataTypeDef

VirtualMachineDetailsTypeDef#

# VirtualMachineDetailsTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import VirtualMachineDetailsTypeDef


def get_value() -> VirtualMachineDetailsTypeDef:
    return {
        "HostName": ...,
    }


# VirtualMachineDetailsTypeDef definition

class VirtualMachineDetailsTypeDef(TypedDict):
    HostName: NotRequired[str],
    HypervisorId: NotRequired[str],
    LastBackupDate: NotRequired[datetime.datetime],
    Name: NotRequired[str],
    Path: NotRequired[str],
    ResourceArn: NotRequired[str],
    VmwareTags: NotRequired[List[VmwareTagTypeDef]],  # (1)
  1. See List[VmwareTagTypeDef]

PutBandwidthRateLimitScheduleInputTypeDef#

# PutBandwidthRateLimitScheduleInputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import PutBandwidthRateLimitScheduleInputTypeDef


def get_value() -> PutBandwidthRateLimitScheduleInputTypeDef:
    return {
        "BandwidthRateLimitIntervals": ...,
    }


# PutBandwidthRateLimitScheduleInputTypeDef definition

class PutBandwidthRateLimitScheduleInputTypeDef(TypedDict):
    BandwidthRateLimitIntervals: Sequence[BandwidthRateLimitIntervalUnionTypeDef],  # (1)
    GatewayArn: str,
  1. See Sequence[BandwidthRateLimitIntervalUnionTypeDef]

GetGatewayOutputTypeDef#

# GetGatewayOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetGatewayOutputTypeDef


def get_value() -> GetGatewayOutputTypeDef:
    return {
        "Gateway": ...,
    }


# GetGatewayOutputTypeDef definition

class GetGatewayOutputTypeDef(TypedDict):
    Gateway: GatewayDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GatewayDetailsTypeDef
  2. See ResponseMetadataTypeDef

GetVirtualMachineOutputTypeDef#

# GetVirtualMachineOutputTypeDef TypedDict usage example

from mypy_boto3_backup_gateway.type_defs import GetVirtualMachineOutputTypeDef


def get_value() -> GetVirtualMachineOutputTypeDef:
    return {
        "VirtualMachine": ...,
    }


# GetVirtualMachineOutputTypeDef definition

class GetVirtualMachineOutputTypeDef(TypedDict):
    VirtualMachine: VirtualMachineDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VirtualMachineDetailsTypeDef
  2. See ResponseMetadataTypeDef