sms

package module
v1.24.8 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2024 License: Apache-2.0 Imports: 43 Imported by: 21

Documentation

Overview

Package sms provides the API client, operations, and parameter types for AWS Server Migration Service.

Product update

We recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration service for lift-and-shift migrations. If Amazon Web Services MGN is unavailable in a specific Amazon Web Services Region, you can use the Server Migration Service APIs through March 2023.

Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following resources:

Server Migration Service product page

Server Migration Service User Guide

Deprecated: AWS Server Migration Service is Deprecated.

Index

Constants

View Source
const ServiceAPIVersion = "2016-10-24"
View Source
const ServiceID = "SMS"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.14.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.17.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.17.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters added in v1.17.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.17.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client

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

Client provides the API client to make operations call for AWS Server Migration Service.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateApp

func (c *Client) CreateApp(ctx context.Context, params *CreateAppInput, optFns ...func(*Options)) (*CreateAppOutput, error)

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

func (*Client) CreateReplicationJob

func (c *Client) CreateReplicationJob(ctx context.Context, params *CreateReplicationJobInput, optFns ...func(*Options)) (*CreateReplicationJobOutput, error)

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI).

func (*Client) DeleteApp

func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns ...func(*Options)) (*DeleteAppOutput, error)

Deletes the specified application. Optionally deletes the launched stack associated with the application and all Server Migration Service replication jobs for servers in the application.

func (*Client) DeleteAppLaunchConfiguration

func (c *Client) DeleteAppLaunchConfiguration(ctx context.Context, params *DeleteAppLaunchConfigurationInput, optFns ...func(*Options)) (*DeleteAppLaunchConfigurationOutput, error)

Deletes the launch configuration for the specified application.

func (*Client) DeleteAppReplicationConfiguration

func (c *Client) DeleteAppReplicationConfiguration(ctx context.Context, params *DeleteAppReplicationConfigurationInput, optFns ...func(*Options)) (*DeleteAppReplicationConfigurationOutput, error)

Deletes the replication configuration for the specified application.

func (*Client) DeleteAppValidationConfiguration added in v0.29.0

func (c *Client) DeleteAppValidationConfiguration(ctx context.Context, params *DeleteAppValidationConfigurationInput, optFns ...func(*Options)) (*DeleteAppValidationConfigurationOutput, error)

Deletes the validation configuration for the specified application.

func (*Client) DeleteReplicationJob

func (c *Client) DeleteReplicationJob(ctx context.Context, params *DeleteReplicationJobInput, optFns ...func(*Options)) (*DeleteReplicationJobOutput, error)

Deletes the specified replication job.

After you delete a replication job, there are no further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created by the replication runs are not deleted.

func (*Client) DeleteServerCatalog

func (c *Client) DeleteServerCatalog(ctx context.Context, params *DeleteServerCatalogInput, optFns ...func(*Options)) (*DeleteServerCatalogOutput, error)

Deletes all servers from your server catalog.

func (*Client) DisassociateConnector

func (c *Client) DisassociateConnector(ctx context.Context, params *DisassociateConnectorInput, optFns ...func(*Options)) (*DisassociateConnectorOutput, error)

Disassociates the specified connector from Server Migration Service.

After you disassociate a connector, it is no longer available to support replication jobs.

func (*Client) GenerateChangeSet

func (c *Client) GenerateChangeSet(ctx context.Context, params *GenerateChangeSetInput, optFns ...func(*Options)) (*GenerateChangeSetOutput, error)

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

func (*Client) GenerateTemplate

func (c *Client) GenerateTemplate(ctx context.Context, params *GenerateTemplateInput, optFns ...func(*Options)) (*GenerateTemplateOutput, error)

Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

func (*Client) GetApp

func (c *Client) GetApp(ctx context.Context, params *GetAppInput, optFns ...func(*Options)) (*GetAppOutput, error)

Retrieve information about the specified application.

func (*Client) GetAppLaunchConfiguration

func (c *Client) GetAppLaunchConfiguration(ctx context.Context, params *GetAppLaunchConfigurationInput, optFns ...func(*Options)) (*GetAppLaunchConfigurationOutput, error)

Retrieves the application launch configuration associated with the specified application.

func (*Client) GetAppReplicationConfiguration

