sms

package
v1.10.16 Latest Latest
Warning

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

 Go to latest Published: Jul 26, 2017 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package sms provides the client and types for making API requests to AWS Server Migration Service.

Amazon Server Migration Service automates the process of migrating servers to EC2.

See https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24 for more information on this service.

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

Using the Client

To use the client for AWS Server Migration Service you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently. 

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := sms.New(sess)

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

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Server Migration Service client SMS for more information on creating the service's client. https://docs.aws.amazon.com/sdk-for-go/api/service/sms/#New

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode". 

result, err := svc.CreateReplicationJob(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("CreateReplicationJob result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request. 

ctx := context.Background()

result, err := svc.CreateReplicationJobWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Constants

View Source 
const (
	// ConnectorStatusHealthy is a ConnectorStatus enum value
	ConnectorStatusHealthy = "HEALTHY"

	// ConnectorStatusUnhealthy is a ConnectorStatus enum value
	ConnectorStatusUnhealthy = "UNHEALTHY"
)

Status of on-premise Connector

View Source 
const (
	// LicenseTypeAws is a LicenseType enum value
	LicenseTypeAws = "AWS"

	// LicenseTypeByol is a LicenseType enum value
	LicenseTypeByol = "BYOL"
)

The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun.

View Source 
const (
	// ReplicationJobStatePending is a ReplicationJobState enum value
	ReplicationJobStatePending = "PENDING"

	// ReplicationJobStateActive is a ReplicationJobState enum value
	ReplicationJobStateActive = "ACTIVE"

	// ReplicationJobStateFailed is a ReplicationJobState enum value
	ReplicationJobStateFailed = "FAILED"

	// ReplicationJobStateDeleting is a ReplicationJobState enum value
	ReplicationJobStateDeleting = "DELETING"

	// ReplicationJobStateDeleted is a ReplicationJobState enum value
	ReplicationJobStateDeleted = "DELETED"
)

Current state of Replication Job

View Source 
const (
	// ReplicationRunStatePending is a ReplicationRunState enum value
	ReplicationRunStatePending = "PENDING"

	// ReplicationRunStateMissed is a ReplicationRunState enum value
	ReplicationRunStateMissed = "MISSED"

	// ReplicationRunStateActive is a ReplicationRunState enum value
	ReplicationRunStateActive = "ACTIVE"

	// ReplicationRunStateFailed is a ReplicationRunState enum value
	ReplicationRunStateFailed = "FAILED"

	// ReplicationRunStateCompleted is a ReplicationRunState enum value
	ReplicationRunStateCompleted = "COMPLETED"

	// ReplicationRunStateDeleting is a ReplicationRunState enum value
	ReplicationRunStateDeleting = "DELETING"

	// ReplicationRunStateDeleted is a ReplicationRunState enum value
	ReplicationRunStateDeleted = "DELETED"
)

Current state of Replication Run

View Source 
const (
	// ReplicationRunTypeOnDemand is a ReplicationRunType enum value
	ReplicationRunTypeOnDemand = "ON_DEMAND"

	// ReplicationRunTypeAutomatic is a ReplicationRunType enum value
	ReplicationRunTypeAutomatic = "AUTOMATIC"
)

Type of Replication Run

View Source 
const (
	// ServerCatalogStatusNotImported is a ServerCatalogStatus enum value
	ServerCatalogStatusNotImported = "NOT_IMPORTED"

	// ServerCatalogStatusImporting is a ServerCatalogStatus enum value
	ServerCatalogStatusImporting = "IMPORTING"

	// ServerCatalogStatusAvailable is a ServerCatalogStatus enum value
	ServerCatalogStatusAvailable = "AVAILABLE"

	// ServerCatalogStatusDeleted is a ServerCatalogStatus enum value
	ServerCatalogStatusDeleted = "DELETED"

	// ServerCatalogStatusExpired is a ServerCatalogStatus enum value
	ServerCatalogStatusExpired = "EXPIRED"
)

Status of Server catalog

View Source 
const (

	// ErrCodeInternalError for service response error code
	// "InternalError".
	//
	// An internal error has occured.
	ErrCodeInternalError = "InternalError"

	// ErrCodeInvalidParameterException for service response error code
	// "InvalidParameterException".
	//
	// A parameter specified in the request is not valid, is unsupported, or cannot
	// be used.
	ErrCodeInvalidParameterException = "InvalidParameterException"

	// ErrCodeMissingRequiredParameterException for service response error code
	// "MissingRequiredParameterException".
	//
	// The request is missing a required parameter. Ensure that you have supplied
	// all the required parameters for the request.
	ErrCodeMissingRequiredParameterException = "MissingRequiredParameterException"

	// ErrCodeNoConnectorsAvailableException for service response error code
	// "NoConnectorsAvailableException".
	//
	// No connectors are available to handle this request. Please associate connector(s)
	// and verify any existing connectors are healthy and can respond to requests.
	ErrCodeNoConnectorsAvailableException = "NoConnectorsAvailableException"

	// ErrCodeOperationNotPermittedException for service response error code
	// "OperationNotPermittedException".
	//
	// The specified operation is not allowed. This error can occur for a number
	// of reasons; for example, you might be trying to start a Replication Run before
	// seed Replication Run.
	ErrCodeOperationNotPermittedException = "OperationNotPermittedException"

	// ErrCodeReplicationJobAlreadyExistsException for service response error code
	// "ReplicationJobAlreadyExistsException".
	//
	// An active Replication Job already exists for the specified server.
	ErrCodeReplicationJobAlreadyExistsException = "ReplicationJobAlreadyExistsException"

	// ErrCodeReplicationJobNotFoundException for service response error code
	// "ReplicationJobNotFoundException".
	//
	// The specified Replication Job cannot be found.
	ErrCodeReplicationJobNotFoundException = "ReplicationJobNotFoundException"

	// ErrCodeReplicationRunLimitExceededException for service response error code
	// "ReplicationRunLimitExceededException".
	//
	// This user has exceeded the maximum allowed Replication Run limit.
	ErrCodeReplicationRunLimitExceededException = "ReplicationRunLimitExceededException"

	// ErrCodeServerCannotBeReplicatedException for service response error code
	// "ServerCannotBeReplicatedException".
	//
	// The provided server cannot be replicated.
	ErrCodeServerCannotBeReplicatedException = "ServerCannotBeReplicatedException"

	// ErrCodeUnauthorizedOperationException for service response error code
	// "UnauthorizedOperationException".
	//
	// This user does not have permissions to perform this operation.
	ErrCodeUnauthorizedOperationException = "UnauthorizedOperationException"
)
View Source 
const (
	ServiceName = "sms"       // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

View Source 
const (
	// ConnectorCapabilityVsphere is a ConnectorCapability enum value
	ConnectorCapabilityVsphere = "VSPHERE"
)

Capabilities for a Connector

View Source 
const (
	// ServerTypeVirtualMachine is a ServerType enum value
	ServerTypeVirtualMachine = "VIRTUAL_MACHINE"
)

Type of server.

View Source 
const (
	// VmManagerTypeVsphere is a VmManagerType enum value
	VmManagerTypeVsphere = "VSPHERE"
)

VM Management Product

Variables

This section is empty.

Functions

This section is empty.

Types

type Connector 

type Connector struct {

	// Timestamp of an operation
	AssociatedOn *time.Time `locationName:"associatedOn" type:"timestamp" timestampFormat:"unix"`

	// List of Connector Capabilities
	CapabilityList []*string `locationName:"capabilityList" locationNameList:"item" type:"list"`

	// Unique Identifier for Connector
	ConnectorId *string `locationName:"connectorId" type:"string"`

	// Internet Protocol (IP) Address
	IpAddress *string `locationName:"ipAddress" type:"string"`

	// Hardware (MAC) address
	MacAddress *string `locationName:"macAddress" type:"string"`

	// Status of on-premise Connector
	Status *string `locationName:"status" type:"string" enum:"ConnectorStatus"`

	// Connector version string
	Version *string `locationName:"version" type:"string"`

	// Unique Identifier for VM Manager
	VmManagerId *string `locationName:"vmManagerId" type:"string"`

	// VM Manager Name
	VmManagerName *string `locationName:"vmManagerName" type:"string"`

	// VM Management Product
	VmManagerType *string `locationName:"vmManagerType" type:"string" enum:"VmManagerType"`
	// contains filtered or unexported fields
}

Object representing a Connector Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/Connector

func (Connector) GoString 

func (s Connector) GoString() string

GoString returns the string representation

func (*Connector) SetAssociatedOn added in v1.5.0 

func (s *Connector) SetAssociatedOn(v time.Time) *Connector

SetAssociatedOn sets the AssociatedOn field's value.

func (*Connector) SetCapabilityList added in v1.5.0 

func (s *Connector) SetCapabilityList(v []*string) *Connector

SetCapabilityList sets the CapabilityList field's value.

func (*Connector) SetConnectorId added in v1.5.0 

func (s *Connector) SetConnectorId(v string) *Connector

SetConnectorId sets the ConnectorId field's value.

func (*Connector) SetIpAddress added in v1.5.0 

func (s *Connector) SetIpAddress(v string) *Connector

SetIpAddress sets the IpAddress field's value.

func (*Connector) SetMacAddress added in v1.5.0 

func (s *Connector) SetMacAddress(v string) *Connector

SetMacAddress sets the MacAddress field's value.

func (*Connector) SetStatus added in v1.5.0 

func (s *Connector) SetStatus(v string) *Connector

SetStatus sets the Status field's value.

func (*Connector) SetVersion added in v1.5.0 

func (s *Connector) SetVersion(v string) *Connector

SetVersion sets the Version field's value.

func (*Connector) SetVmManagerId added in v1.5.0 

func (s *Connector) SetVmManagerId(v string) *Connector

SetVmManagerId sets the VmManagerId field's value.

func (*Connector) SetVmManagerName added in v1.5.0 

func (s *Connector) SetVmManagerName(v string) *Connector

SetVmManagerName sets the VmManagerName field's value.

func (*Connector) SetVmManagerType added in v1.5.0 

func (s *Connector) SetVmManagerType(v string) *Connector

SetVmManagerType sets the VmManagerType field's value.

func (Connector) String 

func (s Connector) String() string

String returns the string representation

type CreateReplicationJobInput 

type CreateReplicationJobInput struct {

	// The description for a Replication Job/Run.
	Description *string `locationName:"description" type:"string"`

	// Interval between Replication Runs. This value is specified in hours, and
	// represents the time between consecutive Replication Runs.
	//
	// Frequency is a required field
	Frequency *int64 `locationName:"frequency" type:"integer" required:"true"`

	// The license type to be used for the Amazon Machine Image (AMI) created after
	// a successful ReplicationRun.
	LicenseType *string `locationName:"licenseType" type:"string" enum:"LicenseType"`

	// Name of service role in customer's account to be used by SMS service.
	RoleName *string `locationName:"roleName" type:"string"`

	// Timestamp of an operation
	//
	// SeedReplicationTime is a required field
	SeedReplicationTime *time.Time `locationName:"seedReplicationTime" type:"timestamp" timestampFormat:"unix" required:"true"`

	// Unique Identifier for a server
	//
	// ServerId is a required field
	ServerId *string `locationName:"serverId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/CreateReplicationJobRequest

func (CreateReplicationJobInput) GoString 

func (s CreateReplicationJobInput) GoString() string

GoString returns the string representation

func (*CreateReplicationJobInput) SetDescription added in v1.5.0 

func (s *CreateReplicationJobInput) SetDescription(v string) *CreateReplicationJobInput

SetDescription sets the Description field's value.

func (*CreateReplicationJobInput) SetFrequency added in v1.5.0 

func (s *CreateReplicationJobInput) SetFrequency(v int64) *CreateReplicationJobInput

SetFrequency sets the Frequency field's value.

func (*CreateReplicationJobInput) SetLicenseType added in v1.5.0 

func (s *CreateReplicationJobInput) SetLicenseType(v string) *CreateReplicationJobInput

SetLicenseType sets the LicenseType field's value.

func (*CreateReplicationJobInput) SetRoleName added in v1.5.0 

func (s *CreateReplicationJobInput) SetRoleName(v string) *CreateReplicationJobInput

SetRoleName sets the RoleName field's value.

func (*CreateReplicationJobInput) SetSeedReplicationTime added in v1.5.0 

func (s *CreateReplicationJobInput) SetSeedReplicationTime(v time.Time) *CreateReplicationJobInput

SetSeedReplicationTime sets the SeedReplicationTime field's value.

func (*CreateReplicationJobInput) SetServerId added in v1.5.0 

func (s *CreateReplicationJobInput) SetServerId(v string) *CreateReplicationJobInput

SetServerId sets the ServerId field's value.

func (CreateReplicationJobInput) String 

func (s CreateReplicationJobInput) String() string

String returns the string representation

func (*CreateReplicationJobInput) Validate 

func (s *CreateReplicationJobInput) Validate() error

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

type CreateReplicationJobOutput 

type CreateReplicationJobOutput struct {

	// The unique identifier for a Replication Job.
	ReplicationJobId *string `locationName:"replicationJobId" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/CreateReplicationJobResponse

func (CreateReplicationJobOutput) GoString 

func (s CreateReplicationJobOutput) GoString() string

GoString returns the string representation

func (*CreateReplicationJobOutput) SetReplicationJobId added in v1.5.0 

func (s *CreateReplicationJobOutput) SetReplicationJobId(v string) *CreateReplicationJobOutput

SetReplicationJobId sets the ReplicationJobId field's value.

func (CreateReplicationJobOutput) String 

func (s CreateReplicationJobOutput) String() string

String returns the string representation

type DeleteReplicationJobInput 

type DeleteReplicationJobInput struct {

	// The unique identifier for a Replication Job.
	//
	// ReplicationJobId is a required field
	ReplicationJobId *string `locationName:"replicationJobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteReplicationJobRequest

func (DeleteReplicationJobInput) GoString 

func (s DeleteReplicationJobInput) GoString() string

GoString returns the string representation

func (*DeleteReplicationJobInput) SetReplicationJobId added in v1.5.0 

func (s *DeleteReplicationJobInput) SetReplicationJobId(v string) *DeleteReplicationJobInput

SetReplicationJobId sets the ReplicationJobId field's value.

func (DeleteReplicationJobInput) String 

func (s DeleteReplicationJobInput) String() string

String returns the string representation

func (*DeleteReplicationJobInput) Validate 

func (s *DeleteReplicationJobInput) Validate() error

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

type DeleteReplicationJobOutput 

type DeleteReplicationJobOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteReplicationJobResponse

func (DeleteReplicationJobOutput) GoString 

func (s DeleteReplicationJobOutput) GoString() string

GoString returns the string representation

func (DeleteReplicationJobOutput) String 

func (s DeleteReplicationJobOutput) String() string

String returns the string representation

type DeleteServerCatalogInput 

type DeleteServerCatalogInput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteServerCatalogRequest

func (DeleteServerCatalogInput) GoString 

func (s DeleteServerCatalogInput) GoString() string

GoString returns the string representation

func (DeleteServerCatalogInput) String 

func (s DeleteServerCatalogInput) String() string

String returns the string representation

type DeleteServerCatalogOutput 

type DeleteServerCatalogOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteServerCatalogResponse

func (DeleteServerCatalogOutput) GoString 

func (s DeleteServerCatalogOutput) GoString() string

GoString returns the string representation

func (DeleteServerCatalogOutput) String 

func (s DeleteServerCatalogOutput) String() string

String returns the string representation

type DisassociateConnectorInput 

type DisassociateConnectorInput struct {

	// Unique Identifier for Connector
	//
	// ConnectorId is a required field
	ConnectorId *string `locationName:"connectorId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DisassociateConnectorRequest

func (DisassociateConnectorInput) GoString 

func (s DisassociateConnectorInput) GoString() string

GoString returns the string representation

func (*DisassociateConnectorInput) SetConnectorId added in v1.5.0 

func (s *DisassociateConnectorInput) SetConnectorId(v string) *DisassociateConnectorInput

SetConnectorId sets the ConnectorId field's value.

func (DisassociateConnectorInput) String 

func (s DisassociateConnectorInput) String() string

String returns the string representation

func (*DisassociateConnectorInput) Validate 

func (s *DisassociateConnectorInput) Validate() error

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

type DisassociateConnectorOutput 

type DisassociateConnectorOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DisassociateConnectorResponse

func (DisassociateConnectorOutput) GoString 

func (s DisassociateConnectorOutput) GoString() string

GoString returns the string representation

func (DisassociateConnectorOutput) String 

func (s DisassociateConnectorOutput) String() string

String returns the string representation

type GetConnectorsInput 

type GetConnectorsInput struct {

	// The maximum number of results to return in one API call. If left empty, this
	// will default to 50.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// Pagination token to pass as input to API call
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetConnectorsRequest

func (GetConnectorsInput) GoString 

func (s GetConnectorsInput) GoString() string

GoString returns the string representation

func (*GetConnectorsInput) SetMaxResults added in v1.5.0 

func (s *GetConnectorsInput) SetMaxResults(v int64) *GetConnectorsInput

SetMaxResults sets the MaxResults field's value.

func (*GetConnectorsInput) SetNextToken added in v1.5.0 

func (s *GetConnectorsInput) SetNextToken(v string) *GetConnectorsInput

SetNextToken sets the NextToken field's value.

func (GetConnectorsInput) String 

func (s GetConnectorsInput) String() string

String returns the string representation

type GetConnectorsOutput 

type GetConnectorsOutput struct {

	// List of connectors
	ConnectorList []*Connector `locationName:"connectorList" locationNameList:"item" type:"list"`

	// Pagination token to pass as input to API call
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetConnectorsResponse

func (GetConnectorsOutput) GoString 

func (s GetConnectorsOutput) GoString() string

GoString returns the string representation

func (*GetConnectorsOutput) SetConnectorList added in v1.5.0 

func (s *GetConnectorsOutput) SetConnectorList(v []*Connector) *GetConnectorsOutput

SetConnectorList sets the ConnectorList field's value.

func (*GetConnectorsOutput) SetNextToken added in v1.5.0 

func (s *GetConnectorsOutput) SetNextToken(v string) *GetConnectorsOutput

SetNextToken sets the NextToken field's value.

func (GetConnectorsOutput) String 

func (s GetConnectorsOutput) String() string

String returns the string representation

type GetReplicationJobsInput 

type GetReplicationJobsInput struct {

	// The maximum number of results to return in one API call. If left empty, this
	// will default to 50.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// Pagination token to pass as input to API call
	NextToken *string `locationName:"nextToken" type:"string"`

	// The unique identifier for a Replication Job.
	ReplicationJobId *string `locationName:"replicationJobId" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationJobsRequest

func (GetReplicationJobsInput) GoString 

func (s GetReplicationJobsInput) GoString() string

GoString returns the string representation

func (*GetReplicationJobsInput) SetMaxResults added in v1.5.0 

func (s *GetReplicationJobsInput) SetMaxResults(v int64) *GetReplicationJobsInput

SetMaxResults sets the MaxResults field's value.

func (*GetReplicationJobsInput) SetNextToken added in v1.5.0 

func (s *GetReplicationJobsInput) SetNextToken(v string) *GetReplicationJobsInput

SetNextToken sets the NextToken field's value.

func (*GetReplicationJobsInput) SetReplicationJobId added in v1.5.0 

func (s *GetReplicationJobsInput) SetReplicationJobId(v string) *GetReplicationJobsInput

SetReplicationJobId sets the ReplicationJobId field's value.

func (GetReplicationJobsInput) String 

func (s GetReplicationJobsInput) String() string

String returns the string representation

type GetReplicationJobsOutput 

type GetReplicationJobsOutput struct {

	// Pagination token to pass as input to API call
	NextToken *string `locationName:"nextToken" type:"string"`

	// List of Replication Jobs
	ReplicationJobList []*ReplicationJob `locationName:"replicationJobList" locationNameList:"item" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationJobsResponse

func (GetReplicationJobsOutput) GoString 

func (s GetReplicationJobsOutput) GoString() string

GoString returns the string representation

func (*GetReplicationJobsOutput) SetNextToken added in v1.5.0 

func (s *GetReplicationJobsOutput) SetNextToken(v string) *GetReplicationJobsOutput

SetNextToken sets the NextToken field's value.

func (*GetReplicationJobsOutput) SetReplicationJobList added in v1.5.0 

func (s *GetReplicationJobsOutput) SetReplicationJobList(v []*ReplicationJob) *GetReplicationJobsOutput

SetReplicationJobList sets the ReplicationJobList field's value.

func (GetReplicationJobsOutput) String 

func (s GetReplicationJobsOutput) String() string

String returns the string representation

type GetReplicationRunsInput 

type GetReplicationRunsInput struct {

	// The maximum number of results to return in one API call. If left empty, this
	// will default to 50.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// Pagination token to pass as input to API call
	NextToken *string `locationName:"nextToken" type:"string"`

	// The unique identifier for a Replication Job.
	//
	// ReplicationJobId is a required field
	ReplicationJobId *string `locationName:"replicationJobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationRunsRequest

func (GetReplicationRunsInput) GoString 

func (s GetReplicationRunsInput) GoString() string

GoString returns the string representation

func (*GetReplicationRunsInput) SetMaxResults added in v1.5.0 

func (s *GetReplicationRunsInput) SetMaxResults(v int64) *GetReplicationRunsInput

SetMaxResults sets the MaxResults field's value.

func (*GetReplicationRunsInput) SetNextToken added in v1.5.0 

func (s *GetReplicationRunsInput) SetNextToken(v string) *GetReplicationRunsInput

SetNextToken sets the NextToken field's value.

func (*GetReplicationRunsInput) SetReplicationJobId added in v1.5.0 

func (s *GetReplicationRunsInput) SetReplicationJobId(v string) *GetReplicationRunsInput

SetReplicationJobId sets the ReplicationJobId field's value.

func (GetReplicationRunsInput) String 

func (s GetReplicationRunsInput) String() string

String returns the string representation

func (*GetReplicationRunsInput) Validate 

func (s *GetReplicationRunsInput) Validate() error

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

type GetReplicationRunsOutput 

type GetReplicationRunsOutput struct {

	// Pagination token to pass as input to API call
	NextToken *string `locationName:"nextToken" type:"string"`

	// Object representing a Replication Job
	ReplicationJob *ReplicationJob `locationName:"replicationJob" type:"structure"`

	// List of Replication Runs
	ReplicationRunList []*ReplicationRun `locationName:"replicationRunList" locationNameList:"item" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationRunsResponse

func (GetReplicationRunsOutput) GoString 

func (s GetReplicationRunsOutput) GoString() string

GoString returns the string representation

func (*GetReplicationRunsOutput) SetNextToken added in v1.5.0 

func (s *GetReplicationRunsOutput) SetNextToken(v string) *GetReplicationRunsOutput

SetNextToken sets the NextToken field's value.

func (*GetReplicationRunsOutput) SetReplicationJob added in v1.5.0 

func (s *GetReplicationRunsOutput) SetReplicationJob(v *ReplicationJob) *GetReplicationRunsOutput

SetReplicationJob sets the ReplicationJob field's value.

func (*GetReplicationRunsOutput) SetReplicationRunList added in v1.5.0 

func (s *GetReplicationRunsOutput) SetReplicationRunList(v []*ReplicationRun) *GetReplicationRunsOutput

SetReplicationRunList sets the ReplicationRunList field's value.

func (GetReplicationRunsOutput) String 

func (s GetReplicationRunsOutput) String() string

String returns the string representation

type GetServersInput 

type GetServersInput struct {

	// The maximum number of results to return in one API call. If left empty, this
	// will default to 50.
	MaxResults *int64 `locationName:"maxResults" type:"integer"`

	// Pagination token to pass as input to API call
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetServersRequest

func (GetServersInput) GoString 

func (s GetServersInput) GoString() string

GoString returns the string representation

func (*GetServersInput) SetMaxResults added in v1.5.0 

func (s *GetServersInput) SetMaxResults(v int64) *GetServersInput

SetMaxResults sets the MaxResults field's value.

func (*GetServersInput) SetNextToken added in v1.5.0 

func (s *GetServersInput) SetNextToken(v string) *GetServersInput

SetNextToken sets the NextToken field's value.

func (GetServersInput) String 

func (s GetServersInput) String() string

String returns the string representation

type GetServersOutput 

type GetServersOutput struct {

	// Timestamp of an operation
	LastModifiedOn *time.Time `locationName:"lastModifiedOn" type:"timestamp" timestampFormat:"unix"`

	// Pagination token to pass as input to API call
	NextToken *string `locationName:"nextToken" type:"string"`

	// Status of Server catalog
	ServerCatalogStatus *string `locationName:"serverCatalogStatus" type:"string" enum:"ServerCatalogStatus"`

	// List of servers from catalog
	ServerList []*Server `locationName:"serverList" locationNameList:"item" type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetServersResponse

func (GetServersOutput) GoString 

func (s GetServersOutput) GoString() string

GoString returns the string representation

func (*GetServersOutput) SetLastModifiedOn added in v1.5.0 

func (s *GetServersOutput) SetLastModifiedOn(v time.Time) *GetServersOutput

SetLastModifiedOn sets the LastModifiedOn field's value.

func (*GetServersOutput) SetNextToken added in v1.5.0 

func (s *GetServersOutput) SetNextToken(v string) *GetServersOutput

SetNextToken sets the NextToken field's value.

func (*GetServersOutput) SetServerCatalogStatus added in v1.5.0 

func (s *GetServersOutput) SetServerCatalogStatus(v string) *GetServersOutput

SetServerCatalogStatus sets the ServerCatalogStatus field's value.

func (*GetServersOutput) SetServerList added in v1.5.0 

func (s *GetServersOutput) SetServerList(v []*Server) *GetServersOutput

SetServerList sets the ServerList field's value.

func (GetServersOutput) String 

func (s GetServersOutput) String() string

String returns the string representation

type ImportServerCatalogInput 

type ImportServerCatalogInput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportServerCatalogRequest

func (ImportServerCatalogInput) GoString 

func (s ImportServerCatalogInput) GoString() string

GoString returns the string representation

func (ImportServerCatalogInput) String 

func (s ImportServerCatalogInput) String() string

String returns the string representation

type ImportServerCatalogOutput 

type ImportServerCatalogOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportServerCatalogResponse

func (ImportServerCatalogOutput) GoString 

func (s ImportServerCatalogOutput) GoString() string

GoString returns the string representation

func (ImportServerCatalogOutput) String 

func (s ImportServerCatalogOutput) String() string

String returns the string representation

type ReplicationJob 

type ReplicationJob struct {

	// The description for a Replication Job/Run.
	Description *string `locationName:"description" type:"string"`

	// Interval between Replication Runs. This value is specified in hours, and
	// represents the time between consecutive Replication Runs.
	Frequency *int64 `locationName:"frequency" type:"integer"`

	// The AMI id for the image resulting from a Replication Run.
	LatestAmiId *string `locationName:"latestAmiId" type:"string"`

	// The license type to be used for the Amazon Machine Image (AMI) created after
	// a successful ReplicationRun.
	LicenseType *string `locationName:"licenseType" type:"string" enum:"LicenseType"`

	// Timestamp of an operation
	NextReplicationRunStartTime *time.Time `locationName:"nextReplicationRunStartTime" type:"timestamp" timestampFormat:"unix"`

	// The unique identifier for a Replication Job.
	ReplicationJobId *string `locationName:"replicationJobId" type:"string"`

	// List of Replication Runs
	ReplicationRunList []*ReplicationRun `locationName:"replicationRunList" locationNameList:"item" type:"list"`

	// Name of service role in customer's account to be used by SMS service.
	RoleName *string `locationName:"roleName" type:"string"`

	// Timestamp of an operation
	SeedReplicationTime *time.Time `locationName:"seedReplicationTime" type:"timestamp" timestampFormat:"unix"`

	// Unique Identifier for a server
	ServerId *string `locationName:"serverId" type:"string"`

	// Type of server.
	ServerType *string `locationName:"serverType" type:"string" enum:"ServerType"`

	// Current state of Replication Job
	State *string `locationName:"state" type:"string" enum:"ReplicationJobState"`

	// String describing current status of Replication Job
	StatusMessage *string `locationName:"statusMessage" type:"string"`

	// Object representing a VM server
	VmServer *VmServer `locationName:"vmServer" type:"structure"`
	// contains filtered or unexported fields
}

Object representing a Replication Job Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ReplicationJob

func (ReplicationJob) GoString 

func (s ReplicationJob) GoString() string

GoString returns the string representation

func (*ReplicationJob) SetDescription added in v1.5.0 

func (s *ReplicationJob) SetDescription(v string) *ReplicationJob

SetDescription sets the Description field's value.

func (*ReplicationJob) SetFrequency added in v1.5.0 

func (s *ReplicationJob) SetFrequency(v int64) *ReplicationJob

SetFrequency sets the Frequency field's value.

func (*ReplicationJob) SetLatestAmiId added in v1.5.0 

func (s *ReplicationJob) SetLatestAmiId(v string) *ReplicationJob

SetLatestAmiId sets the LatestAmiId field's value.

func (*ReplicationJob) SetLicenseType added in v1.5.0 

func (s *ReplicationJob) SetLicenseType(v string) *ReplicationJob

SetLicenseType sets the LicenseType field's value.

func (*ReplicationJob) SetNextReplicationRunStartTime added in v1.5.0 

func (s *ReplicationJob) SetNextReplicationRunStartTime(v time.Time) *ReplicationJob

SetNextReplicationRunStartTime sets the NextReplicationRunStartTime field's value.

func (*ReplicationJob) SetReplicationJobId added in v1.5.0 

func (s *ReplicationJob) SetReplicationJobId(v string) *ReplicationJob

SetReplicationJobId sets the ReplicationJobId field's value.

func (*ReplicationJob) SetReplicationRunList added in v1.5.0 

func (s *ReplicationJob) SetReplicationRunList(v []*ReplicationRun) *ReplicationJob

SetReplicationRunList sets the ReplicationRunList field's value.

func (*ReplicationJob) SetRoleName added in v1.5.0 

func (s *ReplicationJob) SetRoleName(v string) *ReplicationJob

SetRoleName sets the RoleName field's value.

func (*ReplicationJob) SetSeedReplicationTime added in v1.5.0 

func (s *ReplicationJob) SetSeedReplicationTime(v time.Time) *ReplicationJob

SetSeedReplicationTime sets the SeedReplicationTime field's value.

func (*ReplicationJob) SetServerId added in v1.5.0 

func (s *ReplicationJob) SetServerId(v string) *ReplicationJob

SetServerId sets the ServerId field's value.

func (*ReplicationJob) SetServerType added in v1.5.0 

func (s *ReplicationJob) SetServerType(v string) *ReplicationJob

SetServerType sets the ServerType field's value.

func (*ReplicationJob) SetState added in v1.5.0 

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

SetState sets the State field's value.

func (*ReplicationJob) SetStatusMessage added in v1.5.0 

func (s *ReplicationJob) SetStatusMessage(v string) *ReplicationJob

SetStatusMessage sets the StatusMessage field's value.

func (*ReplicationJob) SetVmServer added in v1.5.0 

func (s *ReplicationJob) SetVmServer(v *VmServer) *ReplicationJob

SetVmServer sets the VmServer field's value.

func (ReplicationJob) String 

func (s ReplicationJob) String() string

String returns the string representation

type ReplicationRun 

type ReplicationRun struct {

	// The AMI id for the image resulting from a Replication Run.
	AmiId *string `locationName:"amiId" type:"string"`

	// Timestamp of an operation
	CompletedTime *time.Time `locationName:"completedTime" type:"timestamp" timestampFormat:"unix"`

	// The description for a Replication Job/Run.
	Description *string `locationName:"description" type:"string"`

	// The unique identifier for a Replication Run.
	ReplicationRunId *string `locationName:"replicationRunId" type:"string"`

	// Timestamp of an operation
	ScheduledStartTime *time.Time `locationName:"scheduledStartTime" type:"timestamp" timestampFormat:"unix"`

	// Current state of Replication Run
	State *string `locationName:"state" type:"string" enum:"ReplicationRunState"`

	// String describing current status of Replication Run
	StatusMessage *string `locationName:"statusMessage" type:"string"`

	// Type of Replication Run
	Type *string `locationName:"type" type:"string" enum:"ReplicationRunType"`
	// contains filtered or unexported fields
}

Object representing a Replication Run Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ReplicationRun

func (ReplicationRun) GoString 

func (s ReplicationRun) GoString() string

GoString returns the string representation

func (*ReplicationRun) SetAmiId added in v1.5.0 

func (s *ReplicationRun) SetAmiId(v string) *ReplicationRun

SetAmiId sets the AmiId field's value.

func (*ReplicationRun) SetCompletedTime added in v1.5.0 

func (s *ReplicationRun) SetCompletedTime(v time.Time) *ReplicationRun

SetCompletedTime sets the CompletedTime field's value.

func (*ReplicationRun) SetDescription added in v1.5.0 

func (s *ReplicationRun) SetDescription(v string) *ReplicationRun

SetDescription sets the Description field's value.

func (*ReplicationRun) SetReplicationRunId added in v1.5.0 

func (s *ReplicationRun) SetReplicationRunId(v string) *ReplicationRun

SetReplicationRunId sets the ReplicationRunId field's value.

func (*ReplicationRun) SetScheduledStartTime added in v1.5.0 

func (s *ReplicationRun) SetScheduledStartTime(v time.Time) *ReplicationRun

SetScheduledStartTime sets the ScheduledStartTime field's value.

func (*ReplicationRun) SetState added in v1.5.0 

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

SetState sets the State field's value.

func (*ReplicationRun) SetStatusMessage added in v1.5.0 

func (s *ReplicationRun) SetStatusMessage(v string) *ReplicationRun

SetStatusMessage sets the StatusMessage field's value.

func (*ReplicationRun) SetType added in v1.5.0 

func (s *ReplicationRun) SetType(v string) *ReplicationRun

SetType sets the Type field's value.

func (ReplicationRun) String 

func (s ReplicationRun) String() string

String returns the string representation

type SMS 

type SMS struct {
	*client.Client
}

SMS provides the API operation methods for making requests to AWS Server Migration Service. See this package's package overview docs for details on the service.

SMS 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) *SMS

New creates a new instance of the SMS 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: 

// Create a SMS client from just a session.
svc := sms.New(mySession)

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

func (*SMS) CreateReplicationJob 

func (c *SMS) CreateReplicationJob(input *CreateReplicationJobInput) (*CreateReplicationJobOutput, error)

CreateReplicationJob API operation for AWS Server Migration Service.

The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS. Call this API to first create a ReplicationJob, which will then schedule periodic ReplicationRuns to replicate your server to AWS. Each ReplicationRun will result in the creation of an AWS AMI.

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 Server Migration Service's API operation CreateReplicationJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • ErrCodeMissingRequiredParameterException "MissingRequiredParameterException" The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

  • ErrCodeOperationNotPermittedException "OperationNotPermittedException" The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ErrCodeServerCannotBeReplicatedException "ServerCannotBeReplicatedException" The provided server cannot be replicated.

  • ErrCodeReplicationJobAlreadyExistsException "ReplicationJobAlreadyExistsException" An active Replication Job already exists for the specified server.

  • ErrCodeNoConnectorsAvailableException "NoConnectorsAvailableException" No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.

  • ErrCodeInternalError "InternalError" An internal error has occured.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/CreateReplicationJob

func (*SMS) CreateReplicationJobRequest 

func (c *SMS) CreateReplicationJobRequest(input *CreateReplicationJobInput) (req *request.Request, output *CreateReplicationJobOutput)

CreateReplicationJobRequest generates a "aws/request.Request" representing the client's request for the CreateReplicationJob operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See CreateReplicationJob for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateReplicationJob method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/CreateReplicationJob

func (*SMS) CreateReplicationJobWithContext added in v1.8.0 

func (c *SMS) CreateReplicationJobWithContext(ctx aws.Context, input *CreateReplicationJobInput, opts ...request.Option) (*CreateReplicationJobOutput, error)

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

See CreateReplicationJob 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 (*SMS) DeleteReplicationJob 

func (c *SMS) DeleteReplicationJob(input *DeleteReplicationJobInput) (*DeleteReplicationJobOutput, error)

DeleteReplicationJob API operation for AWS Server Migration Service.

The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns. This will delete the contents of the S3 bucket used to store SMS artifacts, but will not delete any AMIs created by the SMS service.

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 Server Migration Service's API operation DeleteReplicationJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • ErrCodeMissingRequiredParameterException "MissingRequiredParameterException" The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

  • ErrCodeOperationNotPermittedException "OperationNotPermittedException" The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ErrCodeReplicationJobNotFoundException "ReplicationJobNotFoundException" The specified Replication Job cannot be found.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteReplicationJob

func (*SMS) DeleteReplicationJobRequest 

func (c *SMS) DeleteReplicationJobRequest(input *DeleteReplicationJobInput) (req *request.Request, output *DeleteReplicationJobOutput)

DeleteReplicationJobRequest generates a "aws/request.Request" representing the client's request for the DeleteReplicationJob operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteReplicationJob for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteReplicationJob method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteReplicationJob

func (*SMS) DeleteReplicationJobWithContext added in v1.8.0 

func (c *SMS) DeleteReplicationJobWithContext(ctx aws.Context, input *DeleteReplicationJobInput, opts ...request.Option) (*DeleteReplicationJobOutput, error)

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

See DeleteReplicationJob 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 (*SMS) DeleteServerCatalog 

func (c *SMS) DeleteServerCatalog(input *DeleteServerCatalogInput) (*DeleteServerCatalogOutput, error)

DeleteServerCatalog API operation for AWS Server Migration Service.

The DeleteServerCatalog API clears all servers from your server catalog. This means that these servers will no longer be accessible to the Server Migration Service.

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 Server Migration Service's API operation DeleteServerCatalog for usage and error information.

Returned Error Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

  • ErrCodeOperationNotPermittedException "OperationNotPermittedException" The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • ErrCodeMissingRequiredParameterException "MissingRequiredParameterException" The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteServerCatalog

func (*SMS) DeleteServerCatalogRequest 

func (c *SMS) DeleteServerCatalogRequest(input *DeleteServerCatalogInput) (req *request.Request, output *DeleteServerCatalogOutput)

DeleteServerCatalogRequest generates a "aws/request.Request" representing the client's request for the DeleteServerCatalog operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DeleteServerCatalog for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteServerCatalog method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteServerCatalog

func (*SMS) DeleteServerCatalogWithContext added in v1.8.0 

func (c *SMS) DeleteServerCatalogWithContext(ctx aws.Context, input *DeleteServerCatalogInput, opts ...request.Option) (*DeleteServerCatalogOutput, error)

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

See DeleteServerCatalog 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 (*SMS) DisassociateConnector 

func (c *SMS) DisassociateConnector(input *DisassociateConnectorInput) (*DisassociateConnectorOutput, error)

DisassociateConnector API operation for AWS Server Migration Service.

The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs.

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 Server Migration Service's API operation DisassociateConnector for usage and error information.

Returned Error Codes:

  • ErrCodeMissingRequiredParameterException "MissingRequiredParameterException" The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

  • ErrCodeOperationNotPermittedException "OperationNotPermittedException" The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter specified in the request is not valid, is unsupported, or cannot be used.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DisassociateConnector

func (*SMS) DisassociateConnectorRequest 

func (c *SMS) DisassociateConnectorRequest(input *DisassociateConnectorInput) (req *request.Request, output *DisassociateConnectorOutput)

DisassociateConnectorRequest generates a "aws/request.Request" representing the client's request for the DisassociateConnector operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See DisassociateConnector for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DisassociateConnector method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DisassociateConnector

func (*SMS) DisassociateConnectorWithContext added in v1.8.0 

func (c *SMS) DisassociateConnectorWithContext(ctx aws.Context, input *DisassociateConnectorInput, opts ...request.Option) (*DisassociateConnectorOutput, error)

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

See DisassociateConnector 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 (*SMS) GetConnectors 

func (c *SMS) GetConnectors(input *GetConnectorsInput) (*GetConnectorsOutput, error)

GetConnectors API operation for AWS Server Migration Service.

The GetConnectors API returns a list of connectors that are registered with the Server Migration Service.

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 Server Migration Service's API operation GetConnectors for usage and error information.

Returned Error Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetConnectors

func (*SMS) GetConnectorsPages 

func (c *SMS) GetConnectorsPages(input *GetConnectorsInput, fn func(*GetConnectorsOutput, bool) bool) error

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

See GetConnectors 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 GetConnectors operation.
pageNum := 0
err := client.GetConnectorsPages(params,
    func(page *GetConnectorsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SMS) GetConnectorsPagesWithContext added in v1.8.0 

func (c *SMS) GetConnectorsPagesWithContext(ctx aws.Context, input *GetConnectorsInput, fn func(*GetConnectorsOutput, bool) bool, opts ...request.Option) error

GetConnectorsPagesWithContext same as GetConnectorsPages 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 (*SMS) GetConnectorsRequest 

func (c *SMS) GetConnectorsRequest(input *GetConnectorsInput) (req *request.Request, output *GetConnectorsOutput)

GetConnectorsRequest generates a "aws/request.Request" representing the client's request for the GetConnectors operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetConnectors for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetConnectors method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetConnectors

func (*SMS) GetConnectorsWithContext added in v1.8.0 

func (c *SMS) GetConnectorsWithContext(ctx aws.Context, input *GetConnectorsInput, opts ...request.Option) (*GetConnectorsOutput, error)

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

See GetConnectors 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 (*SMS) GetReplicationJobs 

func (c *SMS) GetReplicationJobs(input *GetReplicationJobsInput) (*GetReplicationJobsOutput, error)

GetReplicationJobs API operation for AWS Server Migration Service.

The GetReplicationJobs API will return all of your ReplicationJobs and their details. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationJobs.

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 Server Migration Service's API operation GetReplicationJobs for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • ErrCodeMissingRequiredParameterException "MissingRequiredParameterException" The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationJobs

func (*SMS) GetReplicationJobsPages 

func (c *SMS) GetReplicationJobsPages(input *GetReplicationJobsInput, fn func(*GetReplicationJobsOutput, bool) bool) error

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

See GetReplicationJobs 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 GetReplicationJobs operation.
pageNum := 0
err := client.GetReplicationJobsPages(params,
    func(page *GetReplicationJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SMS) GetReplicationJobsPagesWithContext added in v1.8.0 

func (c *SMS) GetReplicationJobsPagesWithContext(ctx aws.Context, input *GetReplicationJobsInput, fn func(*GetReplicationJobsOutput, bool) bool, opts ...request.Option) error

GetReplicationJobsPagesWithContext same as GetReplicationJobsPages 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 (*SMS) GetReplicationJobsRequest 

func (c *SMS) GetReplicationJobsRequest(input *GetReplicationJobsInput) (req *request.Request, output *GetReplicationJobsOutput)

GetReplicationJobsRequest generates a "aws/request.Request" representing the client's request for the GetReplicationJobs operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetReplicationJobs for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetReplicationJobs method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationJobs

func (*SMS) GetReplicationJobsWithContext added in v1.8.0 

func (c *SMS) GetReplicationJobsWithContext(ctx aws.Context, input *GetReplicationJobsInput, opts ...request.Option) (*GetReplicationJobsOutput, error)

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

See GetReplicationJobs 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 (*SMS) GetReplicationRuns 

func (c *SMS) GetReplicationRuns(input *GetReplicationRunsInput) (*GetReplicationRunsOutput, error)

GetReplicationRuns API operation for AWS Server Migration Service.

The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationRuns for a ReplicationJob.

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 Server Migration Service's API operation GetReplicationRuns for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • ErrCodeMissingRequiredParameterException "MissingRequiredParameterException" The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationRuns

func (*SMS) GetReplicationRunsPages 

func (c *SMS) GetReplicationRunsPages(input *GetReplicationRunsInput, fn func(*GetReplicationRunsOutput, bool) bool) error

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

See GetReplicationRuns 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 GetReplicationRuns operation.
pageNum := 0
err := client.GetReplicationRunsPages(params,
    func(page *GetReplicationRunsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SMS) GetReplicationRunsPagesWithContext added in v1.8.0 

func (c *SMS) GetReplicationRunsPagesWithContext(ctx aws.Context, input *GetReplicationRunsInput, fn func(*GetReplicationRunsOutput, bool) bool, opts ...request.Option) error

GetReplicationRunsPagesWithContext same as GetReplicationRunsPages 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 (*SMS) GetReplicationRunsRequest 

func (c *SMS) GetReplicationRunsRequest(input *GetReplicationRunsInput) (req *request.Request, output *GetReplicationRunsOutput)

GetReplicationRunsRequest generates a "aws/request.Request" representing the client's request for the GetReplicationRuns operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetReplicationRuns for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetReplicationRuns method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationRuns

func (*SMS) GetReplicationRunsWithContext added in v1.8.0 

func (c *SMS) GetReplicationRunsWithContext(ctx aws.Context, input *GetReplicationRunsInput, opts ...request.Option) (*GetReplicationRunsOutput, error)

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

See GetReplicationRuns 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 (*SMS) GetServers 

func (c *SMS) GetServers(input *GetServersInput) (*GetServersOutput, error)

GetServers API operation for AWS Server Migration Service.

The GetServers API returns a list of all servers in your server catalog. For this call to succeed, you must previously have called ImportServerCatalog.

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 Server Migration Service's API operation GetServers for usage and error information.

Returned Error Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetServers

func (*SMS) GetServersPages 

func (c *SMS) GetServersPages(input *GetServersInput, fn func(*GetServersOutput, bool) bool) error

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

See GetServers 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 GetServers operation.
pageNum := 0
err := client.GetServersPages(params,
    func(page *GetServersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SMS) GetServersPagesWithContext added in v1.8.0 

func (c *SMS) GetServersPagesWithContext(ctx aws.Context, input *GetServersInput, fn func(*GetServersOutput, bool) bool, opts ...request.Option) error

GetServersPagesWithContext same as GetServersPages 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 (*SMS) GetServersRequest 

func (c *SMS) GetServersRequest(input *GetServersInput) (req *request.Request, output *GetServersOutput)

GetServersRequest generates a "aws/request.Request" representing the client's request for the GetServers operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See GetServers for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetServers method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetServers

func (*SMS) GetServersWithContext added in v1.8.0 

func (c *SMS) GetServersWithContext(ctx aws.Context, input *GetServersInput, opts ...request.Option) (*GetServersOutput, error)

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

See GetServers 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 (*SMS) ImportServerCatalog 

func (c *SMS) ImportServerCatalog(input *ImportServerCatalogInput) (*ImportServerCatalogOutput, error)

ImportServerCatalog API operation for AWS Server Migration Service.

The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises. This API call requires connectors to be installed and monitoring all servers you would like imported. This API call returns immediately, but may take some time to retrieve all of the servers.

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 Server Migration Service's API operation ImportServerCatalog for usage and error information.

Returned Error Codes:

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

  • ErrCodeOperationNotPermittedException "OperationNotPermittedException" The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • ErrCodeMissingRequiredParameterException "MissingRequiredParameterException" The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • ErrCodeNoConnectorsAvailableException "NoConnectorsAvailableException" No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportServerCatalog

func (*SMS) ImportServerCatalogRequest 

func (c *SMS) ImportServerCatalogRequest(input *ImportServerCatalogInput) (req *request.Request, output *ImportServerCatalogOutput)

ImportServerCatalogRequest generates a "aws/request.Request" representing the client's request for the ImportServerCatalog operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See ImportServerCatalog for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ImportServerCatalog method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ImportServerCatalog

func (*SMS) ImportServerCatalogWithContext added in v1.8.0 

func (c *SMS) ImportServerCatalogWithContext(ctx aws.Context, input *ImportServerCatalogInput, opts ...request.Option) (*ImportServerCatalogOutput, error)

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

See ImportServerCatalog 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 (*SMS) StartOnDemandReplicationRun 

func (c *SMS) StartOnDemandReplicationRun(input *StartOnDemandReplicationRunInput) (*StartOnDemandReplicationRunOutput, error)

StartOnDemandReplicationRun API operation for AWS Server Migration Service.

The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency). This ReplicationRun will start immediately. StartOnDemandReplicationRun is subject to limits on how many on demand ReplicationRuns you may call per 24-hour period.

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 Server Migration Service's API operation StartOnDemandReplicationRun for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • ErrCodeMissingRequiredParameterException "MissingRequiredParameterException" The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

  • ErrCodeOperationNotPermittedException "OperationNotPermittedException" The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ErrCodeReplicationRunLimitExceededException "ReplicationRunLimitExceededException" This user has exceeded the maximum allowed Replication Run limit.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartOnDemandReplicationRun

func (*SMS) StartOnDemandReplicationRunRequest 

func (c *SMS) StartOnDemandReplicationRunRequest(input *StartOnDemandReplicationRunInput) (req *request.Request, output *StartOnDemandReplicationRunOutput)

StartOnDemandReplicationRunRequest generates a "aws/request.Request" representing the client's request for the StartOnDemandReplicationRun operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See StartOnDemandReplicationRun for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StartOnDemandReplicationRun method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartOnDemandReplicationRun

func (*SMS) StartOnDemandReplicationRunWithContext added in v1.8.0 

func (c *SMS) StartOnDemandReplicationRunWithContext(ctx aws.Context, input *StartOnDemandReplicationRunInput, opts ...request.Option) (*StartOnDemandReplicationRunOutput, error)

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

See StartOnDemandReplicationRun 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 (*SMS) UpdateReplicationJob 

func (c *SMS) UpdateReplicationJob(input *UpdateReplicationJobInput) (*UpdateReplicationJobOutput, error)

UpdateReplicationJob API operation for AWS Server Migration Service.

The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob. Calling this API will affect the next scheduled ReplicationRun.

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 Server Migration Service's API operation UpdateReplicationJob for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidParameterException "InvalidParameterException" A parameter specified in the request is not valid, is unsupported, or cannot be used.

  • ErrCodeMissingRequiredParameterException "MissingRequiredParameterException" The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.

  • ErrCodeOperationNotPermittedException "OperationNotPermittedException" The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.

  • ErrCodeUnauthorizedOperationException "UnauthorizedOperationException" This user does not have permissions to perform this operation.

  • ErrCodeServerCannotBeReplicatedException "ServerCannotBeReplicatedException" The provided server cannot be replicated.

  • ErrCodeReplicationJobNotFoundException "ReplicationJobNotFoundException" The specified Replication Job cannot be found.

  • ErrCodeInternalError "InternalError" An internal error has occured.

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UpdateReplicationJob

func (*SMS) UpdateReplicationJobRequest 

func (c *SMS) UpdateReplicationJobRequest(input *UpdateReplicationJobInput) (req *request.Request, output *UpdateReplicationJobOutput)

UpdateReplicationJobRequest generates a "aws/request.Request" representing the client's request for the UpdateReplicationJob operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

See UpdateReplicationJob for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateReplicationJob method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request. 

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UpdateReplicationJob

func (*SMS) UpdateReplicationJobWithContext added in v1.8.0 

func (c *SMS) UpdateReplicationJobWithContext(ctx aws.Context, input *UpdateReplicationJobInput, opts ...request.Option) (*UpdateReplicationJobOutput, error)

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

See UpdateReplicationJob 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 Server 

type Server struct {

	// The unique identifier for a Replication Job.
	ReplicationJobId *string `locationName:"replicationJobId" type:"string"`

	// An indicator of the Replication Job being deleted or failed.
	ReplicationJobTerminated *bool `locationName:"replicationJobTerminated" type:"boolean"`

	// Unique Identifier for a server
	ServerId *string `locationName:"serverId" type:"string"`

	// Type of server.
	ServerType *string `locationName:"serverType" type:"string" enum:"ServerType"`

	// Object representing a VM server
	VmServer *VmServer `locationName:"vmServer" type:"structure"`
	// contains filtered or unexported fields
}

Object representing a server Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/Server

func (Server) GoString 

func (s Server) GoString() string

GoString returns the string representation

func (*Server) SetReplicationJobId added in v1.5.0 

func (s *Server) SetReplicationJobId(v string) *Server

SetReplicationJobId sets the ReplicationJobId field's value.

func (*Server) SetReplicationJobTerminated added in v1.5.0 

func (s *Server) SetReplicationJobTerminated(v bool) *Server

SetReplicationJobTerminated sets the ReplicationJobTerminated field's value.

func (*Server) SetServerId added in v1.5.0 

func (s *Server) SetServerId(v string) *Server

SetServerId sets the ServerId field's value.

func (*Server) SetServerType added in v1.5.0 

func (s *Server) SetServerType(v string) *Server

SetServerType sets the ServerType field's value.

func (*Server) SetVmServer added in v1.5.0 

func (s *Server) SetVmServer(v *VmServer) *Server

SetVmServer sets the VmServer field's value.

func (Server) String 

func (s Server) String() string

String returns the string representation

type StartOnDemandReplicationRunInput 

type StartOnDemandReplicationRunInput struct {

	// The description for a Replication Job/Run.
	Description *string `locationName:"description" type:"string"`

	// The unique identifier for a Replication Job.
	//
	// ReplicationJobId is a required field
	ReplicationJobId *string `locationName:"replicationJobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartOnDemandReplicationRunRequest

func (StartOnDemandReplicationRunInput) GoString 

func (s StartOnDemandReplicationRunInput) GoString() string

GoString returns the string representation

func (*StartOnDemandReplicationRunInput) SetDescription added in v1.5.0 

func (s *StartOnDemandReplicationRunInput) SetDescription(v string) *StartOnDemandReplicationRunInput

SetDescription sets the Description field's value.

func (*StartOnDemandReplicationRunInput) SetReplicationJobId added in v1.5.0 

func (s *StartOnDemandReplicationRunInput) SetReplicationJobId(v string) *StartOnDemandReplicationRunInput

SetReplicationJobId sets the ReplicationJobId field's value.

func (StartOnDemandReplicationRunInput) String 

func (s StartOnDemandReplicationRunInput) String() string

String returns the string representation

func (*StartOnDemandReplicationRunInput) Validate 

func (s *StartOnDemandReplicationRunInput) Validate() error

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

type StartOnDemandReplicationRunOutput 

type StartOnDemandReplicationRunOutput struct {

	// The unique identifier for a Replication Run.
	ReplicationRunId *string `locationName:"replicationRunId" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartOnDemandReplicationRunResponse

func (StartOnDemandReplicationRunOutput) GoString 

func (s StartOnDemandReplicationRunOutput) GoString() string

GoString returns the string representation

func (*StartOnDemandReplicationRunOutput) SetReplicationRunId added in v1.5.0 

func (s *StartOnDemandReplicationRunOutput) SetReplicationRunId(v string) *StartOnDemandReplicationRunOutput

SetReplicationRunId sets the ReplicationRunId field's value.

func (StartOnDemandReplicationRunOutput) String 

func (s StartOnDemandReplicationRunOutput) String() string

String returns the string representation

type UpdateReplicationJobInput 

type UpdateReplicationJobInput struct {

	// The description for a Replication Job/Run.
	Description *string `locationName:"description" type:"string"`

	// Interval between Replication Runs. This value is specified in hours, and
	// represents the time between consecutive Replication Runs.
	Frequency *int64 `locationName:"frequency" type:"integer"`

	// The license type to be used for the Amazon Machine Image (AMI) created after
	// a successful ReplicationRun.
	LicenseType *string `locationName:"licenseType" type:"string" enum:"LicenseType"`

	// Timestamp of an operation
	NextReplicationRunStartTime *time.Time `locationName:"nextReplicationRunStartTime" type:"timestamp" timestampFormat:"unix"`

	// The unique identifier for a Replication Job.
	//
	// ReplicationJobId is a required field
	ReplicationJobId *string `locationName:"replicationJobId" type:"string" required:"true"`

	// Name of service role in customer's account to be used by SMS service.
	RoleName *string `locationName:"roleName" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UpdateReplicationJobRequest

func (UpdateReplicationJobInput) GoString 

func (s UpdateReplicationJobInput) GoString() string

GoString returns the string representation

func (*UpdateReplicationJobInput) SetDescription added in v1.5.0 

func (s *UpdateReplicationJobInput) SetDescription(v string) *UpdateReplicationJobInput

SetDescription sets the Description field's value.

func (*UpdateReplicationJobInput) SetFrequency added in v1.5.0 

func (s *UpdateReplicationJobInput) SetFrequency(v int64) *UpdateReplicationJobInput

SetFrequency sets the Frequency field's value.

func (*UpdateReplicationJobInput) SetLicenseType added in v1.5.0 

func (s *UpdateReplicationJobInput) SetLicenseType(v string) *UpdateReplicationJobInput

SetLicenseType sets the LicenseType field's value.

func (*UpdateReplicationJobInput) SetNextReplicationRunStartTime added in v1.5.0 

func (s *UpdateReplicationJobInput) SetNextReplicationRunStartTime(v time.Time) *UpdateReplicationJobInput

SetNextReplicationRunStartTime sets the NextReplicationRunStartTime field's value.

func (*UpdateReplicationJobInput) SetReplicationJobId added in v1.5.0 

func (s *UpdateReplicationJobInput) SetReplicationJobId(v string) *UpdateReplicationJobInput

SetReplicationJobId sets the ReplicationJobId field's value.

func (*UpdateReplicationJobInput) SetRoleName added in v1.5.0 

func (s *UpdateReplicationJobInput) SetRoleName(v string) *UpdateReplicationJobInput

SetRoleName sets the RoleName field's value.

func (UpdateReplicationJobInput) String 

func (s UpdateReplicationJobInput) String() string

String returns the string representation

func (*UpdateReplicationJobInput) Validate 

func (s *UpdateReplicationJobInput) Validate() error

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

type UpdateReplicationJobOutput 

type UpdateReplicationJobOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UpdateReplicationJobResponse

func (UpdateReplicationJobOutput) GoString 

func (s UpdateReplicationJobOutput) GoString() string

GoString returns the string representation

func (UpdateReplicationJobOutput) String 

func (s UpdateReplicationJobOutput) String() string

String returns the string representation

type VmServer 

type VmServer struct {

	// VM Manager Name
	VmManagerName *string `locationName:"vmManagerName" type:"string"`

	// VM Management Product
	VmManagerType *string `locationName:"vmManagerType" type:"string" enum:"VmManagerType"`

	// Name of Virtual Machine
	VmName *string `locationName:"vmName" type:"string"`

	// Path to VM
	VmPath *string `locationName:"vmPath" type:"string"`

	// Object representing a server's location
	VmServerAddress *VmServerAddress `locationName:"vmServerAddress" type:"structure"`
	// contains filtered or unexported fields
}

Object representing a VM server Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/VmServer

func (VmServer) GoString 

func (s VmServer) GoString() string

GoString returns the string representation

func (*VmServer) SetVmManagerName added in v1.5.0 

func (s *VmServer) SetVmManagerName(v string) *VmServer

SetVmManagerName sets the VmManagerName field's value.

func (*VmServer) SetVmManagerType added in v1.5.0 

func (s *VmServer) SetVmManagerType(v string) *VmServer

SetVmManagerType sets the VmManagerType field's value.

func (*VmServer) SetVmName added in v1.5.0 

func (s *VmServer) SetVmName(v string) *VmServer

SetVmName sets the VmName field's value.

func (*VmServer) SetVmPath added in v1.5.0 

func (s *VmServer) SetVmPath(v string) *VmServer

SetVmPath sets the VmPath field's value.

func (*VmServer) SetVmServerAddress added in v1.5.0 

func (s *VmServer) SetVmServerAddress(v *VmServerAddress) *VmServer

SetVmServerAddress sets the VmServerAddress field's value.

func (VmServer) String 

func (s VmServer) String() string

String returns the string representation

type VmServerAddress 

type VmServerAddress struct {

	// Unique Identifier for a VM
	VmId *string `locationName:"vmId" type:"string"`

	// Unique Identifier for VM Manager
	VmManagerId *string `locationName:"vmManagerId" type:"string"`
	// contains filtered or unexported fields
}

Object representing a server's location Please also see https://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/VmServerAddress

func (VmServerAddress) GoString 

func (s VmServerAddress) GoString() string

GoString returns the string representation

func (*VmServerAddress) SetVmId added in v1.5.0 

func (s *VmServerAddress) SetVmId(v string) *VmServerAddress

SetVmId sets the VmId field's value.

func (*VmServerAddress) SetVmManagerId added in v1.5.0 

func (s *VmServerAddress) SetVmManagerId(v string) *VmServerAddress

SetVmManagerId sets the VmManagerId field's value.

func (VmServerAddress) String 

func (s VmServerAddress) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package smsiface provides an interface to enable mocking the AWS Server Migration Service service client for testing your code.
 Package smsiface provides an interface to enable mocking the AWS Server Migration Service 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.
JackTT - Gopher 🇻🇳