Skip to content

Backup Gateway Classes

AssociateGatewayToServerInputRequestTypeDef

GatewayArn

  • Type:
  • Required: Yes

ServerArn

  • Type:
  • Required: Yes

AssociateGatewayToServerOutputTypeDef

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BandwidthRateLimitIntervalTypeDef

DaysOfWeek

  • Type: typing.List[int]
  • Required: Yes

EndHourOfDay

  • Type:
  • Required: Yes

EndMinuteOfHour

  • Type:
  • Required: Yes

StartHourOfDay

  • Type:
  • Required: Yes

StartMinuteOfHour

  • Type:
  • Required: Yes

AverageUploadRateLimitInBitsPerSec

  • Type: typing.Optional[int]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CreateGatewayInputRequestTypeDef

ActivationKey

  • Type:
  • Required: Yes

GatewayDisplayName

  • Type:
  • Required: Yes

GatewayType

  • Type: typing.Literal['BACKUP_VM']
  • Required: Yes

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.backup_gateway_classes.TagTypeDef]]

CreateGatewayOutputTypeDef

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteGatewayInputRequestTypeDef

GatewayArn

  • Type:
  • Required: Yes

DeleteGatewayOutputTypeDef

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteHypervisorInputRequestTypeDef

HypervisorArn

  • Type:
  • Required: Yes

DeleteHypervisorOutputTypeDef

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DisassociateGatewayFromServerInputRequestTypeDef

GatewayArn

  • Type:
  • Required: Yes

DisassociateGatewayFromServerOutputTypeDef

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GatewayDetailsTypeDef

GatewayArn

  • Type: typing.Optional[str]

GatewayDisplayName

  • Type: typing.Optional[str]

GatewayType

  • Type: typing.Optional[typing.Literal['BACKUP_VM']]

HypervisorId

  • Type: typing.Optional[str]

LastSeenTime

  • Type: typing.Optional[datetime.datetime]

MaintenanceStartTime

  • Type: typing.Optional[aws_resource_validator.pydantic_models.backup_gateway_classes.MaintenanceStartTimeTypeDef]

NextUpdateAvailabilityTime

  • Type: typing.Optional[datetime.datetime]

VpcEndpoint

  • Type: typing.Optional[str]

GatewayTypeDef

GatewayArn

  • Type: typing.Optional[str]

GatewayDisplayName

  • Type: typing.Optional[str]

GatewayType

  • Type: typing.Optional[typing.Literal['BACKUP_VM']]

HypervisorId

  • Type: typing.Optional[str]

LastSeenTime

  • Type: typing.Optional[datetime.datetime]

GetBandwidthRateLimitScheduleInputRequestTypeDef

GatewayArn

  • Type:
  • Required: Yes

GetBandwidthRateLimitScheduleOutputTypeDef

BandwidthRateLimitIntervals

  • Type: typing.List[aws_resource_validator.pydantic_models.backup_gateway_classes.BandwidthRateLimitIntervalTypeDef]
  • Required: Yes

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetGatewayInputRequestTypeDef

GatewayArn

  • Type:
  • Required: Yes

GetGatewayOutputTypeDef

Gateway

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetHypervisorInputRequestTypeDef

HypervisorArn

  • Type:
  • Required: Yes

GetHypervisorOutputTypeDef

Hypervisor

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetHypervisorPropertyMappingsInputRequestTypeDef

HypervisorArn

  • Type:
  • Required: Yes

GetHypervisorPropertyMappingsOutputTypeDef

HypervisorArn

  • Type:
  • Required: Yes

IamRoleArn

  • Type:
  • Required: Yes

VmwareToAwsTagMappings

  • Type: typing.List[aws_resource_validator.pydantic_models.backup_gateway_classes.VmwareToAwsTagMappingTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetVirtualMachineInputRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

GetVirtualMachineOutputTypeDef

VirtualMachine

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

HypervisorDetailsTypeDef

Host

  • Type: typing.Optional[str]

HypervisorArn

  • Type: typing.Optional[str]

KmsKeyArn

  • Type: typing.Optional[str]

LastSuccessfulMetadataSyncTime

  • Type: typing.Optional[datetime.datetime]

LatestMetadataSyncStatus

  • Type: typing.Optional[typing.Literal['CREATED', 'FAILED', 'PARTIALLY_FAILED', 'RUNNING', 'SUCCEEDED']]

LatestMetadataSyncStatusMessage

  • Type: typing.Optional[str]

LogGroupArn

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

State

  • Type: typing.Optional[typing.Literal['ERROR', 'OFFLINE', 'ONLINE', 'PENDING']]

HypervisorTypeDef

Host

  • Type: typing.Optional[str]

HypervisorArn

  • Type: typing.Optional[str]

KmsKeyArn

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

State

  • Type: typing.Optional[typing.Literal['ERROR', 'OFFLINE', 'ONLINE', 'PENDING']]

ImportHypervisorConfigurationInputRequestTypeDef

Host

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

KmsKeyArn

  • Type: typing.Optional[str]

Password

  • Type: typing.Optional[str]

Tags

  • Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.backup_gateway_classes.TagTypeDef]]

Username

  • Type: typing.Optional[str]

ImportHypervisorConfigurationOutputTypeDef

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListGatewaysInputListGatewaysPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.backup_gateway_classes.PaginatorConfigTypeDef]

ListGatewaysInputRequestTypeDef

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListGatewaysOutputTypeDef

Gateways

  • Type: typing.List[aws_resource_validator.pydantic_models.backup_gateway_classes.GatewayTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListHypervisorsInputListHypervisorsPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.backup_gateway_classes.PaginatorConfigTypeDef]

ListHypervisorsInputRequestTypeDef

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListHypervisorsOutputTypeDef

Hypervisors

  • Type: typing.List[aws_resource_validator.pydantic_models.backup_gateway_classes.HypervisorTypeDef]
  • Required: Yes

NextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceInputRequestTypeDef

ResourceArn

  • Type:
  • Required: Yes

ListTagsForResourceOutputTypeDef

ResourceArn

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.backup_gateway_classes.TagTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListVirtualMachinesInputListVirtualMachinesPaginateTypeDef

HypervisorArn

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.backup_gateway_classes.PaginatorConfigTypeDef]

ListVirtualMachinesInputRequestTypeDef

HypervisorArn

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListVirtualMachinesOutputTypeDef

NextToken

  • Type:
  • Required: Yes

VirtualMachines

  • Type: typing.List[aws_resource_validator.pydantic_models.backup_gateway_classes.VirtualMachineTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

MaintenanceStartTimeTypeDef

HourOfDay

  • Type:
  • Required: Yes

MinuteOfHour

  • Type:
  • Required: Yes

DayOfMonth

  • Type: typing.Optional[int]

DayOfWeek

  • Type: typing.Optional[int]

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PutBandwidthRateLimitScheduleInputRequestTypeDef

BandwidthRateLimitIntervals

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.backup_gateway_classes.BandwidthRateLimitIntervalTypeDef]
  • Required: Yes

GatewayArn

  • Type:
  • Required: Yes

PutBandwidthRateLimitScheduleOutputTypeDef

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutHypervisorPropertyMappingsInputRequestTypeDef

HypervisorArn

  • Type:
  • Required: Yes

IamRoleArn

  • Type:
  • Required: Yes

VmwareToAwsTagMappings

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.backup_gateway_classes.VmwareToAwsTagMappingTypeDef]
  • Required: Yes

PutHypervisorPropertyMappingsOutputTypeDef

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutMaintenanceStartTimeInputRequestTypeDef

GatewayArn

  • Type:
  • Required: Yes

HourOfDay

  • Type:
  • Required: Yes

MinuteOfHour

  • Type:
  • Required: Yes

DayOfMonth

  • Type: typing.Optional[int]

DayOfWeek

  • Type: typing.Optional[int]

PutMaintenanceStartTimeOutputTypeDef

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HostId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

StartVirtualMachinesMetadataSyncInputRequestTypeDef

HypervisorArn

  • Type:
  • Required: Yes

StartVirtualMachinesMetadataSyncOutputTypeDef

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceInputRequestTypeDef

ResourceARN

  • Type:
  • Required: Yes

Tags

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.backup_gateway_classes.TagTypeDef]
  • Required: Yes

TagResourceOutputTypeDef

ResourceARN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagTypeDef

Key

  • Type:
  • Required: Yes

Value

  • Type:
  • Required: Yes

TestHypervisorConfigurationInputRequestTypeDef

GatewayArn

  • Type:
  • Required: Yes

Host

  • Type:
  • Required: Yes

Password

  • Type: typing.Optional[str]

Username

  • Type: typing.Optional[str]

UntagResourceInputRequestTypeDef

ResourceARN

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UntagResourceOutputTypeDef

ResourceARN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateGatewayInformationInputRequestTypeDef

GatewayArn

  • Type:
  • Required: Yes

GatewayDisplayName

  • Type: typing.Optional[str]

UpdateGatewayInformationOutputTypeDef

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateGatewaySoftwareNowInputRequestTypeDef

GatewayArn

  • Type:
  • Required: Yes

UpdateGatewaySoftwareNowOutputTypeDef

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateHypervisorInputRequestTypeDef

HypervisorArn

  • Type:
  • Required: Yes

Host

  • Type: typing.Optional[str]

LogGroupArn

  • Type: typing.Optional[str]

Name

  • Type: typing.Optional[str]

Password

  • Type: typing.Optional[str]

Username

  • Type: typing.Optional[str]

UpdateHypervisorOutputTypeDef

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

VirtualMachineDetailsTypeDef

HostName

  • Type: typing.Optional[str]

HypervisorId

  • Type: typing.Optional[str]

LastBackupDate

  • Type: typing.Optional[datetime.datetime]

Name

  • Type: typing.Optional[str]

Path

  • Type: typing.Optional[str]

ResourceArn

  • Type: typing.Optional[str]

VmwareTags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.backup_gateway_classes.VmwareTagTypeDef]]

VirtualMachineTypeDef

HostName

  • Type: typing.Optional[str]

HypervisorId

  • Type: typing.Optional[str]

LastBackupDate

  • Type: typing.Optional[datetime.datetime]

Name

  • Type: typing.Optional[str]

Path

  • Type: typing.Optional[str]

ResourceArn

  • Type: typing.Optional[str]

VmwareTagTypeDef

VmwareCategory

  • Type: typing.Optional[str]

VmwareTagDescription

  • Type: typing.Optional[str]

VmwareTagName

  • Type: typing.Optional[str]

VmwareToAwsTagMappingTypeDef

AwsTagKey

  • Type:
  • Required: Yes

AwsTagValue

  • Type:
  • Required: Yes

VmwareCategory

  • Type:
  • Required: Yes

VmwareTagName

  • Type:
  • Required: Yes