backupgateway

package
v1.45.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 30, 2023 License: Apache-2.0 Imports: 10 Imported by: 11

Documentation

Overview

Package backupgateway provides the client and types for making API requests to AWS Backup Gateway.

Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.

See https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01 for more information on this service.

See backupgateway package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/backupgateway/

Using the Client

To contact AWS Backup Gateway with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Backup Gateway client BackupGateway for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/backupgateway/#New

Index

Constants

View Source 
const (
	// HypervisorStatePending is a HypervisorState enum value
	HypervisorStatePending = "PENDING"

	// HypervisorStateOnline is a HypervisorState enum value
	HypervisorStateOnline = "ONLINE"

	// HypervisorStateOffline is a HypervisorState enum value
	HypervisorStateOffline = "OFFLINE"

	// HypervisorStateError is a HypervisorState enum value
	HypervisorStateError = "ERROR"
)
View Source 
const (
	// SyncMetadataStatusCreated is a SyncMetadataStatus enum value
	SyncMetadataStatusCreated = "CREATED"

	// SyncMetadataStatusRunning is a SyncMetadataStatus enum value
	SyncMetadataStatusRunning = "RUNNING"

	// SyncMetadataStatusFailed is a SyncMetadataStatus enum value
	SyncMetadataStatusFailed = "FAILED"

	// SyncMetadataStatusPartiallyFailed is a SyncMetadataStatus enum value
	SyncMetadataStatusPartiallyFailed = "PARTIALLY_FAILED"

	// SyncMetadataStatusSucceeded is a SyncMetadataStatus enum value
	SyncMetadataStatusSucceeded = "SUCCEEDED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// The operation cannot proceed because you have insufficient permissions.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The operation cannot proceed because it is not supported.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The operation did not succeed because an internal error occurred. Try again
	// later.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A resource that is required for the action wasn't found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// TPS has been limited to protect against intentional or unintentional high
	// request volumes.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The operation did not succeed because a validation error occurred.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Backup Gateway" // Name of service.
	EndpointsID = "backup-gateway" // ID to lookup a service endpoint with.
	ServiceID   = "Backup Gateway" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// GatewayTypeBackupVm is a GatewayType enum value
	GatewayTypeBackupVm = "BACKUP_VM"
)

Variables

This section is empty.

Functions

func GatewayType_Values 

func GatewayType_Values() []string

GatewayType_Values returns all elements of the GatewayType enum

func HypervisorState_Values 

func HypervisorState_Values() []string

HypervisorState_Values returns all elements of the HypervisorState enum

func SyncMetadataStatus_Values added in v1.44.161 

func SyncMetadataStatus_Values() []string

SyncMetadataStatus_Values returns all elements of the SyncMetadataStatus enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of why you have insufficient permissions.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation cannot proceed because you have insufficient permissions.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateGatewayToServerInput 

type AssociateGatewayToServerInput 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 is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
	//
	// ServerArn is a required field
	ServerArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateGatewayToServerInput) GoString 

func (s AssociateGatewayToServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateGatewayToServerInput) SetGatewayArn 

func (s *AssociateGatewayToServerInput) SetGatewayArn(v string) *AssociateGatewayToServerInput

SetGatewayArn sets the GatewayArn field's value.

func (*AssociateGatewayToServerInput) SetServerArn 

func (s *AssociateGatewayToServerInput) SetServerArn(v string) *AssociateGatewayToServerInput

SetServerArn sets the ServerArn field's value.

func (AssociateGatewayToServerInput) String 

func (s AssociateGatewayToServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateGatewayToServerInput) Validate 

func (s *AssociateGatewayToServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateGatewayToServerOutput 

type AssociateGatewayToServerOutput struct {

	// The Amazon Resource Name (ARN) of a gateway.
	GatewayArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateGatewayToServerOutput) GoString 

func (s AssociateGatewayToServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateGatewayToServerOutput) SetGatewayArn 

func (s *AssociateGatewayToServerOutput) SetGatewayArn(v string) *AssociateGatewayToServerOutput

SetGatewayArn sets the GatewayArn field's value.

func (AssociateGatewayToServerOutput) String 

func (s AssociateGatewayToServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BackupGateway 

type BackupGateway struct {
	*client.Client
}

BackupGateway provides the API operation methods for making requests to AWS Backup Gateway. See this package's package overview docs for details on the service.

BackupGateway methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *BackupGateway

New creates a new instance of the BackupGateway client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a BackupGateway client from just a session.
svc := backupgateway.New(mySession)

// Create a BackupGateway client with additional configuration
svc := backupgateway.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*BackupGateway) AssociateGatewayToServer 

func (c *BackupGateway) AssociateGatewayToServer(input *AssociateGatewayToServerInput) (*AssociateGatewayToServerOutput, error)

AssociateGatewayToServer API operation for AWS Backup Gateway.

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation AssociateGatewayToServer for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • ConflictException The operation cannot proceed because it is not supported.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/AssociateGatewayToServer

func (*BackupGateway) AssociateGatewayToServerRequest 

func (c *BackupGateway) AssociateGatewayToServerRequest(input *AssociateGatewayToServerInput) (req *request.Request, output *AssociateGatewayToServerOutput)

AssociateGatewayToServerRequest generates a "aws/request.Request" representing the client's request for the AssociateGatewayToServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateGatewayToServer for more information on using the AssociateGatewayToServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateGatewayToServerRequest method.
req, resp := client.AssociateGatewayToServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/AssociateGatewayToServer

func (*BackupGateway) AssociateGatewayToServerWithContext 

func (c *BackupGateway) AssociateGatewayToServerWithContext(ctx aws.Context, input *AssociateGatewayToServerInput, opts ...request.Option) (*AssociateGatewayToServerOutput, error)

AssociateGatewayToServerWithContext is the same as AssociateGatewayToServer with the addition of the ability to pass a context and additional request options.

See AssociateGatewayToServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) CreateGateway 

func (c *BackupGateway) CreateGateway(input *CreateGatewayInput) (*CreateGatewayOutput, error)

CreateGateway API operation for AWS Backup Gateway.

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation CreateGateway for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/CreateGateway

func (*BackupGateway) CreateGatewayRequest 

func (c *BackupGateway) CreateGatewayRequest(input *CreateGatewayInput) (req *request.Request, output *CreateGatewayOutput)

CreateGatewayRequest generates a "aws/request.Request" representing the client's request for the CreateGateway operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGateway for more information on using the CreateGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateGatewayRequest method.
req, resp := client.CreateGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/CreateGateway

func (*BackupGateway) CreateGatewayWithContext 

func (c *BackupGateway) CreateGatewayWithContext(ctx aws.Context, input *CreateGatewayInput, opts ...request.Option) (*CreateGatewayOutput, error)

CreateGatewayWithContext is the same as CreateGateway with the addition of the ability to pass a context and additional request options.

See CreateGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) DeleteGateway 

func (c *BackupGateway) DeleteGateway(input *DeleteGatewayInput) (*DeleteGatewayOutput, error)

DeleteGateway API operation for AWS Backup Gateway.

Deletes a backup gateway.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation DeleteGateway for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DeleteGateway

func (*BackupGateway) DeleteGatewayRequest 

func (c *BackupGateway) DeleteGatewayRequest(input *DeleteGatewayInput) (req *request.Request, output *DeleteGatewayOutput)

DeleteGatewayRequest generates a "aws/request.Request" representing the client's request for the DeleteGateway operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGateway for more information on using the DeleteGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteGatewayRequest method.
req, resp := client.DeleteGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DeleteGateway

func (*BackupGateway) DeleteGatewayWithContext 

func (c *BackupGateway) DeleteGatewayWithContext(ctx aws.Context, input *DeleteGatewayInput, opts ...request.Option) (*DeleteGatewayOutput, error)

DeleteGatewayWithContext is the same as DeleteGateway with the addition of the ability to pass a context and additional request options.

See DeleteGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) DeleteHypervisor 

func (c *BackupGateway) DeleteHypervisor(input *DeleteHypervisorInput) (*DeleteHypervisorOutput, error)

DeleteHypervisor API operation for AWS Backup Gateway.

Deletes a hypervisor.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation DeleteHypervisor for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • ConflictException The operation cannot proceed because it is not supported.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException The operation cannot proceed because you have insufficient permissions.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DeleteHypervisor

func (*BackupGateway) DeleteHypervisorRequest 

func (c *BackupGateway) DeleteHypervisorRequest(input *DeleteHypervisorInput) (req *request.Request, output *DeleteHypervisorOutput)

DeleteHypervisorRequest generates a "aws/request.Request" representing the client's request for the DeleteHypervisor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteHypervisor for more information on using the DeleteHypervisor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteHypervisorRequest method.
req, resp := client.DeleteHypervisorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DeleteHypervisor

func (*BackupGateway) DeleteHypervisorWithContext 

func (c *BackupGateway) DeleteHypervisorWithContext(ctx aws.Context, input *DeleteHypervisorInput, opts ...request.Option) (*DeleteHypervisorOutput, error)

DeleteHypervisorWithContext is the same as DeleteHypervisor with the addition of the ability to pass a context and additional request options.

See DeleteHypervisor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) DisassociateGatewayFromServer 

func (c *BackupGateway) DisassociateGatewayFromServer(input *DisassociateGatewayFromServerInput) (*DisassociateGatewayFromServerOutput, error)

DisassociateGatewayFromServer API operation for AWS Backup Gateway.

Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation DisassociateGatewayFromServer for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • ConflictException The operation cannot proceed because it is not supported.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DisassociateGatewayFromServer

func (*BackupGateway) DisassociateGatewayFromServerRequest 

func (c *BackupGateway) DisassociateGatewayFromServerRequest(input *DisassociateGatewayFromServerInput) (req *request.Request, output *DisassociateGatewayFromServerOutput)

DisassociateGatewayFromServerRequest generates a "aws/request.Request" representing the client's request for the DisassociateGatewayFromServer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateGatewayFromServer for more information on using the DisassociateGatewayFromServer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateGatewayFromServerRequest method.
req, resp := client.DisassociateGatewayFromServerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DisassociateGatewayFromServer

func (*BackupGateway) DisassociateGatewayFromServerWithContext 

func (c *BackupGateway) DisassociateGatewayFromServerWithContext(ctx aws.Context, input *DisassociateGatewayFromServerInput, opts ...request.Option) (*DisassociateGatewayFromServerOutput, error)

DisassociateGatewayFromServerWithContext is the same as DisassociateGatewayFromServer with the addition of the ability to pass a context and additional request options.

See DisassociateGatewayFromServer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) GetBandwidthRateLimitSchedule added in v1.44.161 

func (c *BackupGateway) GetBandwidthRateLimitSchedule(input *GetBandwidthRateLimitScheduleInput) (*GetBandwidthRateLimitScheduleOutput, error)

GetBandwidthRateLimitSchedule API operation for AWS Backup Gateway.

Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation GetBandwidthRateLimitSchedule for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule

func (*BackupGateway) GetBandwidthRateLimitScheduleRequest added in v1.44.161 

func (c *BackupGateway) GetBandwidthRateLimitScheduleRequest(input *GetBandwidthRateLimitScheduleInput) (req *request.Request, output *GetBandwidthRateLimitScheduleOutput)

GetBandwidthRateLimitScheduleRequest generates a "aws/request.Request" representing the client's request for the GetBandwidthRateLimitSchedule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBandwidthRateLimitSchedule for more information on using the GetBandwidthRateLimitSchedule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetBandwidthRateLimitScheduleRequest method.
req, resp := client.GetBandwidthRateLimitScheduleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule

func (*BackupGateway) GetBandwidthRateLimitScheduleWithContext added in v1.44.161 

func (c *BackupGateway) GetBandwidthRateLimitScheduleWithContext(ctx aws.Context, input *GetBandwidthRateLimitScheduleInput, opts ...request.Option) (*GetBandwidthRateLimitScheduleOutput, error)

GetBandwidthRateLimitScheduleWithContext is the same as GetBandwidthRateLimitSchedule with the addition of the ability to pass a context and additional request options.

See GetBandwidthRateLimitSchedule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) GetGateway added in v1.44.26 

func (c *BackupGateway) GetGateway(input *GetGatewayInput) (*GetGatewayOutput, error)

GetGateway API operation for AWS Backup Gateway.

By providing the ARN (Amazon Resource Name), this API returns the gateway.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation GetGateway for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetGateway

