Documentation
¶
Index ¶
- type AccessDeniedException
- type BandwidthRateLimitInterval
- type ConflictException
- type Gateway
- type GatewayDetails
- type GatewayType
- type Hypervisor
- type HypervisorDetails
- type HypervisorState
- type InternalServerException
- type MaintenanceStartTime
- type ResourceNotFoundException
- type SyncMetadataStatus
- type Tag
- type ThrottlingException
- type ValidationException
- type VirtualMachine
- type VirtualMachineDetails
- type VmwareTag
- type VmwareToAwsTagMapping
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { Message *string ErrorCodeOverride *string ErrorCode_ *string // contains filtered or unexported fields }
The operation cannot proceed because you have insufficient permissions.
func (*AccessDeniedException) Error ¶
func (e *AccessDeniedException) Error() string
func (*AccessDeniedException) ErrorCode ¶
func (e *AccessDeniedException) ErrorCode() string
func (*AccessDeniedException) ErrorFault ¶
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault
func (*AccessDeniedException) ErrorMessage ¶
func (e *AccessDeniedException) ErrorMessage() string
type BandwidthRateLimitInterval ¶
type BandwidthRateLimitInterval struct { // The days of the week component of the bandwidth rate limit interval, // represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 // represents Saturday. // // This member is required. DaysOfWeek []int32 // The hour of the day to end the bandwidth rate limit interval. // // This member is required. EndHourOfDay *int32 // The minute of the hour to end the bandwidth rate limit interval. // // The bandwidth rate limit interval ends at the end of the minute. To end an // interval at the end of an hour, use the value 59 . // // This member is required. EndMinuteOfHour *int32 // The hour of the day to start the bandwidth rate limit interval. // // This member is required. StartHourOfDay *int32 // The minute of the hour to start the bandwidth rate limit interval. The interval // begins at the start of that minute. To begin an interval exactly at the start of // the hour, use the value 0 . // // This member is required. StartMinuteOfHour *int32 // The average upload rate limit component of the bandwidth rate limit interval, // in bits per second. This field does not appear in the response if the upload // rate limit is not set. // // For Backup Gateway, the minimum value is (Value) . AverageUploadRateLimitInBitsPerSec *int64 // contains filtered or unexported fields }
Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.
type ConflictException ¶
type ConflictException struct { Message *string ErrorCodeOverride *string ErrorCode_ *string // contains filtered or unexported fields }
The operation cannot proceed because it is not supported.
func (*ConflictException) Error ¶
func (e *ConflictException) Error() string
func (*ConflictException) ErrorCode ¶
func (e *ConflictException) ErrorCode() string
func (*ConflictException) ErrorFault ¶
func (e *ConflictException) ErrorFault() smithy.ErrorFault
func (*ConflictException) ErrorMessage ¶
func (e *ConflictException) ErrorMessage() string
type Gateway ¶
type Gateway struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation // to return a list of gateways for your account and Amazon Web Services Region. GatewayArn *string // The display name of the gateway. GatewayDisplayName *string // The type of the gateway. GatewayType GatewayType // The hypervisor ID of the gateway. HypervisorId *string // The last time Backup gateway communicated with the gateway, in Unix format and // UTC time. LastSeenTime *time.Time // contains filtered or unexported fields }
A gateway is an Backup Gateway appliance that runs on the customer's network to provide seamless connectivity to backup storage in the Amazon Web Services Cloud.
type GatewayDetails ¶
type GatewayDetails struct { // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation // to return a list of gateways for your account and Amazon Web Services Region. GatewayArn *string // The display name of the gateway. GatewayDisplayName *string // The type of the gateway type. GatewayType GatewayType // The hypervisor ID of the gateway. HypervisorId *string // Details showing the last time Backup gateway communicated with the cloud, in // Unix format and UTC time. LastSeenTime *time.Time // Returns your gateway's weekly maintenance start time including the day and time // of the week. Note that values are in terms of the gateway's time zone. Can be // weekly or monthly. MaintenanceStartTime *MaintenanceStartTime // Details showing the next update availability time of the gateway. NextUpdateAvailabilityTime *time.Time // The DNS name for the virtual private cloud (VPC) endpoint the gateway uses to // connect to the cloud for backup gateway. VpcEndpoint *string // contains filtered or unexported fields }
The details of gateway.
type GatewayType ¶
type GatewayType string
const (
GatewayTypeBackupVm GatewayType = "BACKUP_VM"
)
Enum values for GatewayType
func (GatewayType) Values ¶
func (GatewayType) Values() []GatewayType
Values returns all known values for GatewayType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Hypervisor ¶
type Hypervisor struct { // The server host of the hypervisor. This can be either an IP address or a // fully-qualified domain name (FQDN). Host *string // The Amazon Resource Name (ARN) of the hypervisor. HypervisorArn *string // The Amazon Resource Name (ARN) of the Key Management Service used to encrypt // the hypervisor. KmsKeyArn *string // The name of the hypervisor. Name *string // The state of the hypervisor. State HypervisorState // contains filtered or unexported fields }
Represents the hypervisor's permissions to which the gateway will connect.
A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
type HypervisorDetails ¶
type HypervisorDetails struct { // The server host of the hypervisor. This can be either an IP address or a // fully-qualified domain name (FQDN). Host *string // The Amazon Resource Name (ARN) of the hypervisor. HypervisorArn *string // The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor. KmsKeyArn *string // This is the time when the most recent successful sync of metadata occurred. LastSuccessfulMetadataSyncTime *time.Time // This is the most recent status for the indicated metadata sync. LatestMetadataSyncStatus SyncMetadataStatus // This is the most recent status for the indicated metadata sync. LatestMetadataSyncStatusMessage *string // The Amazon Resource Name (ARN) of the group of gateways within the requested // log. LogGroupArn *string // This is the name of the specified hypervisor. Name *string // This is the current state of the specified hypervisor. // // The possible states are PENDING , ONLINE , OFFLINE , or ERROR . State HypervisorState // contains filtered or unexported fields }
These are the details of the specified hypervisor. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
type HypervisorState ¶
type HypervisorState string
const ( HypervisorStatePending HypervisorState = "PENDING" HypervisorStateOnline HypervisorState = "ONLINE" HypervisorStateOffline HypervisorState = "OFFLINE" HypervisorStateError HypervisorState = "ERROR" )
Enum values for HypervisorState
func (HypervisorState) Values ¶
func (HypervisorState) Values() []HypervisorState
Values returns all known values for HypervisorState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type InternalServerException ¶
type InternalServerException struct { Message *string ErrorCodeOverride *string ErrorCode_ *string // contains filtered or unexported fields }
The operation did not succeed because an internal error occurred. Try again later.
func (*InternalServerException) Error ¶
func (e *InternalServerException) Error() string
func (*InternalServerException) ErrorCode ¶
func (e *InternalServerException) ErrorCode() string
func (*InternalServerException) ErrorFault ¶
func (e *InternalServerException) ErrorFault() smithy.ErrorFault
func (*InternalServerException) ErrorMessage ¶
func (e *InternalServerException) ErrorMessage() string
type MaintenanceStartTime ¶
type MaintenanceStartTime struct { // The hour component of the maintenance start time represented as hh, where hh is // the hour (0 to 23). The hour of the day is in the time zone of the gateway. // // This member is required. HourOfDay *int32 // The minute component of the maintenance start time represented as mm, where mm // is the minute (0 to 59). The minute of the hour is in the time zone of the // gateway. // // This member is required. MinuteOfHour *int32 // The day of the month component of the maintenance start time represented as an // ordinal number from 1 to 28, where 1 represents the first day of the month and // 28 represents the last day of the month. DayOfMonth *int32 // An ordinal number between 0 and 6 that represents the day of the week, where 0 // represents Sunday and 6 represents Saturday. The day of week is in the time zone // of the gateway. DayOfWeek *int32 // contains filtered or unexported fields }
This is your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { Message *string ErrorCodeOverride *string ErrorCode_ *string // contains filtered or unexported fields }
A resource that is required for the action wasn't found.
func (*ResourceNotFoundException) Error ¶
func (e *ResourceNotFoundException) Error() string
func (*ResourceNotFoundException) ErrorCode ¶
func (e *ResourceNotFoundException) ErrorCode() string
func (*ResourceNotFoundException) ErrorFault ¶
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*ResourceNotFoundException) ErrorMessage ¶
func (e *ResourceNotFoundException) ErrorMessage() string
type SyncMetadataStatus ¶
type SyncMetadataStatus string
const ( SyncMetadataStatusCreated SyncMetadataStatus = "CREATED" SyncMetadataStatusRunning SyncMetadataStatus = "RUNNING" SyncMetadataStatusFailed SyncMetadataStatus = "FAILED" SyncMetadataStatusPartiallyFailed SyncMetadataStatus = "PARTIALLY_FAILED" SyncMetadataStatusSucceeded SyncMetadataStatus = "SUCCEEDED" )
Enum values for SyncMetadataStatus
func (SyncMetadataStatus) Values ¶
func (SyncMetadataStatus) Values() []SyncMetadataStatus
Values returns all known values for SyncMetadataStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Tag ¶
type Tag struct { // The key part of a tag's key-value pair. The key can't start with aws: . // // This member is required. Key *string // The value part of a tag's key-value pair. // // This member is required. Value *string // contains filtered or unexported fields }
A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.
type ThrottlingException ¶
type ThrottlingException struct { Message *string ErrorCodeOverride *string ErrorCode_ *string // contains filtered or unexported fields }
TPS has been limited to protect against intentional or unintentional high request volumes.
func (*ThrottlingException) Error ¶
func (e *ThrottlingException) Error() string
func (*ThrottlingException) ErrorCode ¶
func (e *ThrottlingException) ErrorCode() string
func (*ThrottlingException) ErrorFault ¶
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault
func (*ThrottlingException) ErrorMessage ¶
func (e *ThrottlingException) ErrorMessage() string
type ValidationException ¶
type ValidationException struct { Message *string ErrorCodeOverride *string ErrorCode_ *string // contains filtered or unexported fields }
The operation did not succeed because a validation error occurred.
func (*ValidationException) Error ¶
func (e *ValidationException) Error() string
func (*ValidationException) ErrorCode ¶
func (e *ValidationException) ErrorCode() string
func (*ValidationException) ErrorFault ¶
func (e *ValidationException) ErrorFault() smithy.ErrorFault
func (*ValidationException) ErrorMessage ¶
func (e *ValidationException) ErrorMessage() string
type VirtualMachine ¶
type VirtualMachine struct { // The host name of the virtual machine. HostName *string // The ID of the virtual machine's hypervisor. HypervisorId *string // The most recent date a virtual machine was backed up, in Unix format and UTC // time. LastBackupDate *time.Time // The name of the virtual machine. Name *string // The path of the virtual machine. Path *string // The Amazon Resource Name (ARN) of the virtual machine. For example, // arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL . ResourceArn *string // contains filtered or unexported fields }
A virtual machine that is on a hypervisor.
type VirtualMachineDetails ¶
type VirtualMachineDetails struct { // The host name of the virtual machine. HostName *string // The ID of the virtual machine's hypervisor. HypervisorId *string // The most recent date a virtual machine was backed up, in Unix format and UTC // time. LastBackupDate *time.Time // The name of the virtual machine. Name *string // The path of the virtual machine. Path *string // The Amazon Resource Name (ARN) of the virtual machine. For example, // arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL . ResourceArn *string // These are the details of the VMware tags associated with the specified virtual // machine. VmwareTags []VmwareTag // contains filtered or unexported fields }
Your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).
type VmwareTag ¶
type VmwareTag struct { // The is the category of VMware. VmwareCategory *string // This is a user-defined description of a VMware tag. VmwareTagDescription *string // This is the user-defined name of a VMware tag. VmwareTagName *string // contains filtered or unexported fields }
A VMware tag is a tag attached to a specific virtual machine. A tag is a key-value pair you can use to manage, filter, and search for your resources.
The content of VMware tags can be matched to Amazon Web Services tags.
type VmwareToAwsTagMapping ¶
type VmwareToAwsTagMapping struct { // The key part of the Amazon Web Services tag's key-value pair. // // This member is required. AwsTagKey *string // The value part of the Amazon Web Services tag's key-value pair. // // This member is required. AwsTagValue *string // The is the category of VMware. // // This member is required. VmwareCategory *string // This is the user-defined name of a VMware tag. // // This member is required. VmwareTagName *string // contains filtered or unexported fields }
This displays the mapping of on-premises VMware tags to the corresponding Amazon Web Services tags.