func (c *Client) GetAppReplicationConfiguration(ctx context.Context, params *GetAppReplicationConfigurationInput, optFns ...func(*Options)) (*GetAppReplicationConfigurationOutput, error)

Retrieves the application replication configuration associated with the specified application.

func (*Client) GetAppValidationConfiguration added in v0.29.0

func (c *Client) GetAppValidationConfiguration(ctx context.Context, params *GetAppValidationConfigurationInput, optFns ...func(*Options)) (*GetAppValidationConfigurationOutput, error)

Retrieves information about a configuration for validating an application.

func (*Client) GetAppValidationOutput added in v0.29.0

func (c *Client) GetAppValidationOutput(ctx context.Context, params *GetAppValidationOutputInput, optFns ...func(*Options)) (*GetAppValidationOutputOutput, error)

Retrieves output from validating an application.

func (*Client) GetConnectors

func (c *Client) GetConnectors(ctx context.Context, params *GetConnectorsInput, optFns ...func(*Options)) (*GetConnectorsOutput, error)

Describes the connectors registered with the Server Migration Service.

func (*Client) GetReplicationJobs

func (c *Client) GetReplicationJobs(ctx context.Context, params *GetReplicationJobsInput, optFns ...func(*Options)) (*GetReplicationJobsOutput, error)

Describes the specified replication job or all of your replication jobs.

func (*Client) GetReplicationRuns

func (c *Client) GetReplicationRuns(ctx context.Context, params *GetReplicationRunsInput, optFns ...func(*Options)) (*GetReplicationRunsOutput, error)

Describes the replication runs for the specified replication job.

func (*Client) GetServers

func (c *Client) GetServers(ctx context.Context, params *GetServersInput, optFns ...func(*Options)) (*GetServersOutput, error)

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

func (*Client) ImportAppCatalog added in v0.29.0

func (c *Client) ImportAppCatalog(ctx context.Context, params *ImportAppCatalogInput, optFns ...func(*Options)) (*ImportAppCatalogOutput, error)

Allows application import from Migration Hub.

func (*Client) ImportServerCatalog

func (c *Client) ImportServerCatalog(ctx context.Context, params *ImportServerCatalogInput, optFns ...func(*Options)) (*ImportServerCatalogOutput, error)

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.

This call returns immediately, but might take additional time to retrieve all the servers.

func (*Client) LaunchApp

func (c *Client) LaunchApp(ctx context.Context, params *LaunchAppInput, optFns ...func(*Options)) (*LaunchAppOutput, error)

Launches the specified application as a stack in CloudFormation.

func (*Client) ListApps

func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ...func(*Options)) (*ListAppsOutput, error)

Retrieves summaries for all applications.

func (*Client) NotifyAppValidationOutput added in v0.29.0

func (c *Client) NotifyAppValidationOutput(ctx context.Context, params *NotifyAppValidationOutputInput, optFns ...func(*Options)) (*NotifyAppValidationOutputOutput, error)

Provides information to Server Migration Service about whether application validation is successful.

func (*Client) Options added in v1.18.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PutAppLaunchConfiguration

func (c *Client) PutAppLaunchConfiguration(ctx context.Context, params *PutAppLaunchConfigurationInput, optFns ...func(*Options)) (*PutAppLaunchConfigurationOutput, error)

Creates or updates the launch configuration for the specified application.

func (*Client) PutAppReplicationConfiguration

func (c *Client) PutAppReplicationConfiguration(ctx context.Context, params *PutAppReplicationConfigurationInput, optFns ...func(*Options)) (*PutAppReplicationConfigurationOutput, error)

Creates or updates the replication configuration for the specified application.

func (*Client) PutAppValidationConfiguration added in v0.29.0

func (c *Client) PutAppValidationConfiguration(ctx context.Context, params *PutAppValidationConfigurationInput, optFns ...func(*Options)) (*PutAppValidationConfigurationOutput, error)

Creates or updates a validation configuration for the specified application.

func (*Client) StartAppReplication

func (c *Client) StartAppReplication(ctx context.Context, params *StartAppReplicationInput, optFns ...func(*Options)) (*StartAppReplicationOutput, error)

Starts replicating the specified application by creating replication jobs for each server in the application.

func (*Client) StartOnDemandAppReplication added in v0.29.0

