Skip to content

Backup Gateway Classes

AssociateGatewayToServerInput

GatewayArn

  • Type:
  • Required: Yes

ServerArn

  • Type:
  • Required: Yes

AssociateGatewayToServerOutput

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BandwidthRateLimitInterval

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]

BandwidthRateLimitIntervalOutput

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!

CreateGatewayInput

ActivationKey

  • Type:
  • Required: Yes

GatewayDisplayName

  • Type:
  • Required: Yes

GatewayType

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

Tags

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

CreateGatewayOutput

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteGatewayInput

GatewayArn

  • Type:
  • Required: Yes

DeleteGatewayOutput

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteHypervisorInput

HypervisorArn

  • Type:
  • Required: Yes

DeleteHypervisorOutput

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DisassociateGatewayFromServerInput

GatewayArn

  • Type:
  • Required: Yes

DisassociateGatewayFromServerOutput

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Gateway

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]

GatewayDetails

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:

NextUpdateAvailabilityTime

  • Type: typing.Optional[datetime.datetime]

VpcEndpoint

  • Type: typing.Optional[str]

GetBandwidthRateLimitScheduleInput

GatewayArn

  • Type:
  • Required: Yes

GetBandwidthRateLimitScheduleOutput

BandwidthRateLimitIntervals

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

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetGatewayInput

GatewayArn

  • Type:
  • Required: Yes

GetGatewayOutput

Gateway

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetHypervisorInput

HypervisorArn

  • Type:
  • Required: Yes

GetHypervisorOutput

Hypervisor

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetHypervisorPropertyMappingsInput

HypervisorArn

  • Type:
  • Required: Yes

GetHypervisorPropertyMappingsOutput

HypervisorArn

  • Type:
  • Required: Yes

IamRoleArn

  • Type:
  • Required: Yes

VmwareToAwsTagMappings

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

ResponseMetadata

  • Type:
  • Required: Yes

GetVirtualMachineInput

ResourceArn

  • Type:
  • Required: Yes

GetVirtualMachineOutput

VirtualMachine

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Hypervisor

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']]

HypervisorDetails

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']]

ImportHypervisorConfigurationInput

Host

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

KmsKeyArn

  • Type: typing.Optional[str]

Password

  • Type: typing.Optional[str]

Tags

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

Username

  • Type: typing.Optional[str]

ImportHypervisorConfigurationOutput

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListGatewaysInput

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListGatewaysInputPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.backup_gateway.backup_gateway_classes.PaginatorConfig]

ListGatewaysOutput

Gateways

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

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListHypervisorsInput

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListHypervisorsInputPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.backup_gateway.backup_gateway_classes.PaginatorConfig]

ListHypervisorsOutput

Hypervisors

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

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListTagsForResourceInput

ResourceArn

  • Type:
  • Required: Yes

ListTagsForResourceOutput

ResourceArn

  • Type:
  • Required: Yes

Tags

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

ResponseMetadata

  • Type:
  • Required: Yes

ListVirtualMachinesInput

HypervisorArn

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

NextToken

  • Type: typing.Optional[str]

ListVirtualMachinesInputPaginate

HypervisorArn

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.backup_gateway.backup_gateway_classes.PaginatorConfig]

ListVirtualMachinesOutput

VirtualMachines

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

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

MaintenanceStartTime

HourOfDay

  • Type:
  • Required: Yes

MinuteOfHour

  • Type:
  • Required: Yes

DayOfMonth

  • Type: typing.Optional[int]

DayOfWeek

  • Type: typing.Optional[int]

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PutBandwidthRateLimitScheduleInput

BandwidthRateLimitIntervals

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.backup_gateway.backup_gateway_classes.BandwidthRateLimitInterval, aws_resource_validator.pydantic_models.backup_gateway.backup_gateway_classes.BandwidthRateLimitIntervalOutput]]
  • Required: Yes

GatewayArn

  • Type:
  • Required: Yes

PutBandwidthRateLimitScheduleOutput

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutHypervisorPropertyMappingsInput

HypervisorArn

  • Type:
  • Required: Yes

IamRoleArn

  • Type:
  • Required: Yes

VmwareToAwsTagMappings

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

PutHypervisorPropertyMappingsOutput

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutMaintenanceStartTimeInput

GatewayArn

  • Type:
  • Required: Yes

HourOfDay

  • Type:
  • Required: Yes

MinuteOfHour

  • Type:
  • Required: Yes

DayOfMonth

  • Type: typing.Optional[int]

DayOfWeek

  • Type: typing.Optional[int]

PutMaintenanceStartTimeOutput

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

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

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

StartVirtualMachinesMetadataSyncInput

HypervisorArn

  • Type:
  • Required: Yes

StartVirtualMachinesMetadataSyncOutput

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Tag

Key

  • Type:
  • Required: Yes

Value

  • Type:
  • Required: Yes

TagResourceInput

ResourceARN

  • Type:
  • Required: Yes

Tags

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

TagResourceOutput

ResourceARN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TestHypervisorConfigurationInput

GatewayArn

  • Type:
  • Required: Yes

Host

  • Type:
  • Required: Yes

Password

  • Type: typing.Optional[str]

Username

  • Type: typing.Optional[str]

UntagResourceInput

ResourceARN

  • Type:
  • Required: Yes

TagKeys

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

UntagResourceOutput

ResourceARN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateGatewayInformationInput

GatewayArn

  • Type:
  • Required: Yes

GatewayDisplayName

  • Type: typing.Optional[str]

UpdateGatewayInformationOutput

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateGatewaySoftwareNowInput

GatewayArn

  • Type:
  • Required: Yes

UpdateGatewaySoftwareNowOutput

GatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateHypervisorInput

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]

UpdateHypervisorOutput

HypervisorArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

VirtualMachine

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]

VirtualMachineDetails

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.backup_gateway_classes.VmwareTag]]

VmwareTag

VmwareCategory

  • Type: typing.Optional[str]

VmwareTagDescription

  • Type: typing.Optional[str]

VmwareTagName

  • Type: typing.Optional[str]

VmwareToAwsTagMapping

AwsTagKey

  • Type:
  • Required: Yes

AwsTagValue

  • Type:
  • Required: Yes

VmwareCategory

  • Type:
  • Required: Yes

VmwareTagName

  • Type:
  • Required: Yes