func (*BackupGateway) GetGatewayRequest added in v1.44.26 

func (c *BackupGateway) GetGatewayRequest(input *GetGatewayInput) (req *request.Request, output *GetGatewayOutput)

GetGatewayRequest generates a "aws/request.Request" representing the client's request for the GetGateway operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetGateway for more information on using the GetGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetGatewayRequest method.
req, resp := client.GetGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetGateway

func (*BackupGateway) GetGatewayWithContext added in v1.44.26 

func (c *BackupGateway) GetGatewayWithContext(ctx aws.Context, input *GetGatewayInput, opts ...request.Option) (*GetGatewayOutput, error)

GetGatewayWithContext is the same as GetGateway with the addition of the ability to pass a context and additional request options.

See GetGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) GetHypervisor added in v1.44.161 

func (c *BackupGateway) GetHypervisor(input *GetHypervisorInput) (*GetHypervisorOutput, error)

GetHypervisor API operation for AWS Backup Gateway.

This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation GetHypervisor for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisor

func (*BackupGateway) GetHypervisorPropertyMappings added in v1.44.161 

func (c *BackupGateway) GetHypervisorPropertyMappings(input *GetHypervisorPropertyMappingsInput) (*GetHypervisorPropertyMappingsOutput, error)

GetHypervisorPropertyMappings API operation for AWS Backup Gateway.

This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation GetHypervisorPropertyMappings for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappings

func (*BackupGateway) GetHypervisorPropertyMappingsRequest added in v1.44.161 

func (c *BackupGateway) GetHypervisorPropertyMappingsRequest(input *GetHypervisorPropertyMappingsInput) (req *request.Request, output *GetHypervisorPropertyMappingsOutput)

GetHypervisorPropertyMappingsRequest generates a "aws/request.Request" representing the client's request for the GetHypervisorPropertyMappings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetHypervisorPropertyMappings for more information on using the GetHypervisorPropertyMappings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetHypervisorPropertyMappingsRequest method.
req, resp := client.GetHypervisorPropertyMappingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappings

func (*BackupGateway) GetHypervisorPropertyMappingsWithContext added in v1.44.161 

func (c *BackupGateway) GetHypervisorPropertyMappingsWithContext(ctx aws.Context, input *GetHypervisorPropertyMappingsInput, opts ...request.Option) (*GetHypervisorPropertyMappingsOutput, error)

GetHypervisorPropertyMappingsWithContext is the same as GetHypervisorPropertyMappings with the addition of the ability to pass a context and additional request options.

See GetHypervisorPropertyMappings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) GetHypervisorRequest added in v1.44.161 

func (c *BackupGateway) GetHypervisorRequest(input *GetHypervisorInput) (req *request.Request, output *GetHypervisorOutput)

GetHypervisorRequest generates a "aws/request.Request" representing the client's request for the GetHypervisor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetHypervisor for more information on using the GetHypervisor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetHypervisorRequest method.
req, resp := client.GetHypervisorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisor

func (*BackupGateway) GetHypervisorWithContext added in v1.44.161 

func (c *BackupGateway) GetHypervisorWithContext(ctx aws.Context, input *GetHypervisorInput, opts ...request.Option) (*GetHypervisorOutput, error)

GetHypervisorWithContext is the same as GetHypervisor with the addition of the ability to pass a context and additional request options.

See GetHypervisor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) GetVirtualMachine added in v1.44.104 

func (c *BackupGateway) GetVirtualMachine(input *GetVirtualMachineInput) (*GetVirtualMachineOutput, error)

GetVirtualMachine API operation for AWS Backup Gateway.

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation GetVirtualMachine for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetVirtualMachine

func (*BackupGateway) GetVirtualMachineRequest added in v1.44.104 

func (c *BackupGateway) GetVirtualMachineRequest(input *GetVirtualMachineInput) (req *request.Request, output *GetVirtualMachineOutput)

GetVirtualMachineRequest generates a "aws/request.Request" representing the client's request for the GetVirtualMachine operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetVirtualMachine for more information on using the GetVirtualMachine API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetVirtualMachineRequest method.
req, resp := client.GetVirtualMachineRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetVirtualMachine

func (*BackupGateway) GetVirtualMachineWithContext added in v1.44.104 

func (c *BackupGateway) GetVirtualMachineWithContext(ctx aws.Context, input *GetVirtualMachineInput, opts ...request.Option) (*GetVirtualMachineOutput, error)

GetVirtualMachineWithContext is the same as GetVirtualMachine with the addition of the ability to pass a context and additional request options.

See GetVirtualMachine for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) ImportHypervisorConfiguration 

func (c *BackupGateway) ImportHypervisorConfiguration(input *ImportHypervisorConfigurationInput) (*ImportHypervisorConfigurationOutput, error)

ImportHypervisorConfiguration API operation for AWS Backup Gateway.

Connect to a hypervisor by importing its configuration.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation ImportHypervisorConfiguration for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • ConflictException The operation cannot proceed because it is not supported.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException The operation cannot proceed because you have insufficient permissions.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ImportHypervisorConfiguration

func (*BackupGateway) ImportHypervisorConfigurationRequest 

func (c *BackupGateway) ImportHypervisorConfigurationRequest(input *ImportHypervisorConfigurationInput) (req *request.Request, output *ImportHypervisorConfigurationOutput)

ImportHypervisorConfigurationRequest generates a "aws/request.Request" representing the client's request for the ImportHypervisorConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportHypervisorConfiguration for more information on using the ImportHypervisorConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ImportHypervisorConfigurationRequest method.
req, resp := client.ImportHypervisorConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ImportHypervisorConfiguration

func (*BackupGateway) ImportHypervisorConfigurationWithContext 

func (c *BackupGateway) ImportHypervisorConfigurationWithContext(ctx aws.Context, input *ImportHypervisorConfigurationInput, opts ...request.Option) (*ImportHypervisorConfigurationOutput, error)

ImportHypervisorConfigurationWithContext is the same as ImportHypervisorConfiguration with the addition of the ability to pass a context and additional request options.

See ImportHypervisorConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) ListGateways 

func (c *BackupGateway) ListGateways(input *ListGatewaysInput) (*ListGatewaysOutput, error)

ListGateways API operation for AWS Backup Gateway.

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation ListGateways for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListGateways

func (*BackupGateway) ListGatewaysPages 

func (c *BackupGateway) ListGatewaysPages(input *ListGatewaysInput, fn func(*ListGatewaysOutput, bool) bool) error

ListGatewaysPages iterates over the pages of a ListGateways operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGateways method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListGateways operation.
pageNum := 0
err := client.ListGatewaysPages(params,
    func(page *backupgateway.ListGatewaysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BackupGateway) ListGatewaysPagesWithContext 

func (c *BackupGateway) ListGatewaysPagesWithContext(ctx aws.Context, input *ListGatewaysInput, fn func(*ListGatewaysOutput, bool) bool, opts ...request.Option) error

ListGatewaysPagesWithContext same as ListGatewaysPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) ListGatewaysRequest 

func (c *BackupGateway) ListGatewaysRequest(input *ListGatewaysInput) (req *request.Request, output *ListGatewaysOutput)

ListGatewaysRequest generates a "aws/request.Request" representing the client's request for the ListGateways operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGateways for more information on using the ListGateways API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGatewaysRequest method.
req, resp := client.ListGatewaysRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListGateways

func (*BackupGateway) ListGatewaysWithContext 

func (c *BackupGateway) ListGatewaysWithContext(ctx aws.Context, input *ListGatewaysInput, opts ...request.Option) (*ListGatewaysOutput, error)

ListGatewaysWithContext is the same as ListGateways with the addition of the ability to pass a context and additional request options.

See ListGateways for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) ListHypervisors 

func (c *BackupGateway) ListHypervisors(input *ListHypervisorsInput) (*ListHypervisorsOutput, error)

ListHypervisors API operation for AWS Backup Gateway.

Lists your hypervisors.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation ListHypervisors for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListHypervisors

func (*BackupGateway) ListHypervisorsPages 

func (c *BackupGateway) ListHypervisorsPages(input *ListHypervisorsInput, fn func(*ListHypervisorsOutput, bool) bool) error

ListHypervisorsPages iterates over the pages of a ListHypervisors operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListHypervisors method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListHypervisors operation.
pageNum := 0
err := client.ListHypervisorsPages(params,
    func(page *backupgateway.ListHypervisorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BackupGateway) ListHypervisorsPagesWithContext 

func (c *BackupGateway) ListHypervisorsPagesWithContext(ctx aws.Context, input *ListHypervisorsInput, fn func(*ListHypervisorsOutput, bool) bool, opts ...request.Option) error

ListHypervisorsPagesWithContext same as ListHypervisorsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) ListHypervisorsRequest 

func (c *BackupGateway) ListHypervisorsRequest(input *ListHypervisorsInput) (req *request.Request, output *ListHypervisorsOutput)

ListHypervisorsRequest generates a "aws/request.Request" representing the client's request for the ListHypervisors operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListHypervisors for more information on using the ListHypervisors API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListHypervisorsRequest method.
req, resp := client.ListHypervisorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListHypervisors

func (*BackupGateway) ListHypervisorsWithContext 

func (c *BackupGateway) ListHypervisorsWithContext(ctx aws.Context, input *ListHypervisorsInput, opts ...request.Option) (*ListHypervisorsOutput, error)

ListHypervisorsWithContext is the same as ListHypervisors with the addition of the ability to pass a context and additional request options.

See ListHypervisors for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) ListTagsForResource 

func (c *BackupGateway) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Backup Gateway.

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListTagsForResource

func (*BackupGateway) ListTagsForResourceRequest 

func (c *BackupGateway) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListTagsForResource

func (*BackupGateway) ListTagsForResourceWithContext 

func (c *BackupGateway) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) ListVirtualMachines 

func (c *BackupGateway) ListVirtualMachines(input *ListVirtualMachinesInput) (*ListVirtualMachinesOutput, error)

ListVirtualMachines API operation for AWS Backup Gateway.

Lists your virtual machines.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation ListVirtualMachines for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListVirtualMachines

func (*BackupGateway) ListVirtualMachinesPages 

func (c *BackupGateway) ListVirtualMachinesPages(input *ListVirtualMachinesInput, fn func(*ListVirtualMachinesOutput, bool) bool) error

ListVirtualMachinesPages iterates over the pages of a ListVirtualMachines operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListVirtualMachines method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListVirtualMachines operation.
pageNum := 0
err := client.ListVirtualMachinesPages(params,
    func(page *backupgateway.ListVirtualMachinesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BackupGateway) ListVirtualMachinesPagesWithContext 

func (c *BackupGateway) ListVirtualMachinesPagesWithContext(ctx aws.Context, input *ListVirtualMachinesInput, fn func(*ListVirtualMachinesOutput, bool) bool, opts ...request.Option) error

ListVirtualMachinesPagesWithContext same as ListVirtualMachinesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) ListVirtualMachinesRequest 

func (c *BackupGateway) ListVirtualMachinesRequest(input *ListVirtualMachinesInput) (req *request.Request, output *ListVirtualMachinesOutput)

ListVirtualMachinesRequest generates a "aws/request.Request" representing the client's request for the ListVirtualMachines operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListVirtualMachines for more information on using the ListVirtualMachines API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListVirtualMachinesRequest method.
req, resp := client.ListVirtualMachinesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListVirtualMachines

func (*BackupGateway) ListVirtualMachinesWithContext 

func (c *BackupGateway) ListVirtualMachinesWithContext(ctx aws.Context, input *ListVirtualMachinesInput, opts ...request.Option) (*ListVirtualMachinesOutput, error)

ListVirtualMachinesWithContext is the same as ListVirtualMachines with the addition of the ability to pass a context and additional request options.

See ListVirtualMachines for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) PutBandwidthRateLimitSchedule added in v1.44.161 

func (c *BackupGateway) PutBandwidthRateLimitSchedule(input *PutBandwidthRateLimitScheduleInput) (*PutBandwidthRateLimitScheduleOutput, error)

PutBandwidthRateLimitSchedule API operation for AWS Backup Gateway.

This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation PutBandwidthRateLimitSchedule for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule

func (*BackupGateway) PutBandwidthRateLimitScheduleRequest added in v1.44.161 

func (c *BackupGateway) PutBandwidthRateLimitScheduleRequest(input *PutBandwidthRateLimitScheduleInput) (req *request.Request, output *PutBandwidthRateLimitScheduleOutput)

PutBandwidthRateLimitScheduleRequest generates a "aws/request.Request" representing the client's request for the PutBandwidthRateLimitSchedule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutBandwidthRateLimitSchedule for more information on using the PutBandwidthRateLimitSchedule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutBandwidthRateLimitScheduleRequest method.
req, resp := client.PutBandwidthRateLimitScheduleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule

func (*BackupGateway) PutBandwidthRateLimitScheduleWithContext added in v1.44.161 

func (c *BackupGateway) PutBandwidthRateLimitScheduleWithContext(ctx aws.Context, input *PutBandwidthRateLimitScheduleInput, opts ...request.Option) (*PutBandwidthRateLimitScheduleOutput, error)

PutBandwidthRateLimitScheduleWithContext is the same as PutBandwidthRateLimitSchedule with the addition of the ability to pass a context and additional request options.

See PutBandwidthRateLimitSchedule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) PutHypervisorPropertyMappings added in v1.44.161 

func (c *BackupGateway) PutHypervisorPropertyMappings(input *PutHypervisorPropertyMappingsInput) (*PutHypervisorPropertyMappingsOutput, error)

PutHypervisorPropertyMappings API operation for AWS Backup Gateway.

This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation PutHypervisorPropertyMappings for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • ConflictException The operation cannot proceed because it is not supported.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException The operation cannot proceed because you have insufficient permissions.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutHypervisorPropertyMappings

func (*BackupGateway) PutHypervisorPropertyMappingsRequest added in v1.44.161 

func (c *BackupGateway) PutHypervisorPropertyMappingsRequest(input *PutHypervisorPropertyMappingsInput) (req *request.Request, output *PutHypervisorPropertyMappingsOutput)

PutHypervisorPropertyMappingsRequest generates a "aws/request.Request" representing the client's request for the PutHypervisorPropertyMappings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutHypervisorPropertyMappings for more information on using the PutHypervisorPropertyMappings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutHypervisorPropertyMappingsRequest method.
req, resp := client.PutHypervisorPropertyMappingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutHypervisorPropertyMappings

func (*BackupGateway) PutHypervisorPropertyMappingsWithContext added in v1.44.161 

func (c *BackupGateway) PutHypervisorPropertyMappingsWithContext(ctx aws.Context, input *PutHypervisorPropertyMappingsInput, opts ...request.Option) (*PutHypervisorPropertyMappingsOutput, error)

PutHypervisorPropertyMappingsWithContext is the same as PutHypervisorPropertyMappings with the addition of the ability to pass a context and additional request options.

See PutHypervisorPropertyMappings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) PutMaintenanceStartTime 

func (c *BackupGateway) PutMaintenanceStartTime(input *PutMaintenanceStartTimeInput) (*PutMaintenanceStartTimeOutput, error)

PutMaintenanceStartTime API operation for AWS Backup Gateway.

Set the maintenance start time for a gateway.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation PutMaintenanceStartTime for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • ConflictException The operation cannot proceed because it is not supported.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutMaintenanceStartTime

func (*BackupGateway) PutMaintenanceStartTimeRequest 

func (c *BackupGateway) PutMaintenanceStartTimeRequest(input *PutMaintenanceStartTimeInput) (req *request.Request, output *PutMaintenanceStartTimeOutput)

PutMaintenanceStartTimeRequest generates a "aws/request.Request" representing the client's request for the PutMaintenanceStartTime operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutMaintenanceStartTime for more information on using the PutMaintenanceStartTime API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutMaintenanceStartTimeRequest method.
req, resp := client.PutMaintenanceStartTimeRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutMaintenanceStartTime

func (*BackupGateway) PutMaintenanceStartTimeWithContext 

func (c *BackupGateway) PutMaintenanceStartTimeWithContext(ctx aws.Context, input *PutMaintenanceStartTimeInput, opts ...request.Option) (*PutMaintenanceStartTimeOutput, error)

PutMaintenanceStartTimeWithContext is the same as PutMaintenanceStartTime with the addition of the ability to pass a context and additional request options.

See PutMaintenanceStartTime for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) StartVirtualMachinesMetadataSync added in v1.44.161 

func (c *BackupGateway) StartVirtualMachinesMetadataSync(input *StartVirtualMachinesMetadataSyncInput) (*StartVirtualMachinesMetadataSyncOutput, error)

StartVirtualMachinesMetadataSync API operation for AWS Backup Gateway.

This action sends a request to sync metadata across the specified virtual machines.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation StartVirtualMachinesMetadataSync for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException The operation cannot proceed because you have insufficient permissions.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync

func (*BackupGateway) StartVirtualMachinesMetadataSyncRequest added in v1.44.161 

func (c *BackupGateway) StartVirtualMachinesMetadataSyncRequest(input *StartVirtualMachinesMetadataSyncInput) (req *request.Request, output *StartVirtualMachinesMetadataSyncOutput)

StartVirtualMachinesMetadataSyncRequest generates a "aws/request.Request" representing the client's request for the StartVirtualMachinesMetadataSync operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartVirtualMachinesMetadataSync for more information on using the StartVirtualMachinesMetadataSync API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartVirtualMachinesMetadataSyncRequest method.
req, resp := client.StartVirtualMachinesMetadataSyncRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync

func (*BackupGateway) StartVirtualMachinesMetadataSyncWithContext added in v1.44.161 

func (c *BackupGateway) StartVirtualMachinesMetadataSyncWithContext(ctx aws.Context, input *StartVirtualMachinesMetadataSyncInput, opts ...request.Option) (*StartVirtualMachinesMetadataSyncOutput, error)

StartVirtualMachinesMetadataSyncWithContext is the same as StartVirtualMachinesMetadataSync with the addition of the ability to pass a context and additional request options.

See StartVirtualMachinesMetadataSync for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) TagResource 

func (c *BackupGateway) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Backup Gateway.

Tag the resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation TagResource for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/TagResource

func (*BackupGateway) TagResourceRequest 

func (c *BackupGateway) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/TagResource

func (*BackupGateway) TagResourceWithContext 

func (c *BackupGateway) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) TestHypervisorConfiguration 

func (c *BackupGateway) TestHypervisorConfiguration(input *TestHypervisorConfigurationInput) (*TestHypervisorConfigurationOutput, error)

TestHypervisorConfiguration API operation for AWS Backup Gateway.

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation TestHypervisorConfiguration for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • ConflictException The operation cannot proceed because it is not supported.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/TestHypervisorConfiguration

func (*BackupGateway) TestHypervisorConfigurationRequest 

func (c *BackupGateway) TestHypervisorConfigurationRequest(input *TestHypervisorConfigurationInput) (req *request.Request, output *TestHypervisorConfigurationOutput)

TestHypervisorConfigurationRequest generates a "aws/request.Request" representing the client's request for the TestHypervisorConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestHypervisorConfiguration for more information on using the TestHypervisorConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TestHypervisorConfigurationRequest method.
req, resp := client.TestHypervisorConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/TestHypervisorConfiguration

func (*BackupGateway) TestHypervisorConfigurationWithContext 

func (c *BackupGateway) TestHypervisorConfigurationWithContext(ctx aws.Context, input *TestHypervisorConfigurationInput, opts ...request.Option) (*TestHypervisorConfigurationOutput, error)

TestHypervisorConfigurationWithContext is the same as TestHypervisorConfiguration with the addition of the ability to pass a context and additional request options.

See TestHypervisorConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) UntagResource 

func (c *BackupGateway) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Backup Gateway.

Removes tags from the resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UntagResource

func (*BackupGateway) UntagResourceRequest 

func (c *BackupGateway) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UntagResource

func (*BackupGateway) UntagResourceWithContext 

func (c *BackupGateway) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) UpdateGatewayInformation 

func (c *BackupGateway) UpdateGatewayInformation(input *UpdateGatewayInformationInput) (*UpdateGatewayInformationOutput, error)

UpdateGatewayInformation API operation for AWS Backup Gateway.

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation UpdateGatewayInformation for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • ConflictException The operation cannot proceed because it is not supported.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewayInformation

func (*BackupGateway) UpdateGatewayInformationRequest 

func (c *BackupGateway) UpdateGatewayInformationRequest(input *UpdateGatewayInformationInput) (req *request.Request, output *UpdateGatewayInformationOutput)

UpdateGatewayInformationRequest generates a "aws/request.Request" representing the client's request for the UpdateGatewayInformation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGatewayInformation for more information on using the UpdateGatewayInformation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateGatewayInformationRequest method.
req, resp := client.UpdateGatewayInformationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewayInformation

func (*BackupGateway) UpdateGatewayInformationWithContext 

func (c *BackupGateway) UpdateGatewayInformationWithContext(ctx aws.Context, input *UpdateGatewayInformationInput, opts ...request.Option) (*UpdateGatewayInformationOutput, error)

UpdateGatewayInformationWithContext is the same as UpdateGatewayInformation with the addition of the ability to pass a context and additional request options.

See UpdateGatewayInformation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) UpdateGatewaySoftwareNow added in v1.44.26 

func (c *BackupGateway) UpdateGatewaySoftwareNow(input *UpdateGatewaySoftwareNowInput) (*UpdateGatewaySoftwareNowOutput, error)

UpdateGatewaySoftwareNow API operation for AWS Backup Gateway.

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation UpdateGatewaySoftwareNow for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow

func (*BackupGateway) UpdateGatewaySoftwareNowRequest added in v1.44.26 

func (c *BackupGateway) UpdateGatewaySoftwareNowRequest(input *UpdateGatewaySoftwareNowInput) (req *request.Request, output *UpdateGatewaySoftwareNowOutput)

UpdateGatewaySoftwareNowRequest generates a "aws/request.Request" representing the client's request for the UpdateGatewaySoftwareNow operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGatewaySoftwareNow for more information on using the UpdateGatewaySoftwareNow API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateGatewaySoftwareNowRequest method.
req, resp := client.UpdateGatewaySoftwareNowRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow

func (*BackupGateway) UpdateGatewaySoftwareNowWithContext added in v1.44.26 

func (c *BackupGateway) UpdateGatewaySoftwareNowWithContext(ctx aws.Context, input *UpdateGatewaySoftwareNowInput, opts ...request.Option) (*UpdateGatewaySoftwareNowOutput, error)

UpdateGatewaySoftwareNowWithContext is the same as UpdateGatewaySoftwareNow with the addition of the ability to pass a context and additional request options.

See UpdateGatewaySoftwareNow for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BackupGateway) UpdateHypervisor 

func (c *BackupGateway) UpdateHypervisor(input *UpdateHypervisorInput) (*UpdateHypervisorOutput, error)

UpdateHypervisor API operation for AWS Backup Gateway.

Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup Gateway's API operation UpdateHypervisor for usage and error information.

Returned Error Types:

  • ValidationException The operation did not succeed because a validation error occurred.

  • ConflictException The operation cannot proceed because it is not supported.

  • InternalServerException The operation did not succeed because an internal error occurred. Try again later.

  • AccessDeniedException The operation cannot proceed because you have insufficient permissions.

  • ResourceNotFoundException A resource that is required for the action wasn't found.

  • ThrottlingException TPS has been limited to protect against intentional or unintentional high request volumes.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateHypervisor

func (*BackupGateway) UpdateHypervisorRequest 

func (c *BackupGateway) UpdateHypervisorRequest(input *UpdateHypervisorInput) (req *request.Request, output *UpdateHypervisorOutput)

UpdateHypervisorRequest generates a "aws/request.Request" representing the client's request for the UpdateHypervisor operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateHypervisor for more information on using the UpdateHypervisor API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateHypervisorRequest method.
req, resp := client.UpdateHypervisorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateHypervisor

func (*BackupGateway) UpdateHypervisorWithContext 

func (c *BackupGateway) UpdateHypervisorWithContext(ctx aws.Context, input *UpdateHypervisorInput, opts ...request.Option) (*UpdateHypervisorOutput, error)

UpdateHypervisorWithContext is the same as UpdateHypervisor with the addition of the ability to pass a context and additional request options.

See UpdateHypervisor for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type BandwidthRateLimitInterval added in v1.44.161 

type BandwidthRateLimitInterval struct {

	// 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 `min:"51200" type:"long"`

	// 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.
	//
	// DaysOfWeek is a required field
	DaysOfWeek []*int64 `min:"1" type:"list" required:"true"`

	// The hour of the day to end the bandwidth rate limit interval.
	//
	// EndHourOfDay is a required field
	EndHourOfDay *int64 `type:"integer" required:"true"`

	// 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.
	//
	// EndMinuteOfHour is a required field
	EndMinuteOfHour *int64 `type:"integer" required:"true"`

	// The hour of the day to start the bandwidth rate limit interval.
	//
	// StartHourOfDay is a required field
	StartHourOfDay *int64 `type:"integer" required:"true"`

	// 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.
	//
	// StartMinuteOfHour is a required field
	StartMinuteOfHour *int64 `type:"integer" required:"true"`
	// 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.

func (BandwidthRateLimitInterval) GoString added in v1.44.161 

func (s BandwidthRateLimitInterval) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BandwidthRateLimitInterval) SetAverageUploadRateLimitInBitsPerSec added in v1.44.161 

func (s *BandwidthRateLimitInterval) SetAverageUploadRateLimitInBitsPerSec(v int64) *BandwidthRateLimitInterval

SetAverageUploadRateLimitInBitsPerSec sets the AverageUploadRateLimitInBitsPerSec field's value.

func (*BandwidthRateLimitInterval) SetDaysOfWeek added in v1.44.161 

func (s *BandwidthRateLimitInterval) SetDaysOfWeek(v []*int64) *BandwidthRateLimitInterval

SetDaysOfWeek sets the DaysOfWeek field's value.

func (*BandwidthRateLimitInterval) SetEndHourOfDay added in v1.44.161 

func (s *BandwidthRateLimitInterval) SetEndHourOfDay(v int64) *BandwidthRateLimitInterval

SetEndHourOfDay sets the EndHourOfDay field's value.

func (*BandwidthRateLimitInterval) SetEndMinuteOfHour added in v1.44.161 

func (s *BandwidthRateLimitInterval) SetEndMinuteOfHour(v int64) *BandwidthRateLimitInterval

SetEndMinuteOfHour sets the EndMinuteOfHour field's value.

func (*BandwidthRateLimitInterval) SetStartHourOfDay added in v1.44.161 

func (s *BandwidthRateLimitInterval) SetStartHourOfDay(v int64) *BandwidthRateLimitInterval

SetStartHourOfDay sets the StartHourOfDay field's value.

func (*BandwidthRateLimitInterval) SetStartMinuteOfHour added in v1.44.161 

func (s *BandwidthRateLimitInterval) SetStartMinuteOfHour(v int64) *BandwidthRateLimitInterval

SetStartMinuteOfHour sets the StartMinuteOfHour field's value.

func (BandwidthRateLimitInterval) String added in v1.44.161 

func (s BandwidthRateLimitInterval) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BandwidthRateLimitInterval) Validate added in v1.44.161 

func (s *BandwidthRateLimitInterval) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of why the operation is not supported.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation cannot proceed because it is not supported.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateGatewayInput 

type CreateGatewayInput struct {

	// The activation key of the created gateway.
	//
	// ActivationKey is a required field
	ActivationKey *string `min:"1" type:"string" required:"true"`

	// The display name of the created gateway.
	//
	// GatewayDisplayName is a required field
	GatewayDisplayName *string `min:"1" type:"string" required:"true"`

	// The type of created gateway.
	//
	// GatewayType is a required field
	GatewayType *string `type:"string" required:"true" enum:"GatewayType"`

	// A list of up to 50 tags to assign to the gateway. Each tag is a key-value
	// pair.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateGatewayInput) GoString 

func (s CreateGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGatewayInput) SetActivationKey 

func (s *CreateGatewayInput) SetActivationKey(v string) *CreateGatewayInput

SetActivationKey sets the ActivationKey field's value.

func (*CreateGatewayInput) SetGatewayDisplayName 

func (s *CreateGatewayInput) SetGatewayDisplayName(v string) *CreateGatewayInput

SetGatewayDisplayName sets the GatewayDisplayName field's value.

func (*CreateGatewayInput) SetGatewayType 

func (s *CreateGatewayInput) SetGatewayType(v string) *CreateGatewayInput

SetGatewayType sets the GatewayType field's value.

func (*CreateGatewayInput) SetTags 

func (s *CreateGatewayInput) SetTags(v []*Tag) *CreateGatewayInput

SetTags sets the Tags field's value.

func (CreateGatewayInput) String 

func (s CreateGatewayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGatewayInput) Validate 

func (s *CreateGatewayInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateGatewayOutput 

type CreateGatewayOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you create.
	GatewayArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (CreateGatewayOutput) GoString 

func (s CreateGatewayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGatewayOutput) SetGatewayArn 

func (s *CreateGatewayOutput) SetGatewayArn(v string) *CreateGatewayOutput

SetGatewayArn sets the GatewayArn field's value.

func (CreateGatewayOutput) String 

func (s CreateGatewayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteGatewayInput 

type DeleteGatewayInput struct {

	// The Amazon Resource Name (ARN) of the gateway to delete.
	//
	// GatewayArn is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGatewayInput) GoString 

func (s DeleteGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGatewayInput) SetGatewayArn 

func (s *DeleteGatewayInput) SetGatewayArn(v string) *DeleteGatewayInput

SetGatewayArn sets the GatewayArn field's value.

func (DeleteGatewayInput) String 

func (s DeleteGatewayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGatewayInput) Validate 

func (s *DeleteGatewayInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteGatewayOutput 

type DeleteGatewayOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you deleted.
	GatewayArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteGatewayOutput) GoString 

func (s DeleteGatewayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGatewayOutput) SetGatewayArn 

func (s *DeleteGatewayOutput) SetGatewayArn(v string) *DeleteGatewayOutput

SetGatewayArn sets the GatewayArn field's value.

func (DeleteGatewayOutput) String 

func (s DeleteGatewayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteHypervisorInput 

type DeleteHypervisorInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor to delete.
	//
	// HypervisorArn is a required field
	HypervisorArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteHypervisorInput) GoString 

func (s DeleteHypervisorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteHypervisorInput) SetHypervisorArn 

func (s *DeleteHypervisorInput) SetHypervisorArn(v string) *DeleteHypervisorInput

SetHypervisorArn sets the HypervisorArn field's value.

func (DeleteHypervisorInput) String 

func (s DeleteHypervisorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteHypervisorInput) Validate 

func (s *DeleteHypervisorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteHypervisorOutput 

type DeleteHypervisorOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor you deleted.
	HypervisorArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteHypervisorOutput) GoString 

func (s DeleteHypervisorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteHypervisorOutput) SetHypervisorArn 

func (s *DeleteHypervisorOutput) SetHypervisorArn(v string) *DeleteHypervisorOutput

SetHypervisorArn sets the HypervisorArn field's value.

func (DeleteHypervisorOutput) String 

func (s DeleteHypervisorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateGatewayFromServerInput 

type DisassociateGatewayFromServerInput struct {

	// The Amazon Resource Name (ARN) of the gateway to disassociate.
	//
	// GatewayArn is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateGatewayFromServerInput) GoString 

func (s DisassociateGatewayFromServerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateGatewayFromServerInput) SetGatewayArn 

func (s *DisassociateGatewayFromServerInput) SetGatewayArn(v string) *DisassociateGatewayFromServerInput

SetGatewayArn sets the GatewayArn field's value.

func (DisassociateGatewayFromServerInput) String 

func (s DisassociateGatewayFromServerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateGatewayFromServerInput) Validate 

func (s *DisassociateGatewayFromServerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateGatewayFromServerOutput 

type DisassociateGatewayFromServerOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you disassociated.
	GatewayArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (DisassociateGatewayFromServerOutput) GoString 

func (s DisassociateGatewayFromServerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateGatewayFromServerOutput) SetGatewayArn 

func (s *DisassociateGatewayFromServerOutput) SetGatewayArn(v string) *DisassociateGatewayFromServerOutput

SetGatewayArn sets the GatewayArn field's value.

func (DisassociateGatewayFromServerOutput) String 

func (s DisassociateGatewayFromServerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"50" type:"string"`

	// The display name of the gateway.
	GatewayDisplayName *string `min:"1" type:"string"`

	// The type of the gateway.
	GatewayType *string `type:"string" enum:"GatewayType"`

	// The hypervisor ID of the gateway.
	HypervisorId *string `min:"1" type:"string"`

	// The last time Backup gateway communicated with the gateway, in Unix format
	// and UTC time.
	LastSeenTime *time.Time `type:"timestamp"`
	// 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.

func (Gateway) GoString 

func (s Gateway) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Gateway) SetGatewayArn 

func (s *Gateway) SetGatewayArn(v string) *Gateway

SetGatewayArn sets the GatewayArn field's value.

func (*Gateway) SetGatewayDisplayName 

func (s *Gateway) SetGatewayDisplayName(v string) *Gateway

SetGatewayDisplayName sets the GatewayDisplayName field's value.

func (*Gateway) SetGatewayType 

func (s *Gateway) SetGatewayType(v string) *Gateway

SetGatewayType sets the GatewayType field's value.

func (*Gateway) SetHypervisorId 

func (s *Gateway) SetHypervisorId(v string) *Gateway

SetHypervisorId sets the HypervisorId field's value.

func (*Gateway) SetLastSeenTime 

func (s *Gateway) SetLastSeenTime(v time.Time) *Gateway

SetLastSeenTime sets the LastSeenTime field's value.

func (Gateway) String 

func (s Gateway) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GatewayDetails added in v1.44.26 

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 `min:"50" type:"string"`

	// The display name of the gateway.
	GatewayDisplayName *string `min:"1" type:"string"`

	// The type of the gateway type.
	GatewayType *string `type:"string" enum:"GatewayType"`

	// The hypervisor ID of the gateway.
	HypervisorId *string `min:"1" type:"string"`

	// Details showing the last time Backup gateway communicated with the cloud,
	// in Unix format and UTC time.
	LastSeenTime *time.Time `type:"timestamp"`

	// 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 `type:"structure"`

	// Details showing the next update availability time of the gateway.
	NextUpdateAvailabilityTime *time.Time `type:"timestamp"`

	// The DNS name for the virtual private cloud (VPC) endpoint the gateway uses
	// to connect to the cloud for backup gateway.
	VpcEndpoint *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The details of gateway.

func (GatewayDetails) GoString added in v1.44.26 

func (s GatewayDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GatewayDetails) SetGatewayArn added in v1.44.26 

func (s *GatewayDetails) SetGatewayArn(v string) *GatewayDetails

SetGatewayArn sets the GatewayArn field's value.

func (*GatewayDetails) SetGatewayDisplayName added in v1.44.26 

func (s *GatewayDetails) SetGatewayDisplayName(v string) *GatewayDetails

SetGatewayDisplayName sets the GatewayDisplayName field's value.

func (*GatewayDetails) SetGatewayType added in v1.44.26 

func (s *GatewayDetails) SetGatewayType(v string) *GatewayDetails

SetGatewayType sets the GatewayType field's value.

func (*GatewayDetails) SetHypervisorId added in v1.44.26 

func (s *GatewayDetails) SetHypervisorId(v string) *GatewayDetails

SetHypervisorId sets the HypervisorId field's value.

func (*GatewayDetails) SetLastSeenTime added in v1.44.26 

func (s *GatewayDetails) SetLastSeenTime(v time.Time) *GatewayDetails

SetLastSeenTime sets the LastSeenTime field's value.

func (*GatewayDetails) SetMaintenanceStartTime added in v1.44.104 

func (s *GatewayDetails) SetMaintenanceStartTime(v *MaintenanceStartTime) *GatewayDetails

SetMaintenanceStartTime sets the MaintenanceStartTime field's value.

func (*GatewayDetails) SetNextUpdateAvailabilityTime added in v1.44.26 

func (s *GatewayDetails) SetNextUpdateAvailabilityTime(v time.Time) *GatewayDetails

SetNextUpdateAvailabilityTime sets the NextUpdateAvailabilityTime field's value.

func (*GatewayDetails) SetVpcEndpoint added in v1.44.26 

func (s *GatewayDetails) SetVpcEndpoint(v string) *GatewayDetails

SetVpcEndpoint sets the VpcEndpoint field's value.

func (GatewayDetails) String added in v1.44.26 

func (s GatewayDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetBandwidthRateLimitScheduleInput added in v1.44.161 

type GetBandwidthRateLimitScheduleInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)
	// operation to return a list of gateways for your account and Amazon Web Services
	// Region.
	//
	// GatewayArn is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBandwidthRateLimitScheduleInput) GoString added in v1.44.161 

func (s GetBandwidthRateLimitScheduleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBandwidthRateLimitScheduleInput) SetGatewayArn added in v1.44.161 

func (s *GetBandwidthRateLimitScheduleInput) SetGatewayArn(v string) *GetBandwidthRateLimitScheduleInput

SetGatewayArn sets the GatewayArn field's value.

func (GetBandwidthRateLimitScheduleInput) String added in v1.44.161 

func (s GetBandwidthRateLimitScheduleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBandwidthRateLimitScheduleInput) Validate added in v1.44.161 

func (s *GetBandwidthRateLimitScheduleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBandwidthRateLimitScheduleOutput added in v1.44.161 

type GetBandwidthRateLimitScheduleOutput struct {

	// An array containing bandwidth rate limit schedule intervals for a gateway.
	// When no bandwidth rate limit intervals have been scheduled, the array is
	// empty.
	BandwidthRateLimitIntervals []*BandwidthRateLimitInterval `type:"list"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)
	// operation to return a list of gateways for your account and Amazon Web Services
	// Region.
	GatewayArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (GetBandwidthRateLimitScheduleOutput) GoString added in v1.44.161 

func (s GetBandwidthRateLimitScheduleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBandwidthRateLimitScheduleOutput) SetBandwidthRateLimitIntervals added in v1.44.161 

func (s *GetBandwidthRateLimitScheduleOutput) SetBandwidthRateLimitIntervals(v []*BandwidthRateLimitInterval) *GetBandwidthRateLimitScheduleOutput

SetBandwidthRateLimitIntervals sets the BandwidthRateLimitIntervals field's value.

func (*GetBandwidthRateLimitScheduleOutput) SetGatewayArn added in v1.44.161 

func (s *GetBandwidthRateLimitScheduleOutput) SetGatewayArn(v string) *GetBandwidthRateLimitScheduleOutput

SetGatewayArn sets the GatewayArn field's value.

func (GetBandwidthRateLimitScheduleOutput) String added in v1.44.161 

func (s GetBandwidthRateLimitScheduleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetGatewayInput added in v1.44.26 

type GetGatewayInput struct {

	// The Amazon Resource Name (ARN) of the gateway.
	//
	// GatewayArn is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetGatewayInput) GoString added in v1.44.26 

func (s GetGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetGatewayInput) SetGatewayArn added in v1.44.26 

func (s *GetGatewayInput) SetGatewayArn(v string) *GetGatewayInput

SetGatewayArn sets the GatewayArn field's value.

func (GetGatewayInput) String added in v1.44.26 

func (s GetGatewayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetGatewayInput) Validate added in v1.44.26 

func (s *GetGatewayInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetGatewayOutput added in v1.44.26 

type GetGatewayOutput struct {

	// By providing the ARN (Amazon Resource Name), this API returns the gateway.
	Gateway *GatewayDetails `type:"structure"`
	// contains filtered or unexported fields
}

func (GetGatewayOutput) GoString added in v1.44.26 

func (s GetGatewayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetGatewayOutput) SetGateway added in v1.44.26 

func (s *GetGatewayOutput) SetGateway(v *GatewayDetails) *GetGatewayOutput

SetGateway sets the Gateway field's value.

func (GetGatewayOutput) String added in v1.44.26 

func (s GetGatewayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetHypervisorInput added in v1.44.161 

type GetHypervisorInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	//
	// HypervisorArn is a required field
	HypervisorArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetHypervisorInput) GoString added in v1.44.161 

func (s GetHypervisorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetHypervisorInput) SetHypervisorArn added in v1.44.161 

func (s *GetHypervisorInput) SetHypervisorArn(v string) *GetHypervisorInput

SetHypervisorArn sets the HypervisorArn field's value.

func (GetHypervisorInput) String added in v1.44.161 

func (s GetHypervisorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetHypervisorInput) Validate added in v1.44.161 

func (s *GetHypervisorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetHypervisorOutput added in v1.44.161 

type GetHypervisorOutput struct {

	// Details about the requested hypervisor.
	Hypervisor *HypervisorDetails `type:"structure"`
	// contains filtered or unexported fields
}

func (GetHypervisorOutput) GoString added in v1.44.161 

func (s GetHypervisorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetHypervisorOutput) SetHypervisor added in v1.44.161 

func (s *GetHypervisorOutput) SetHypervisor(v *HypervisorDetails) *GetHypervisorOutput

SetHypervisor sets the Hypervisor field's value.

func (GetHypervisorOutput) String added in v1.44.161 

func (s GetHypervisorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetHypervisorPropertyMappingsInput added in v1.44.161 

type GetHypervisorPropertyMappingsInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	//
	// HypervisorArn is a required field
	HypervisorArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetHypervisorPropertyMappingsInput) GoString added in v1.44.161 

func (s GetHypervisorPropertyMappingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetHypervisorPropertyMappingsInput) SetHypervisorArn added in v1.44.161 

func (s *GetHypervisorPropertyMappingsInput) SetHypervisorArn(v string) *GetHypervisorPropertyMappingsInput

SetHypervisorArn sets the HypervisorArn field's value.

func (GetHypervisorPropertyMappingsInput) String added in v1.44.161 

func (s GetHypervisorPropertyMappingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetHypervisorPropertyMappingsInput) Validate added in v1.44.161 

func (s *GetHypervisorPropertyMappingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetHypervisorPropertyMappingsOutput added in v1.44.161 

type GetHypervisorPropertyMappingsOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	HypervisorArn *string `min:"50" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role.
	IamRoleArn *string `min:"20" type:"string"`

	// This is a display of the mappings of on-premises VMware tags to the Amazon
	// Web Services tags.
	VmwareToAwsTagMappings []*VmwareToAwsTagMapping `type:"list"`
	// contains filtered or unexported fields
}

func (GetHypervisorPropertyMappingsOutput) GoString added in v1.44.161 

func (s GetHypervisorPropertyMappingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetHypervisorPropertyMappingsOutput) SetHypervisorArn added in v1.44.161 

func (s *GetHypervisorPropertyMappingsOutput) SetHypervisorArn(v string) *GetHypervisorPropertyMappingsOutput

SetHypervisorArn sets the HypervisorArn field's value.

func (*GetHypervisorPropertyMappingsOutput) SetIamRoleArn added in v1.44.161 

func (s *GetHypervisorPropertyMappingsOutput) SetIamRoleArn(v string) *GetHypervisorPropertyMappingsOutput

SetIamRoleArn sets the IamRoleArn field's value.

func (*GetHypervisorPropertyMappingsOutput) SetVmwareToAwsTagMappings added in v1.44.161 

func (s *GetHypervisorPropertyMappingsOutput) SetVmwareToAwsTagMappings(v []*VmwareToAwsTagMapping) *GetHypervisorPropertyMappingsOutput

SetVmwareToAwsTagMappings sets the VmwareToAwsTagMappings field's value.

func (GetHypervisorPropertyMappingsOutput) String added in v1.44.161 

func (s GetHypervisorPropertyMappingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetVirtualMachineInput added in v1.44.104 

type GetVirtualMachineInput struct {

	// The Amazon Resource Name (ARN) of the virtual machine.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetVirtualMachineInput) GoString added in v1.44.104 

func (s GetVirtualMachineInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetVirtualMachineInput) SetResourceArn added in v1.44.104 

func (s *GetVirtualMachineInput) SetResourceArn(v string) *GetVirtualMachineInput

SetResourceArn sets the ResourceArn field's value.

func (GetVirtualMachineInput) String added in v1.44.104 

func (s GetVirtualMachineInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetVirtualMachineInput) Validate added in v1.44.104 

func (s *GetVirtualMachineInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetVirtualMachineOutput added in v1.44.104 

type GetVirtualMachineOutput struct {

	// This object contains the basic attributes of VirtualMachine contained by
	// the output of GetVirtualMachine
	VirtualMachine *VirtualMachineDetails `type:"structure"`
	// contains filtered or unexported fields
}

func (GetVirtualMachineOutput) GoString added in v1.44.104 

func (s GetVirtualMachineOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetVirtualMachineOutput) SetVirtualMachine added in v1.44.104 

func (s *GetVirtualMachineOutput) SetVirtualMachine(v *VirtualMachineDetails) *GetVirtualMachineOutput

SetVirtualMachine sets the VirtualMachine field's value.

func (GetVirtualMachineOutput) String added in v1.44.104 

func (s GetVirtualMachineOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"3" type:"string"`

	// The Amazon Resource Name (ARN) of the hypervisor.
	HypervisorArn *string `min:"50" type:"string"`

	// The Amazon Resource Name (ARN) of the Key Management Service used to encrypt
	// the hypervisor.
	KmsKeyArn *string `min:"50" type:"string"`

	// The name of the hypervisor.
	Name *string `min:"1" type:"string"`

	// The state of the hypervisor.
	State *string `type:"string" enum:"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.

func (Hypervisor) GoString 

func (s Hypervisor) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Hypervisor) SetHost 

func (s *Hypervisor) SetHost(v string) *Hypervisor

SetHost sets the Host field's value.

func (*Hypervisor) SetHypervisorArn 

func (s *Hypervisor) SetHypervisorArn(v string) *Hypervisor

SetHypervisorArn sets the HypervisorArn field's value.

func (*Hypervisor) SetKmsKeyArn 

func (s *Hypervisor) SetKmsKeyArn(v string) *Hypervisor

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*Hypervisor) SetName 

func (s *Hypervisor) SetName(v string) *Hypervisor

SetName sets the Name field's value.

func (*Hypervisor) SetState 

func (s *Hypervisor) SetState(v string) *Hypervisor

SetState sets the State field's value.

func (Hypervisor) String 

func (s Hypervisor) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HypervisorDetails added in v1.44.161 

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 `min:"3" type:"string"`

	// The Amazon Resource Name (ARN) of the hypervisor.
	HypervisorArn *string `min:"50" type:"string"`

	// The Amazon Resource Name (ARN) of the KMS used to encrypt the hypervisor.
	KmsKeyArn *string `min:"50" type:"string"`

	// This is the time when the most recent successful sync of metadata occurred.
	LastSuccessfulMetadataSyncTime *time.Time `type:"timestamp"`

	// This is the most recent status for the indicated metadata sync.
	LatestMetadataSyncStatus *string `type:"string" enum:"SyncMetadataStatus"`

	// This is the most recent status for the indicated metadata sync.
	LatestMetadataSyncStatusMessage *string `type:"string"`

	// The Amazon Resource Name (ARN) of the group of gateways within the requested
	// log.
	LogGroupArn *string `type:"string"`

	// This is the name of the specified hypervisor.
	Name *string `min:"1" type:"string"`

	// This is the current state of the specified hypervisor.
	//
	// The possible states are PENDING, ONLINE, OFFLINE, or ERROR.
	State *string `type:"string" enum:"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.

func (HypervisorDetails) GoString added in v1.44.161 

func (s HypervisorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HypervisorDetails) SetHost added in v1.44.161 

func (s *HypervisorDetails) SetHost(v string) *HypervisorDetails

SetHost sets the Host field's value.

func (*HypervisorDetails) SetHypervisorArn added in v1.44.161 

func (s *HypervisorDetails) SetHypervisorArn(v string) *HypervisorDetails

SetHypervisorArn sets the HypervisorArn field's value.

func (*HypervisorDetails) SetKmsKeyArn added in v1.44.161 

func (s *HypervisorDetails) SetKmsKeyArn(v string) *HypervisorDetails

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*HypervisorDetails) SetLastSuccessfulMetadataSyncTime added in v1.44.161 

func (s *HypervisorDetails) SetLastSuccessfulMetadataSyncTime(v time.Time) *HypervisorDetails

SetLastSuccessfulMetadataSyncTime sets the LastSuccessfulMetadataSyncTime field's value.

func (*HypervisorDetails) SetLatestMetadataSyncStatus added in v1.44.161 

func (s *HypervisorDetails) SetLatestMetadataSyncStatus(v string) *HypervisorDetails

SetLatestMetadataSyncStatus sets the LatestMetadataSyncStatus field's value.

func (*HypervisorDetails) SetLatestMetadataSyncStatusMessage added in v1.44.161 

func (s *HypervisorDetails) SetLatestMetadataSyncStatusMessage(v string) *HypervisorDetails

SetLatestMetadataSyncStatusMessage sets the LatestMetadataSyncStatusMessage field's value.

func (*HypervisorDetails) SetLogGroupArn added in v1.44.161 

func (s *HypervisorDetails) SetLogGroupArn(v string) *HypervisorDetails

SetLogGroupArn sets the LogGroupArn field's value.

func (*HypervisorDetails) SetName added in v1.44.161 

func (s *HypervisorDetails) SetName(v string) *HypervisorDetails

SetName sets the Name field's value.

func (*HypervisorDetails) SetState added in v1.44.161 

func (s *HypervisorDetails) SetState(v string) *HypervisorDetails

SetState sets the State field's value.

func (HypervisorDetails) String added in v1.44.161 

func (s HypervisorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportHypervisorConfigurationInput 

type ImportHypervisorConfigurationInput struct {

	// The server host of the hypervisor. This can be either an IP address or a
	// fully-qualified domain name (FQDN).
	//
	// Host is a required field
	Host *string `min:"3" type:"string" required:"true"`

	// The Key Management Service for the hypervisor.
	KmsKeyArn *string `min:"50" type:"string"`

	// The name of the hypervisor.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The password for the hypervisor.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ImportHypervisorConfigurationInput's
	// String and GoString methods.
	Password *string `min:"1" type:"string" sensitive:"true"`

	// The tags of the hypervisor configuration to import.
	Tags []*Tag `type:"list"`

	// The username for the hypervisor.
	//
	// Username is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ImportHypervisorConfigurationInput's
	// String and GoString methods.
	Username *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ImportHypervisorConfigurationInput) GoString 

func (s ImportHypervisorConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportHypervisorConfigurationInput) SetHost 

func (s *ImportHypervisorConfigurationInput) SetHost(v string) *ImportHypervisorConfigurationInput

SetHost sets the Host field's value.

func (*ImportHypervisorConfigurationInput) SetKmsKeyArn 

func (s *ImportHypervisorConfigurationInput) SetKmsKeyArn(v string) *ImportHypervisorConfigurationInput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*ImportHypervisorConfigurationInput) SetName 

func (s *ImportHypervisorConfigurationInput) SetName(v string) *ImportHypervisorConfigurationInput

SetName sets the Name field's value.

func (*ImportHypervisorConfigurationInput) SetPassword 

func (s *ImportHypervisorConfigurationInput) SetPassword(v string) *ImportHypervisorConfigurationInput

SetPassword sets the Password field's value.

func (*ImportHypervisorConfigurationInput) SetTags 

func (s *ImportHypervisorConfigurationInput) SetTags(v []*Tag) *ImportHypervisorConfigurationInput

SetTags sets the Tags field's value.

func (*ImportHypervisorConfigurationInput) SetUsername 

func (s *ImportHypervisorConfigurationInput) SetUsername(v string) *ImportHypervisorConfigurationInput

SetUsername sets the Username field's value.

func (ImportHypervisorConfigurationInput) String 

func (s ImportHypervisorConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportHypervisorConfigurationInput) Validate 

func (s *ImportHypervisorConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportHypervisorConfigurationOutput 

type ImportHypervisorConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor you disassociated.
	HypervisorArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (ImportHypervisorConfigurationOutput) GoString 

func (s ImportHypervisorConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportHypervisorConfigurationOutput) SetHypervisorArn 

func (s *ImportHypervisorConfigurationOutput) SetHypervisorArn(v string) *ImportHypervisorConfigurationOutput

SetHypervisorArn sets the HypervisorArn field's value.

func (ImportHypervisorConfigurationOutput) String 

func (s ImportHypervisorConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of which internal error occured.
	ErrorCode *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation did not succeed because an internal error occurred. Try again later.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGatewaysInput 

type ListGatewaysInput struct {

	// The maximum number of gateways to list.
	MaxResults *int64 `min:"1" type:"integer"`

	// The next item following a partial list of returned resources. For example,
	// if a request is made to return MaxResults number of resources, NextToken
	// allows you to return more items in your list starting at the location pointed
	// to by the next token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGatewaysInput) GoString 

func (s ListGatewaysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGatewaysInput) SetMaxResults 

func (s *ListGatewaysInput) SetMaxResults(v int64) *ListGatewaysInput

SetMaxResults sets the MaxResults field's value.

func (*ListGatewaysInput) SetNextToken 

func (s *ListGatewaysInput) SetNextToken(v string) *ListGatewaysInput

SetNextToken sets the NextToken field's value.

func (ListGatewaysInput) String 

func (s ListGatewaysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGatewaysInput) Validate 

func (s *ListGatewaysInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGatewaysOutput 

type ListGatewaysOutput struct {

	// A list of your gateways.
	Gateways []*Gateway `type:"list"`

	// The next item following a partial list of returned resources. For example,
	// if a request is made to return maxResults number of resources, NextToken
	// allows you to return more items in your list starting at the location pointed
	// to by the next token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGatewaysOutput) GoString 

func (s ListGatewaysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGatewaysOutput) SetGateways 

func (s *ListGatewaysOutput) SetGateways(v []*Gateway) *ListGatewaysOutput

SetGateways sets the Gateways field's value.

func (*ListGatewaysOutput) SetNextToken 

func (s *ListGatewaysOutput) SetNextToken(v string) *ListGatewaysOutput

SetNextToken sets the NextToken field's value.

func (ListGatewaysOutput) String 

func (s ListGatewaysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListHypervisorsInput 

type ListHypervisorsInput struct {

	// The maximum number of hypervisors to list.
	MaxResults *int64 `min:"1" type:"integer"`

	// The next item following a partial list of returned resources. For example,
	// if a request is made to return maxResults number of resources, NextToken
	// allows you to return more items in your list starting at the location pointed
	// to by the next token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListHypervisorsInput) GoString 

func (s ListHypervisorsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListHypervisorsInput) SetMaxResults 

func (s *ListHypervisorsInput) SetMaxResults(v int64) *ListHypervisorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListHypervisorsInput) SetNextToken 

func (s *ListHypervisorsInput) SetNextToken(v string) *ListHypervisorsInput

SetNextToken sets the NextToken field's value.

func (ListHypervisorsInput) String 

func (s ListHypervisorsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListHypervisorsInput) Validate 

func (s *ListHypervisorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListHypervisorsOutput 

type ListHypervisorsOutput struct {

	// A list of your Hypervisor objects, ordered by their Amazon Resource Names
	// (ARNs).
	Hypervisors []*Hypervisor `type:"list"`

	// The next item following a partial list of returned resources. For example,
	// if a request is made to return maxResults number of resources, NextToken
	// allows you to return more items in your list starting at the location pointed
	// to by the next token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListHypervisorsOutput) GoString 

func (s ListHypervisorsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListHypervisorsOutput) SetHypervisors 

func (s *ListHypervisorsOutput) SetHypervisors(v []*Hypervisor) *ListHypervisorsOutput

SetHypervisors sets the Hypervisors field's value.

func (*ListHypervisorsOutput) SetNextToken 

func (s *ListHypervisorsOutput) SetNextToken(v string) *ListHypervisorsOutput

SetNextToken sets the NextToken field's value.

func (ListHypervisorsOutput) String 

func (s ListHypervisorsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource's tags to list.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resource's tags that you listed.
	ResourceArn *string `min:"50" type:"string"`

	// A list of the resource's tags.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetResourceArn 

func (s *ListTagsForResourceOutput) SetResourceArn(v string) *ListTagsForResourceOutput

SetResourceArn sets the ResourceArn field's value.

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListVirtualMachinesInput 

type ListVirtualMachinesInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor connected to your virtual
	// machine.
	HypervisorArn *string `min:"50" type:"string"`

	// The maximum number of virtual machines to list.
	MaxResults *int64 `min:"1" type:"integer"`

	// The next item following a partial list of returned resources. For example,
	// if a request is made to return maxResults number of resources, NextToken
	// allows you to return more items in your list starting at the location pointed
	// to by the next token.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListVirtualMachinesInput) GoString 

func (s ListVirtualMachinesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVirtualMachinesInput) SetHypervisorArn added in v1.44.104 

func (s *ListVirtualMachinesInput) SetHypervisorArn(v string) *ListVirtualMachinesInput

SetHypervisorArn sets the HypervisorArn field's value.

func (*ListVirtualMachinesInput) SetMaxResults 

func (s *ListVirtualMachinesInput) SetMaxResults(v int64) *ListVirtualMachinesInput

SetMaxResults sets the MaxResults field's value.

func (*ListVirtualMachinesInput) SetNextToken 

func (s *ListVirtualMachinesInput) SetNextToken(v string) *ListVirtualMachinesInput

SetNextToken sets the NextToken field's value.

func (ListVirtualMachinesInput) String 

func (s ListVirtualMachinesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVirtualMachinesInput) Validate 

func (s *ListVirtualMachinesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListVirtualMachinesOutput 

type ListVirtualMachinesOutput struct {

	// The next item following a partial list of returned resources. For example,
	// if a request is made to return maxResults number of resources, NextToken
	// allows you to return more items in your list starting at the location pointed
	// to by the next token.
	NextToken *string `min:"1" type:"string"`

	// A list of your VirtualMachine objects, ordered by their Amazon Resource Names
	// (ARNs).
	VirtualMachines []*VirtualMachine `type:"list"`
	// contains filtered or unexported fields
}

func (ListVirtualMachinesOutput) GoString 

func (s ListVirtualMachinesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListVirtualMachinesOutput) SetNextToken 

func (s *ListVirtualMachinesOutput) SetNextToken(v string) *ListVirtualMachinesOutput

SetNextToken sets the NextToken field's value.

func (*ListVirtualMachinesOutput) SetVirtualMachines 

func (s *ListVirtualMachinesOutput) SetVirtualMachines(v []*VirtualMachine) *ListVirtualMachinesOutput

SetVirtualMachines sets the VirtualMachines field's value.

func (ListVirtualMachinesOutput) String 

func (s ListVirtualMachinesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MaintenanceStartTime added in v1.44.104 

type MaintenanceStartTime struct {

	// 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 *int64 `min:"1" type:"integer"`

	// 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 *int64 `type:"integer"`

	// 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.
	//
	// HourOfDay is a required field
	HourOfDay *int64 `type:"integer" required:"true"`

	// 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.
	//
	// MinuteOfHour is a required field
	MinuteOfHour *int64 `type:"integer" required:"true"`
	// 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.

func (MaintenanceStartTime) GoString added in v1.44.104 

func (s MaintenanceStartTime) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MaintenanceStartTime) SetDayOfMonth added in v1.44.104 

func (s *MaintenanceStartTime) SetDayOfMonth(v int64) *MaintenanceStartTime

SetDayOfMonth sets the DayOfMonth field's value.

func (*MaintenanceStartTime) SetDayOfWeek added in v1.44.104 

func (s *MaintenanceStartTime) SetDayOfWeek(v int64) *MaintenanceStartTime

SetDayOfWeek sets the DayOfWeek field's value.

func (*MaintenanceStartTime) SetHourOfDay added in v1.44.104 

func (s *MaintenanceStartTime) SetHourOfDay(v int64) *MaintenanceStartTime

SetHourOfDay sets the HourOfDay field's value.

func (*MaintenanceStartTime) SetMinuteOfHour added in v1.44.104 

func (s *MaintenanceStartTime) SetMinuteOfHour(v int64) *MaintenanceStartTime

SetMinuteOfHour sets the MinuteOfHour field's value.

func (MaintenanceStartTime) String added in v1.44.104 

func (s MaintenanceStartTime) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutBandwidthRateLimitScheduleInput added in v1.44.161 

type PutBandwidthRateLimitScheduleInput struct {

	// An array containing bandwidth rate limit schedule intervals for a gateway.
	// When no bandwidth rate limit intervals have been scheduled, the array is
	// empty.
	//
	// BandwidthRateLimitIntervals is a required field
	BandwidthRateLimitIntervals []*BandwidthRateLimitInterval `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)
	// operation to return a list of gateways for your account and Amazon Web Services
	// Region.
	//
	// GatewayArn is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutBandwidthRateLimitScheduleInput) GoString added in v1.44.161 

func (s PutBandwidthRateLimitScheduleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutBandwidthRateLimitScheduleInput) SetBandwidthRateLimitIntervals added in v1.44.161 

func (s *PutBandwidthRateLimitScheduleInput) SetBandwidthRateLimitIntervals(v []*BandwidthRateLimitInterval) *PutBandwidthRateLimitScheduleInput

SetBandwidthRateLimitIntervals sets the BandwidthRateLimitIntervals field's value.

func (*PutBandwidthRateLimitScheduleInput) SetGatewayArn added in v1.44.161 

func (s *PutBandwidthRateLimitScheduleInput) SetGatewayArn(v string) *PutBandwidthRateLimitScheduleInput

SetGatewayArn sets the GatewayArn field's value.

func (PutBandwidthRateLimitScheduleInput) String added in v1.44.161 

func (s PutBandwidthRateLimitScheduleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutBandwidthRateLimitScheduleInput) Validate added in v1.44.161 

func (s *PutBandwidthRateLimitScheduleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBandwidthRateLimitScheduleOutput added in v1.44.161 

type PutBandwidthRateLimitScheduleOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html)
	// operation to return a list of gateways for your account and Amazon Web Services
	// Region.
	GatewayArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (PutBandwidthRateLimitScheduleOutput) GoString added in v1.44.161 

func (s PutBandwidthRateLimitScheduleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutBandwidthRateLimitScheduleOutput) SetGatewayArn added in v1.44.161 

func (s *PutBandwidthRateLimitScheduleOutput) SetGatewayArn(v string) *PutBandwidthRateLimitScheduleOutput

SetGatewayArn sets the GatewayArn field's value.

func (PutBandwidthRateLimitScheduleOutput) String added in v1.44.161 

func (s PutBandwidthRateLimitScheduleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutHypervisorPropertyMappingsInput added in v1.44.161 

type PutHypervisorPropertyMappingsInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	//
	// HypervisorArn is a required field
	HypervisorArn *string `min:"50" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `min:"20" type:"string" required:"true"`

	// This action requests the mappings of on-premises VMware tags to the Amazon
	// Web Services tags.
	//
	// VmwareToAwsTagMappings is a required field
	VmwareToAwsTagMappings []*VmwareToAwsTagMapping `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutHypervisorPropertyMappingsInput) GoString added in v1.44.161 

func (s PutHypervisorPropertyMappingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutHypervisorPropertyMappingsInput) SetHypervisorArn added in v1.44.161 

func (s *PutHypervisorPropertyMappingsInput) SetHypervisorArn(v string) *PutHypervisorPropertyMappingsInput

SetHypervisorArn sets the HypervisorArn field's value.

func (*PutHypervisorPropertyMappingsInput) SetIamRoleArn added in v1.44.161 

func (s *PutHypervisorPropertyMappingsInput) SetIamRoleArn(v string) *PutHypervisorPropertyMappingsInput

SetIamRoleArn sets the IamRoleArn field's value.

func (*PutHypervisorPropertyMappingsInput) SetVmwareToAwsTagMappings added in v1.44.161 

func (s *PutHypervisorPropertyMappingsInput) SetVmwareToAwsTagMappings(v []*VmwareToAwsTagMapping) *PutHypervisorPropertyMappingsInput

SetVmwareToAwsTagMappings sets the VmwareToAwsTagMappings field's value.

func (PutHypervisorPropertyMappingsInput) String added in v1.44.161 

func (s PutHypervisorPropertyMappingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutHypervisorPropertyMappingsInput) Validate added in v1.44.161 

func (s *PutHypervisorPropertyMappingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutHypervisorPropertyMappingsOutput added in v1.44.161 

type PutHypervisorPropertyMappingsOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	HypervisorArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (PutHypervisorPropertyMappingsOutput) GoString added in v1.44.161 

func (s PutHypervisorPropertyMappingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutHypervisorPropertyMappingsOutput) SetHypervisorArn added in v1.44.161 

func (s *PutHypervisorPropertyMappingsOutput) SetHypervisorArn(v string) *PutHypervisorPropertyMappingsOutput

SetHypervisorArn sets the HypervisorArn field's value.

func (PutHypervisorPropertyMappingsOutput) String added in v1.44.161 

func (s PutHypervisorPropertyMappingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutMaintenanceStartTimeInput 

type PutMaintenanceStartTimeInput struct {

	// The day of the month start maintenance on a gateway.
	//
	// Valid values range from Sunday to Saturday.
	DayOfMonth *int64 `min:"1" type:"integer"`

	// The day of the week to start maintenance on a gateway.
	DayOfWeek *int64 `type:"integer"`

	// The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance
	// start time.
	//
	// GatewayArn is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`

	// The hour of the day to start maintenance on a gateway.
	//
	// HourOfDay is a required field
	HourOfDay *int64 `type:"integer" required:"true"`

	// The minute of the hour to start maintenance on a gateway.
	//
	// MinuteOfHour is a required field
	MinuteOfHour *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

func (PutMaintenanceStartTimeInput) GoString 

func (s PutMaintenanceStartTimeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutMaintenanceStartTimeInput) SetDayOfMonth 

func (s *PutMaintenanceStartTimeInput) SetDayOfMonth(v int64) *PutMaintenanceStartTimeInput

SetDayOfMonth sets the DayOfMonth field's value.

func (*PutMaintenanceStartTimeInput) SetDayOfWeek 

func (s *PutMaintenanceStartTimeInput) SetDayOfWeek(v int64) *PutMaintenanceStartTimeInput

SetDayOfWeek sets the DayOfWeek field's value.

func (*PutMaintenanceStartTimeInput) SetGatewayArn 

func (s *PutMaintenanceStartTimeInput) SetGatewayArn(v string) *PutMaintenanceStartTimeInput

SetGatewayArn sets the GatewayArn field's value.

func (*PutMaintenanceStartTimeInput) SetHourOfDay 

func (s *PutMaintenanceStartTimeInput) SetHourOfDay(v int64) *PutMaintenanceStartTimeInput

SetHourOfDay sets the HourOfDay field's value.

func (*PutMaintenanceStartTimeInput) SetMinuteOfHour 

func (s *PutMaintenanceStartTimeInput) SetMinuteOfHour(v int64) *PutMaintenanceStartTimeInput

SetMinuteOfHour sets the MinuteOfHour field's value.

func (PutMaintenanceStartTimeInput) String 

func (s PutMaintenanceStartTimeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutMaintenanceStartTimeInput) Validate 

func (s *PutMaintenanceStartTimeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutMaintenanceStartTimeOutput 

type PutMaintenanceStartTimeOutput struct {

	// The Amazon Resource Name (ARN) of a gateway for which you set the maintenance
	// start time.
	GatewayArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (PutMaintenanceStartTimeOutput) GoString 

func (s PutMaintenanceStartTimeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutMaintenanceStartTimeOutput) SetGatewayArn 

func (s *PutMaintenanceStartTimeOutput) SetGatewayArn(v string) *PutMaintenanceStartTimeOutput

SetGatewayArn sets the GatewayArn field's value.

func (PutMaintenanceStartTimeOutput) String 

func (s PutMaintenanceStartTimeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of which resource wasn't found.
	ErrorCode *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

A resource that is required for the action wasn't found.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartVirtualMachinesMetadataSyncInput added in v1.44.161 

type StartVirtualMachinesMetadataSyncInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	//
	// HypervisorArn is a required field
	HypervisorArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartVirtualMachinesMetadataSyncInput) GoString added in v1.44.161 

func (s StartVirtualMachinesMetadataSyncInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartVirtualMachinesMetadataSyncInput) SetHypervisorArn added in v1.44.161 

func (s *StartVirtualMachinesMetadataSyncInput) SetHypervisorArn(v string) *StartVirtualMachinesMetadataSyncInput

SetHypervisorArn sets the HypervisorArn field's value.

func (StartVirtualMachinesMetadataSyncInput) String added in v1.44.161 

func (s StartVirtualMachinesMetadataSyncInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartVirtualMachinesMetadataSyncInput) Validate added in v1.44.161 

func (s *StartVirtualMachinesMetadataSyncInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartVirtualMachinesMetadataSyncOutput added in v1.44.161 

type StartVirtualMachinesMetadataSyncOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	HypervisorArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (StartVirtualMachinesMetadataSyncOutput) GoString added in v1.44.161 

func (s StartVirtualMachinesMetadataSyncOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartVirtualMachinesMetadataSyncOutput) SetHypervisorArn added in v1.44.161 

func (s *StartVirtualMachinesMetadataSyncOutput) SetHypervisorArn(v string) *StartVirtualMachinesMetadataSyncOutput

SetHypervisorArn sets the HypervisorArn field's value.

func (StartVirtualMachinesMetadataSyncOutput) String added in v1.44.161 

func (s StartVirtualMachinesMetadataSyncOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag 

type Tag struct {

	// The key part of a tag's key-value pair. The key can't start with aws:.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value part of a tag's key-value pair.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// 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: + - = . _ : /.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to tag.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"50" type:"string" required:"true"`

	// A list of tags to assign to the resource.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resource you tagged.
	ResourceARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceOutput) SetResourceARN 

func (s *TagResourceOutput) SetResourceARN(v string) *TagResourceOutput

SetResourceARN sets the ResourceARN field's value.

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TestHypervisorConfigurationInput 

type TestHypervisorConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
	//
	// GatewayArn is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`

	// The server host of the hypervisor. This can be either an IP address or a
	// fully-qualified domain name (FQDN).
	//
	// Host is a required field
	Host *string `min:"3" type:"string" required:"true"`

	// The password for the hypervisor.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TestHypervisorConfigurationInput's
	// String and GoString methods.
	Password *string `min:"1" type:"string" sensitive:"true"`

	// The username for the hypervisor.
	//
	// Username is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TestHypervisorConfigurationInput's
	// String and GoString methods.
	Username *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (TestHypervisorConfigurationInput) GoString 

func (s TestHypervisorConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestHypervisorConfigurationInput) SetGatewayArn 

func (s *TestHypervisorConfigurationInput) SetGatewayArn(v string) *TestHypervisorConfigurationInput

SetGatewayArn sets the GatewayArn field's value.

func (*TestHypervisorConfigurationInput) SetHost 

func (s *TestHypervisorConfigurationInput) SetHost(v string) *TestHypervisorConfigurationInput

SetHost sets the Host field's value.

func (*TestHypervisorConfigurationInput) SetPassword 

func (s *TestHypervisorConfigurationInput) SetPassword(v string) *TestHypervisorConfigurationInput

SetPassword sets the Password field's value.

func (*TestHypervisorConfigurationInput) SetUsername 

func (s *TestHypervisorConfigurationInput) SetUsername(v string) *TestHypervisorConfigurationInput

SetUsername sets the Username field's value.

func (TestHypervisorConfigurationInput) String 

func (s TestHypervisorConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestHypervisorConfigurationInput) Validate 

func (s *TestHypervisorConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TestHypervisorConfigurationOutput 

type TestHypervisorConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (TestHypervisorConfigurationOutput) GoString 

func (s TestHypervisorConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TestHypervisorConfigurationOutput) String 

func (s TestHypervisorConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException added in v1.44.104 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Error: TPS has been limited to protect against intentional or unintentional
	// high request volumes.
	//
	// ErrorCode is a required field
	ErrorCode *string `type:"string" required:"true"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

TPS has been limited to protect against intentional or unintentional high request volumes.

func (*ThrottlingException) Code added in v1.44.104 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error added in v1.44.104 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString added in v1.44.104 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message added in v1.44.104 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr added in v1.44.104 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID added in v1.44.104 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode added in v1.44.104 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String added in v1.44.104 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource from which to remove tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"50" type:"string" required:"true"`

	// The list of tag keys specifying which tags to remove.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resource from which you removed tags.
	ResourceARN *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceOutput) SetResourceARN 

func (s *UntagResourceOutput) SetResourceARN(v string) *UntagResourceOutput

SetResourceARN sets the ResourceARN field's value.

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGatewayInformationInput 

type UpdateGatewayInformationInput struct {

	// The Amazon Resource Name (ARN) of the gateway to update.
	//
	// GatewayArn is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`

	// The updated display name of the gateway.
	GatewayDisplayName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateGatewayInformationInput) GoString 

func (s UpdateGatewayInformationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewayInformationInput) SetGatewayArn 

func (s *UpdateGatewayInformationInput) SetGatewayArn(v string) *UpdateGatewayInformationInput

SetGatewayArn sets the GatewayArn field's value.

func (*UpdateGatewayInformationInput) SetGatewayDisplayName 

func (s *UpdateGatewayInformationInput) SetGatewayDisplayName(v string) *UpdateGatewayInformationInput

SetGatewayDisplayName sets the GatewayDisplayName field's value.

func (UpdateGatewayInformationInput) String 

func (s UpdateGatewayInformationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewayInformationInput) Validate 

func (s *UpdateGatewayInformationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateGatewayInformationOutput 

type UpdateGatewayInformationOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you updated.
	GatewayArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateGatewayInformationOutput) GoString 

func (s UpdateGatewayInformationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewayInformationOutput) SetGatewayArn 

func (s *UpdateGatewayInformationOutput) SetGatewayArn(v string) *UpdateGatewayInformationOutput

SetGatewayArn sets the GatewayArn field's value.

func (UpdateGatewayInformationOutput) String 

func (s UpdateGatewayInformationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGatewaySoftwareNowInput added in v1.44.26 

type UpdateGatewaySoftwareNowInput struct {

	// The Amazon Resource Name (ARN) of the gateway to be updated.
	//
	// GatewayArn is a required field
	GatewayArn *string `min:"50" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGatewaySoftwareNowInput) GoString added in v1.44.26 

func (s UpdateGatewaySoftwareNowInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewaySoftwareNowInput) SetGatewayArn added in v1.44.26 

func (s *UpdateGatewaySoftwareNowInput) SetGatewayArn(v string) *UpdateGatewaySoftwareNowInput

SetGatewayArn sets the GatewayArn field's value.

func (UpdateGatewaySoftwareNowInput) String added in v1.44.26 

func (s UpdateGatewaySoftwareNowInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewaySoftwareNowInput) Validate added in v1.44.26 

func (s *UpdateGatewaySoftwareNowInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateGatewaySoftwareNowOutput added in v1.44.26 

type UpdateGatewaySoftwareNowOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you updated.
	GatewayArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateGatewaySoftwareNowOutput) GoString added in v1.44.26 

func (s UpdateGatewaySoftwareNowOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewaySoftwareNowOutput) SetGatewayArn added in v1.44.26 

func (s *UpdateGatewaySoftwareNowOutput) SetGatewayArn(v string) *UpdateGatewaySoftwareNowOutput

SetGatewayArn sets the GatewayArn field's value.

func (UpdateGatewaySoftwareNowOutput) String added in v1.44.26 

func (s UpdateGatewaySoftwareNowOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateHypervisorInput 

type UpdateHypervisorInput struct {

	// The updated host of the hypervisor. This can be either an IP address or a
	// fully-qualified domain name (FQDN).
	Host *string `min:"3" type:"string"`

	// The Amazon Resource Name (ARN) of the hypervisor to update.
	//
	// HypervisorArn is a required field
	HypervisorArn *string `min:"50" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the group of gateways within the requested
	// log.
	LogGroupArn *string `type:"string"`

	// The updated name for the hypervisor
	Name *string `min:"1" type:"string"`

	// The updated password for the hypervisor.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateHypervisorInput's
	// String and GoString methods.
	Password *string `min:"1" type:"string" sensitive:"true"`

	// The updated username for the hypervisor.
	//
	// Username is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateHypervisorInput's
	// String and GoString methods.
	Username *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateHypervisorInput) GoString 

func (s UpdateHypervisorInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateHypervisorInput) SetHost 

func (s *UpdateHypervisorInput) SetHost(v string) *UpdateHypervisorInput

SetHost sets the Host field's value.

func (*UpdateHypervisorInput) SetHypervisorArn 

func (s *UpdateHypervisorInput) SetHypervisorArn(v string) *UpdateHypervisorInput

SetHypervisorArn sets the HypervisorArn field's value.

func (*UpdateHypervisorInput) SetLogGroupArn added in v1.44.161 

func (s *UpdateHypervisorInput) SetLogGroupArn(v string) *UpdateHypervisorInput

SetLogGroupArn sets the LogGroupArn field's value.

func (*UpdateHypervisorInput) SetName added in v1.44.26 

func (s *UpdateHypervisorInput) SetName(v string) *UpdateHypervisorInput

SetName sets the Name field's value.

func (*UpdateHypervisorInput) SetPassword 

func (s *UpdateHypervisorInput) SetPassword(v string) *UpdateHypervisorInput

SetPassword sets the Password field's value.

func (*UpdateHypervisorInput) SetUsername 

func (s *UpdateHypervisorInput) SetUsername(v string) *UpdateHypervisorInput

SetUsername sets the Username field's value.

func (UpdateHypervisorInput) String 

func (s UpdateHypervisorInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateHypervisorInput) Validate 

func (s *UpdateHypervisorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateHypervisorOutput 

type UpdateHypervisorOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor you updated.
	HypervisorArn *string `min:"50" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateHypervisorOutput) GoString 

func (s UpdateHypervisorOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateHypervisorOutput) SetHypervisorArn 

func (s *UpdateHypervisorOutput) SetHypervisorArn(v string) *UpdateHypervisorOutput

SetHypervisorArn sets the HypervisorArn field's value.

func (UpdateHypervisorOutput) String 

func (s UpdateHypervisorOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of what caused the validation error.
	ErrorCode *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation did not succeed because a validation error occurred.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VirtualMachine 

type VirtualMachine struct {

	// The host name of the virtual machine.
	HostName *string `min:"1" type:"string"`

	// The ID of the virtual machine's hypervisor.
	HypervisorId *string `type:"string"`

	// The most recent date a virtual machine was backed up, in Unix format and
	// UTC time.
	LastBackupDate *time.Time `type:"timestamp"`

	// The name of the virtual machine.
	Name *string `min:"1" type:"string"`

	// The path of the virtual machine.
	Path *string `min:"1" type:"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 `min:"50" type:"string"`
	// contains filtered or unexported fields
}

A virtual machine that is on a hypervisor.

func (VirtualMachine) GoString 

func (s VirtualMachine) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VirtualMachine) SetHostName 

func (s *VirtualMachine) SetHostName(v string) *VirtualMachine

SetHostName sets the HostName field's value.

func (*VirtualMachine) SetHypervisorId 

func (s *VirtualMachine) SetHypervisorId(v string) *VirtualMachine

SetHypervisorId sets the HypervisorId field's value.

func (*VirtualMachine) SetLastBackupDate 

func (s *VirtualMachine) SetLastBackupDate(v time.Time) *VirtualMachine

SetLastBackupDate sets the LastBackupDate field's value.

func (*VirtualMachine) SetName 

func (s *VirtualMachine) SetName(v string) *VirtualMachine

SetName sets the Name field's value.

func (*VirtualMachine) SetPath 

func (s *VirtualMachine) SetPath(v string) *VirtualMachine

SetPath sets the Path field's value.

func (*VirtualMachine) SetResourceArn 

func (s *VirtualMachine) SetResourceArn(v string) *VirtualMachine

SetResourceArn sets the ResourceArn field's value.

func (VirtualMachine) String 

func (s VirtualMachine) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VirtualMachineDetails added in v1.44.104 

type VirtualMachineDetails struct {

	// The host name of the virtual machine.
	HostName *string `min:"1" type:"string"`

	// The ID of the virtual machine's hypervisor.
	HypervisorId *string `type:"string"`

	// The most recent date a virtual machine was backed up, in Unix format and
	// UTC time.
	LastBackupDate *time.Time `type:"timestamp"`

	// The name of the virtual machine.
	Name *string `min:"1" type:"string"`

	// The path of the virtual machine.
	Path *string `min:"1" type:"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 `min:"50" type:"string"`

	// These are the details of the VMware tags associated with the specified virtual
	// machine.
	VmwareTags []*VmwareTag `type:"list"`
	// contains filtered or unexported fields
}

Your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

func (VirtualMachineDetails) GoString added in v1.44.104 

func (s VirtualMachineDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VirtualMachineDetails) SetHostName added in v1.44.104 

func (s *VirtualMachineDetails) SetHostName(v string) *VirtualMachineDetails

SetHostName sets the HostName field's value.

func (*VirtualMachineDetails) SetHypervisorId added in v1.44.104 

func (s *VirtualMachineDetails) SetHypervisorId(v string) *VirtualMachineDetails

SetHypervisorId sets the HypervisorId field's value.

func (*VirtualMachineDetails) SetLastBackupDate added in v1.44.104 

func (s *VirtualMachineDetails) SetLastBackupDate(v time.Time) *VirtualMachineDetails

SetLastBackupDate sets the LastBackupDate field's value.

func (*VirtualMachineDetails) SetName added in v1.44.104 

func (s *VirtualMachineDetails) SetName(v string) *VirtualMachineDetails

SetName sets the Name field's value.

func (*VirtualMachineDetails) SetPath added in v1.44.104 

func (s *VirtualMachineDetails) SetPath(v string) *VirtualMachineDetails

SetPath sets the Path field's value.

func (*VirtualMachineDetails) SetResourceArn added in v1.44.104 

func (s *VirtualMachineDetails) SetResourceArn(v string) *VirtualMachineDetails

SetResourceArn sets the ResourceArn field's value.

func (*VirtualMachineDetails) SetVmwareTags added in v1.44.161 

func (s *VirtualMachineDetails) SetVmwareTags(v []*VmwareTag) *VirtualMachineDetails

SetVmwareTags sets the VmwareTags field's value.

func (VirtualMachineDetails) String added in v1.44.104 

func (s VirtualMachineDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VmwareTag added in v1.44.161 

type VmwareTag struct {

	// The is the category of VMware.
	VmwareCategory *string `min:"1" type:"string"`

	// This is a user-defined description of a VMware tag.
	VmwareTagDescription *string `type:"string"`

	// This is the user-defined name of a VMware tag.
	VmwareTagName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A VMware tag is a tag attached to a specific virtual machine. A tag (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html) 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.

func (VmwareTag) GoString added in v1.44.161 

func (s VmwareTag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VmwareTag) SetVmwareCategory added in v1.44.161 

func (s *VmwareTag) SetVmwareCategory(v string) *VmwareTag

SetVmwareCategory sets the VmwareCategory field's value.

func (*VmwareTag) SetVmwareTagDescription added in v1.44.161 

func (s *VmwareTag) SetVmwareTagDescription(v string) *VmwareTag

SetVmwareTagDescription sets the VmwareTagDescription field's value.

func (*VmwareTag) SetVmwareTagName added in v1.44.161 

func (s *VmwareTag) SetVmwareTagName(v string) *VmwareTag

SetVmwareTagName sets the VmwareTagName field's value.

func (VmwareTag) String added in v1.44.161 

func (s VmwareTag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VmwareToAwsTagMapping added in v1.44.161 

type VmwareToAwsTagMapping struct {

	// The key part of the Amazon Web Services tag's key-value pair.
	//
	// AwsTagKey is a required field
	AwsTagKey *string `min:"1" type:"string" required:"true"`

	// The value part of the Amazon Web Services tag's key-value pair.
	//
	// AwsTagValue is a required field
	AwsTagValue *string `type:"string" required:"true"`

	// The is the category of VMware.
	//
	// VmwareCategory is a required field
	VmwareCategory *string `min:"1" type:"string" required:"true"`

	// This is the user-defined name of a VMware tag.
	//
	// VmwareTagName is a required field
	VmwareTagName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This displays the mapping of on-premises VMware tags to the corresponding Amazon Web Services tags.

func (VmwareToAwsTagMapping) GoString added in v1.44.161 

func (s VmwareToAwsTagMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VmwareToAwsTagMapping) SetAwsTagKey added in v1.44.161 

func (s *VmwareToAwsTagMapping) SetAwsTagKey(v string) *VmwareToAwsTagMapping

SetAwsTagKey sets the AwsTagKey field's value.

func (*VmwareToAwsTagMapping) SetAwsTagValue added in v1.44.161 

func (s *VmwareToAwsTagMapping) SetAwsTagValue(v string) *VmwareToAwsTagMapping

SetAwsTagValue sets the AwsTagValue field's value.

func (*VmwareToAwsTagMapping) SetVmwareCategory added in v1.44.161 

func (s *VmwareToAwsTagMapping) SetVmwareCategory(v string) *VmwareToAwsTagMapping

SetVmwareCategory sets the VmwareCategory field's value.

func (*VmwareToAwsTagMapping) SetVmwareTagName added in v1.44.161 

func (s *VmwareToAwsTagMapping) SetVmwareTagName(v string) *VmwareToAwsTagMapping

SetVmwareTagName sets the VmwareTagName field's value.

func (VmwareToAwsTagMapping) String added in v1.44.161 

func (s VmwareToAwsTagMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VmwareToAwsTagMapping) Validate added in v1.44.161 

func (s *VmwareToAwsTagMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

Source Files

View all Source files

Directories

Path Synopsis
Package backupgatewayiface provides an interface to enable mocking the AWS Backup Gateway service client for testing your code.
 Package backupgatewayiface provides an interface to enable mocking the AWS Backup Gateway service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.