func (c *Client) StartOnDemandAppReplication(ctx context.Context, params *StartOnDemandAppReplicationInput, optFns ...func(*Options)) (*StartOnDemandAppReplicationOutput, error)

Starts an on-demand replication run for the specified application.

func (*Client) StartOnDemandReplicationRun

func (c *Client) StartOnDemandReplicationRun(ctx context.Context, params *StartOnDemandReplicationRunInput, optFns ...func(*Options)) (*StartOnDemandReplicationRunOutput, error)

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.

func (*Client) StopAppReplication

func (c *Client) StopAppReplication(ctx context.Context, params *StopAppReplicationInput, optFns ...func(*Options)) (*StopAppReplicationOutput, error)

Stops replicating the specified application by deleting the replication job for each server in the application.

func (*Client) TerminateApp

func (c *Client) TerminateApp(ctx context.Context, params *TerminateAppInput, optFns ...func(*Options)) (*TerminateAppOutput, error)

Terminates the stack for the specified application.

func (*Client) UpdateApp

func (c *Client) UpdateApp(ctx context.Context, params *UpdateAppInput, optFns ...func(*Options)) (*UpdateAppOutput, error)

Updates the specified application.

func (*Client) UpdateReplicationJob

func (c *Client) UpdateReplicationJob(ctx context.Context, params *UpdateReplicationJobInput, optFns ...func(*Options)) (*UpdateReplicationJobOutput, error)

Updates the specified settings for the specified replication job.

type CreateAppInput

type CreateAppInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of application creation.
	ClientToken *string

	// The description of the new application
	Description *string

	// The name of the new application.
	Name *string

	// The name of the service role in the customer's account to be used by Server
	// Migration Service.
	RoleName *string

	// The server groups to include in the application.
	ServerGroups []types.ServerGroup

	// The tags to be associated with the application.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAppOutput

type CreateAppOutput struct {

	// A summary description of the application.
	AppSummary *types.AppSummary

	// The server groups included in the application.
	ServerGroups []types.ServerGroup

	// The tags associated with the application.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateReplicationJobInput

type CreateReplicationJobInput struct {

	// The seed replication time.
	//
	// This member is required.
	SeedReplicationTime *time.Time

	// The ID of the server.
	//
	// This member is required.
	ServerId *string

	// The description of the replication job.
	Description *string

	// Indicates whether the replication job produces encrypted AMIs.
	Encrypted *bool

	// The time between consecutive replication runs, in hours.
	Frequency *int32

	// The ID of the KMS key for replication jobs that produce encrypted AMIs. This
	// value can be any of the following:
	//
	//   - KMS key ID
	//
	//   - KMS key alias
	//
	//   - ARN referring to the KMS key ID
	//
	//   - ARN referring to the KMS key alias
	//
	// If encrypted is true but a KMS key ID is not specified, the customer's default
	// KMS key for Amazon EBS is used.
	KmsKeyId *string

	// The license type to be used for the AMI created by a successful replication run.
	LicenseType types.LicenseType

	// The maximum number of SMS-created AMIs to retain. The oldest is deleted after
	// the maximum number is reached and a new AMI is created.
	NumberOfRecentAmisToKeep *int32

	// The name of the IAM role to be used by the Server Migration Service.
	RoleName *string

	// Indicates whether to run the replication job one time.
	RunOnce *bool
	// contains filtered or unexported fields
}

type CreateReplicationJobOutput

type CreateReplicationJobOutput struct {

	// The unique identifier of the replication job.
	ReplicationJobId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAppInput

type DeleteAppInput struct {

	// The ID of the application.
	AppId *string

	// Indicates whether to stop all replication jobs corresponding to the servers in
	// the application while deleting the application.
	ForceStopAppReplication *bool

	// Indicates whether to terminate the stack corresponding to the application while
	// deleting the application.
	ForceTerminateApp *bool
	// contains filtered or unexported fields
}

type DeleteAppLaunchConfigurationInput

type DeleteAppLaunchConfigurationInput struct {

	// The ID of the application.
	AppId *string
	// contains filtered or unexported fields
}

type DeleteAppLaunchConfigurationOutput

type DeleteAppLaunchConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAppOutput

type DeleteAppOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAppReplicationConfigurationInput

type DeleteAppReplicationConfigurationInput struct {

	// The ID of the application.
	AppId *string
	// contains filtered or unexported fields
}

type DeleteAppReplicationConfigurationOutput

type DeleteAppReplicationConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAppValidationConfigurationInput added in v0.29.0

type DeleteAppValidationConfigurationInput struct {

	// The ID of the application.
	//
	// This member is required.
	AppId *string
	// contains filtered or unexported fields
}

type DeleteAppValidationConfigurationOutput added in v0.29.0

type DeleteAppValidationConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteReplicationJobInput

type DeleteReplicationJobInput struct {

	// The ID of the replication job.
	//
	// This member is required.
	ReplicationJobId *string
	// contains filtered or unexported fields
}

type DeleteReplicationJobOutput

type DeleteReplicationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteServerCatalogInput

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

type DeleteServerCatalogOutput

type DeleteServerCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateConnectorInput

type DisassociateConnectorInput struct {

	// The ID of the connector.
	//
	// This member is required.
	ConnectorId *string
	// contains filtered or unexported fields
}

type DisassociateConnectorOutput

type DisassociateConnectorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.14.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.14.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.14.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.14.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.14.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GenerateChangeSetInput

type GenerateChangeSetInput struct {

	// The ID of the application associated with the change set.
	AppId *string

	// The format for the change set.
	ChangesetFormat types.OutputFormat
	// contains filtered or unexported fields
}

type GenerateChangeSetOutput

type GenerateChangeSetOutput struct {

	// The location of the Amazon S3 object.
	S3Location *types.S3Location

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GenerateTemplateInput

type GenerateTemplateInput struct {

	// The ID of the application associated with the CloudFormation template.
	AppId *string

	// The format for generating the CloudFormation template.
	TemplateFormat types.OutputFormat
	// contains filtered or unexported fields
}

type GenerateTemplateOutput

type GenerateTemplateOutput struct {

	// The location of the Amazon S3 object.
	S3Location *types.S3Location

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAppInput

type GetAppInput struct {

	// The ID of the application.
	AppId *string
	// contains filtered or unexported fields
}

type GetAppLaunchConfigurationInput

type GetAppLaunchConfigurationInput struct {

	// The ID of the application.
	AppId *string
	// contains filtered or unexported fields
}

type GetAppLaunchConfigurationOutput

type GetAppLaunchConfigurationOutput struct {

	// The ID of the application.
	AppId *string

	// Indicates whether the application is configured to launch automatically after
	// replication is complete.
	AutoLaunch *bool

	// The name of the service role in the customer's account that CloudFormation uses
	// to launch the application.
	RoleName *string

	// The launch configurations for server groups in this application.
	ServerGroupLaunchConfigurations []types.ServerGroupLaunchConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAppOutput

type GetAppOutput struct {

	// Information about the application.
	AppSummary *types.AppSummary

	// The server groups that belong to the application.
	ServerGroups []types.ServerGroup

	// The tags associated with the application.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAppReplicationConfigurationInput

type GetAppReplicationConfigurationInput struct {

	// The ID of the application.
	AppId *string
	// contains filtered or unexported fields
}

type GetAppReplicationConfigurationOutput

type GetAppReplicationConfigurationOutput struct {

	// The replication configurations associated with server groups in this
	// application.
	ServerGroupReplicationConfigurations []types.ServerGroupReplicationConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAppValidationConfigurationInput added in v0.29.0

type GetAppValidationConfigurationInput struct {

	// The ID of the application.
	//
	// This member is required.
	AppId *string
	// contains filtered or unexported fields
}

type GetAppValidationConfigurationOutput added in v0.29.0

type GetAppValidationConfigurationOutput struct {

	// The configuration for application validation.
	AppValidationConfigurations []types.AppValidationConfiguration

	// The configuration for instance validation.
	ServerGroupValidationConfigurations []types.ServerGroupValidationConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAppValidationOutputInput added in v0.29.0

type GetAppValidationOutputInput struct {

	// The ID of the application.
	//
	// This member is required.
	AppId *string
	// contains filtered or unexported fields
}

type GetAppValidationOutputOutput added in v0.29.0

type GetAppValidationOutputOutput struct {

	// The validation output.
	ValidationOutputList []types.ValidationOutput

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetConnectorsAPIClient added in v0.30.0

type GetConnectorsAPIClient interface {
	GetConnectors(context.Context, *GetConnectorsInput, ...func(*Options)) (*GetConnectorsOutput, error)
}

GetConnectorsAPIClient is a client that implements the GetConnectors operation.

type GetConnectorsInput

type GetConnectorsInput struct {

	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetConnectorsOutput

type GetConnectorsOutput struct {

	// Information about the registered connectors.
	ConnectorList []types.Connector

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetConnectorsPaginator added in v0.30.0

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

GetConnectorsPaginator is a paginator for GetConnectors

func NewGetConnectorsPaginator added in v0.30.0

func NewGetConnectorsPaginator(client GetConnectorsAPIClient, params *GetConnectorsInput, optFns ...func(*GetConnectorsPaginatorOptions)) *GetConnectorsPaginator

NewGetConnectorsPaginator returns a new GetConnectorsPaginator

func (*GetConnectorsPaginator) HasMorePages added in v0.30.0

func (p *GetConnectorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetConnectorsPaginator) NextPage added in v0.30.0

func (p *GetConnectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetConnectorsOutput, error)

NextPage retrieves the next GetConnectors page.

type GetConnectorsPaginatorOptions added in v0.30.0

type GetConnectorsPaginatorOptions struct {
	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetConnectorsPaginatorOptions is the paginator options for GetConnectors

type GetReplicationJobsAPIClient added in v0.30.0

type GetReplicationJobsAPIClient interface {
	GetReplicationJobs(context.Context, *GetReplicationJobsInput, ...func(*Options)) (*GetReplicationJobsOutput, error)
}

GetReplicationJobsAPIClient is a client that implements the GetReplicationJobs operation.

type GetReplicationJobsInput

type GetReplicationJobsInput struct {

	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string

	// The ID of the replication job.
	ReplicationJobId *string
	// contains filtered or unexported fields
}

type GetReplicationJobsOutput

type GetReplicationJobsOutput struct {

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the replication jobs.
	ReplicationJobList []types.ReplicationJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReplicationJobsPaginator added in v0.30.0

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

GetReplicationJobsPaginator is a paginator for GetReplicationJobs

func NewGetReplicationJobsPaginator added in v0.30.0

func NewGetReplicationJobsPaginator(client GetReplicationJobsAPIClient, params *GetReplicationJobsInput, optFns ...func(*GetReplicationJobsPaginatorOptions)) *GetReplicationJobsPaginator

NewGetReplicationJobsPaginator returns a new GetReplicationJobsPaginator

func (*GetReplicationJobsPaginator) HasMorePages added in v0.30.0

func (p *GetReplicationJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetReplicationJobsPaginator) NextPage added in v0.30.0

func (p *GetReplicationJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetReplicationJobsOutput, error)

NextPage retrieves the next GetReplicationJobs page.

type GetReplicationJobsPaginatorOptions added in v0.30.0

type GetReplicationJobsPaginatorOptions struct {
	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetReplicationJobsPaginatorOptions is the paginator options for GetReplicationJobs

type GetReplicationRunsAPIClient added in v0.30.0

type GetReplicationRunsAPIClient interface {
	GetReplicationRuns(context.Context, *GetReplicationRunsInput, ...func(*Options)) (*GetReplicationRunsOutput, error)
}

GetReplicationRunsAPIClient is a client that implements the GetReplicationRuns operation.

type GetReplicationRunsInput

type GetReplicationRunsInput struct {

	// The ID of the replication job.
	//
	// This member is required.
	ReplicationJobId *string

	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type GetReplicationRunsOutput

type GetReplicationRunsOutput struct {

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Information about the replication job.
	ReplicationJob *types.ReplicationJob

	// Information about the replication runs.
	ReplicationRunList []types.ReplicationRun

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReplicationRunsPaginator added in v0.30.0

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

GetReplicationRunsPaginator is a paginator for GetReplicationRuns

func NewGetReplicationRunsPaginator added in v0.30.0

func NewGetReplicationRunsPaginator(client GetReplicationRunsAPIClient, params *GetReplicationRunsInput, optFns ...func(*GetReplicationRunsPaginatorOptions)) *GetReplicationRunsPaginator

NewGetReplicationRunsPaginator returns a new GetReplicationRunsPaginator

func (*GetReplicationRunsPaginator) HasMorePages added in v0.30.0

func (p *GetReplicationRunsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetReplicationRunsPaginator) NextPage added in v0.30.0

func (p *GetReplicationRunsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetReplicationRunsOutput, error)

NextPage retrieves the next GetReplicationRuns page.

type GetReplicationRunsPaginatorOptions added in v0.30.0

type GetReplicationRunsPaginatorOptions struct {
	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetReplicationRunsPaginatorOptions is the paginator options for GetReplicationRuns

type GetServersAPIClient added in v0.30.0

type GetServersAPIClient interface {
	GetServers(context.Context, *GetServersInput, ...func(*Options)) (*GetServersOutput, error)
}

GetServersAPIClient is a client that implements the GetServers operation.

type GetServersInput

type GetServersInput struct {

	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string

	// The server addresses.
	VmServerAddressList []types.VmServerAddress
	// contains filtered or unexported fields
}

type GetServersOutput

type GetServersOutput struct {

	// The time when the server was last modified.
	LastModifiedOn *time.Time

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// The status of the server catalog.
	ServerCatalogStatus types.ServerCatalogStatus

	// Information about the servers.
	ServerList []types.Server

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetServersPaginator added in v0.30.0

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

GetServersPaginator is a paginator for GetServers

func NewGetServersPaginator added in v0.30.0

func NewGetServersPaginator(client GetServersAPIClient, params *GetServersInput, optFns ...func(*GetServersPaginatorOptions)) *GetServersPaginator

NewGetServersPaginator returns a new GetServersPaginator

func (*GetServersPaginator) HasMorePages added in v0.30.0

func (p *GetServersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetServersPaginator) NextPage added in v0.30.0

func (p *GetServersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetServersOutput, error)

NextPage retrieves the next GetServers page.

type GetServersPaginatorOptions added in v0.30.0

type GetServersPaginatorOptions struct {
	// The maximum number of results to return in a single call. The default value is
	// 50. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetServersPaginatorOptions is the paginator options for GetServers

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ImportAppCatalogInput added in v0.29.0

type ImportAppCatalogInput struct {

	// The name of the service role. If you omit this parameter, we create a
	// service-linked role for Migration Hub in your account. Otherwise, the role that
	// you provide must have the [policy and trust policy]described in the Migration Hub User Guide.
	//
	// [policy and trust policy]: https://docs.aws.amazon.com/migrationhub/latest/ug/new-customer-setup.html#sms-managed
	RoleName *string
	// contains filtered or unexported fields
}

type ImportAppCatalogOutput added in v0.29.0

type ImportAppCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ImportServerCatalogInput

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

type ImportServerCatalogOutput

type ImportServerCatalogOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type LaunchAppInput

type LaunchAppInput struct {

	// The ID of the application.
	AppId *string
	// contains filtered or unexported fields
}

type LaunchAppOutput

type LaunchAppOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAppsInput

type ListAppsInput struct {

	// The unique application IDs.
	AppIds []string

	// The maximum number of results to return in a single call. The default value is
	// 100. To retrieve the remaining results, make another call with the returned
	// NextToken value.
	MaxResults *int32

	// The token for the next set of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAppsOutput

type ListAppsOutput struct {

	// The application summaries.
	Apps []types.AppSummary

	// The token required to retrieve the next set of results. This value is null when
	// there are no more results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type NotifyAppValidationOutputInput added in v0.29.0

type NotifyAppValidationOutputInput struct {

	// The ID of the application.
	//
	// This member is required.
	AppId *string

	// The notification information.
	NotificationContext *types.NotificationContext
	// contains filtered or unexported fields
}

type NotifyAppValidationOutputOutput added in v0.29.0

type NotifyAppValidationOutputOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.17.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutAppLaunchConfigurationInput

type PutAppLaunchConfigurationInput struct {

	// The ID of the application.
	AppId *string

	// Indicates whether the application is configured to launch automatically after
	// replication is complete.
	AutoLaunch *bool

	// The name of service role in the customer's account that CloudFormation uses to
	// launch the application.
	RoleName *string

	// Information about the launch configurations for server groups in the
	// application.
	ServerGroupLaunchConfigurations []types.ServerGroupLaunchConfiguration
	// contains filtered or unexported fields
}

type PutAppLaunchConfigurationOutput

type PutAppLaunchConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutAppReplicationConfigurationInput

type PutAppReplicationConfigurationInput struct {

	// The ID of the application.
	AppId *string

	// Information about the replication configurations for server groups in the
	// application.
	ServerGroupReplicationConfigurations []types.ServerGroupReplicationConfiguration
	// contains filtered or unexported fields
}

type PutAppReplicationConfigurationOutput

type PutAppReplicationConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutAppValidationConfigurationInput added in v0.29.0

type PutAppValidationConfigurationInput struct {

	// The ID of the application.
	//
	// This member is required.
	AppId *string

	// The configuration for application validation.
	AppValidationConfigurations []types.AppValidationConfiguration

	// The configuration for instance validation.
	ServerGroupValidationConfigurations []types.ServerGroupValidationConfiguration
	// contains filtered or unexported fields
}

type PutAppValidationConfigurationOutput added in v0.29.0

type PutAppValidationConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type StartAppReplicationInput

type StartAppReplicationInput struct {

	// The ID of the application.
	AppId *string
	// contains filtered or unexported fields
}

type StartAppReplicationOutput

type StartAppReplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartOnDemandAppReplicationInput added in v0.29.0

type StartOnDemandAppReplicationInput struct {

	// The ID of the application.
	//
	// This member is required.
	AppId *string

	// The description of the replication run.
	Description *string
	// contains filtered or unexported fields
}

type StartOnDemandAppReplicationOutput added in v0.29.0

type StartOnDemandAppReplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartOnDemandReplicationRunInput

type StartOnDemandReplicationRunInput struct {

	// The ID of the replication job.
	//
	// This member is required.
	ReplicationJobId *string

	// The description of the replication run.
	Description *string
	// contains filtered or unexported fields
}

type StartOnDemandReplicationRunOutput

type StartOnDemandReplicationRunOutput struct {

	// The ID of the replication run.
	ReplicationRunId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopAppReplicationInput

type StopAppReplicationInput struct {

	// The ID of the application.
	AppId *string
	// contains filtered or unexported fields
}

type StopAppReplicationOutput

type StopAppReplicationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TerminateAppInput

type TerminateAppInput struct {

	// The ID of the application.
	AppId *string
	// contains filtered or unexported fields
}

type TerminateAppOutput

type TerminateAppOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAppInput

type UpdateAppInput struct {

	// The ID of the application.
	AppId *string

	// The new description of the application.
	Description *string

	// The new name of the application.
	Name *string

	// The name of the service role in the customer's account used by Server Migration
	// Service.
	RoleName *string

	// The server groups in the application to update.
	ServerGroups []types.ServerGroup

	// The tags to associate with the application.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type UpdateAppOutput

type UpdateAppOutput struct {

	// A summary description of the application.
	AppSummary *types.AppSummary

	// The updated server groups in the application.
	ServerGroups []types.ServerGroup

	// The tags associated with the application.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateReplicationJobInput

type UpdateReplicationJobInput struct {

	// The ID of the replication job.
	//
	// This member is required.
	ReplicationJobId *string

	// The description of the replication job.
	Description *string

	// When true, the replication job produces encrypted AMIs. For more information,
	// KmsKeyId .
	Encrypted *bool

	// The time between consecutive replication runs, in hours.
	Frequency *int32

	// The ID of the KMS key for replication jobs that produce encrypted AMIs. This
	// value can be any of the following:
	//
	//   - KMS key ID
	//
	//   - KMS key alias
	//
	//   - ARN referring to the KMS key ID
	//
	//   - ARN referring to the KMS key alias
	//
	// If encrypted is enabled but a KMS key ID is not specified, the customer's
	// default KMS key for Amazon EBS is used.
	KmsKeyId *string

	// The license type to be used for the AMI created by a successful replication run.
	LicenseType types.LicenseType

	// The start time of the next replication run.
	NextReplicationRunStartTime *time.Time

	// The maximum number of SMS-created AMIs to retain. The oldest is deleted after
	// the maximum number is reached and a new AMI is created.
	NumberOfRecentAmisToKeep *int32

	// The name of the IAM role to be used by Server Migration Service.
	RoleName *string
	// contains filtered or unexported fields
}

type UpdateReplicationJobOutput

type UpdateReplicationJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL