Documentation

Overview

    Package migrationhub provides the API client, operations, and parameter types for AWS Migration Hub.

    The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub. Remember that you must set your AWS Migration Hub home region before you call any of these APIs, or a HomeRegionNotSetException error will be returned. Also, you must make the API calls while in your home region.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2017-05-31"
    View Source
    const ServiceID = "Migration Hub"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

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

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

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type AssociateCreatedArtifactInput

          type AssociateCreatedArtifactInput struct {
          
          	// An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance,
          	// RDS instance, etc.)
          	//
          	// This member is required.
          	CreatedArtifact *types.CreatedArtifact
          
          	// Unique identifier that references the migration task. Do not store personal data
          	// in this field.
          	//
          	// This member is required.
          	MigrationTaskName *string
          
          	// The name of the ProgressUpdateStream.
          	//
          	// This member is required.
          	ProgressUpdateStream *string
          
          	// Optional boolean flag to indicate whether any effect should take place. Used to
          	// test if the caller has permission to make the call.
          	DryRun bool
          }

          type AssociateCreatedArtifactOutput

          type AssociateCreatedArtifactOutput struct {
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type AssociateDiscoveredResourceInput

          type AssociateDiscoveredResourceInput struct {
          
          	// Object representing a Resource.
          	//
          	// This member is required.
          	DiscoveredResource *types.DiscoveredResource
          
          	// The identifier given to the MigrationTask. Do not store personal data in this
          	// field.
          	//
          	// This member is required.
          	MigrationTaskName *string
          
          	// The name of the ProgressUpdateStream.
          	//
          	// This member is required.
          	ProgressUpdateStream *string
          
          	// Optional boolean flag to indicate whether any effect should take place. Used to
          	// test if the caller has permission to make the call.
          	DryRun bool
          }

          type AssociateDiscoveredResourceOutput

          type AssociateDiscoveredResourceOutput struct {
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type Client

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

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

            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) AssociateCreatedArtifact

                func (c *Client) AssociateCreatedArtifact(ctx context.Context, params *AssociateCreatedArtifactInput, optFns ...func(*Options)) (*AssociateCreatedArtifactOutput, error)

                  Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:

                  * Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with a migration task.

                  * The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.

                  * Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.

                  func (*Client) AssociateDiscoveredResource

                  func (c *Client) AssociateDiscoveredResource(ctx context.Context, params *AssociateDiscoveredResourceInput, optFns ...func(*Options)) (*AssociateDiscoveredResourceOutput, error)

                    Associates a discovered resource ID from Application Discovery Service with a migration task.

                    func (*Client) CreateProgressUpdateStream

                    func (c *Client) CreateProgressUpdateStream(ctx context.Context, params *CreateProgressUpdateStreamInput, optFns ...func(*Options)) (*CreateProgressUpdateStreamOutput, error)

                      Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

                      func (*Client) DeleteProgressUpdateStream

                      func (c *Client) DeleteProgressUpdateStream(ctx context.Context, params *DeleteProgressUpdateStreamInput, optFns ...func(*Options)) (*DeleteProgressUpdateStreamOutput, error)

                        Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:

                        * The only parameter needed for DeleteProgressUpdateStream is the stream name (same as a CreateProgressUpdateStream call).

                        * The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).

                        * If the stream takes time to be deleted, it might still show up on a ListProgressUpdateStreams call.

                        * CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs related to the tasks belonging to the stream will throw "InvalidInputException" if the stream of the same name is in the process of being deleted.

                        * Once the stream and all of its resources are deleted, CreateProgressUpdateStream for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).

                        func (*Client) DescribeApplicationState

                        func (c *Client) DescribeApplicationState(ctx context.Context, params *DescribeApplicationStateInput, optFns ...func(*Options)) (*DescribeApplicationStateOutput, error)

                          Gets the migration status of an application.

                          func (*Client) DescribeMigrationTask

                          func (c *Client) DescribeMigrationTask(ctx context.Context, params *DescribeMigrationTaskInput, optFns ...func(*Options)) (*DescribeMigrationTaskOutput, error)

                            Retrieves a list of all attributes associated with a specific migration task.

                            func (*Client) DisassociateCreatedArtifact

                            func (c *Client) DisassociateCreatedArtifact(ctx context.Context, params *DisassociateCreatedArtifactInput, optFns ...func(*Options)) (*DisassociateCreatedArtifactOutput, error)

                              Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:

                              * A migration user can call the DisassociateCreatedArtifacts operation to disassociate a created AWS Artifact from a migration task.

                              * The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.

                              * Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc.

                              func (*Client) DisassociateDiscoveredResource

                              func (c *Client) DisassociateDiscoveredResource(ctx context.Context, params *DisassociateDiscoveredResourceInput, optFns ...func(*Options)) (*DisassociateDiscoveredResourceOutput, error)

                                Disassociate an Application Discovery Service discovered resource from a migration task.

                                func (*Client) ImportMigrationTask

                                func (c *Client) ImportMigrationTask(ctx context.Context, params *ImportMigrationTaskInput, optFns ...func(*Options)) (*ImportMigrationTaskOutput, error)

                                  Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool. This API is a prerequisite to calling the NotifyMigrationTaskState API as the migration tool must first register the migration task with Migration Hub.

                                  func (*Client) ListApplicationStates

                                  func (c *Client) ListApplicationStates(ctx context.Context, params *ListApplicationStatesInput, optFns ...func(*Options)) (*ListApplicationStatesOutput, error)

                                    Lists all the migration statuses for your applications. If you use the optional ApplicationIds parameter, only the migration statuses for those applications will be returned.

                                    func (*Client) ListCreatedArtifacts

                                    func (c *Client) ListCreatedArtifacts(ctx context.Context, params *ListCreatedArtifactsInput, optFns ...func(*Options)) (*ListCreatedArtifactsOutput, error)

                                      Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:

                                      * Gets the list of the created artifacts while migration is taking place.

                                      * Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API.

                                      * Lists created artifacts in a paginated interface.

                                      func (*Client) ListDiscoveredResources

                                      func (c *Client) ListDiscoveredResources(ctx context.Context, params *ListDiscoveredResourcesInput, optFns ...func(*Options)) (*ListDiscoveredResourcesOutput, error)

                                        Lists discovered resources associated with the given MigrationTask.

                                        func (*Client) ListMigrationTasks

                                        func (c *Client) ListMigrationTasks(ctx context.Context, params *ListMigrationTasksInput, optFns ...func(*Options)) (*ListMigrationTasksOutput, error)

                                          Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:

                                          * Can show a summary list of the most recent migration tasks.

                                          * Can show a summary list of migration tasks associated with a given discovered resource.

                                          * Lists migration tasks in a paginated interface.

                                          func (*Client) ListProgressUpdateStreams

                                          func (c *Client) ListProgressUpdateStreams(ctx context.Context, params *ListProgressUpdateStreamsInput, optFns ...func(*Options)) (*ListProgressUpdateStreamsOutput, error)

                                            Lists progress update streams associated with the user account making this call.

                                            func (*Client) NotifyApplicationState

                                            func (c *Client) NotifyApplicationState(ctx context.Context, params *NotifyApplicationStateInput, optFns ...func(*Options)) (*NotifyApplicationStateOutput, error)

                                              Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED.

                                              func (*Client) NotifyMigrationTaskState

                                              func (c *Client) NotifyMigrationTaskState(ctx context.Context, params *NotifyMigrationTaskStateInput, optFns ...func(*Options)) (*NotifyMigrationTaskStateOutput, error)

                                                Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:

                                                * Migration tools will call the NotifyMigrationTaskState API to share the latest progress and status.

                                                * MigrationTaskName is used for addressing updates to the correct target.

                                                * ProgressUpdateStream is used for access control and to provide a namespace for each migration tool.

                                                func (*Client) PutResourceAttributes

                                                func (c *Client) PutResourceAttributes(ctx context.Context, params *PutResourceAttributesInput, optFns ...func(*Options)) (*PutResourceAttributesOutput, error)

                                                  Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository. This association occurs asynchronously after PutResourceAttributes returns.

                                                  * Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overriding the MAC address.

                                                  * Note the instructions regarding the special use case of the ResourceAttributeList (https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#migrationhub-PutResourceAttributes-request-ResourceAttributeList) parameter when specifying any "VM" related value.

                                                  Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListDiscoveredResources.

                                                  type CreateProgressUpdateStreamInput

                                                  type CreateProgressUpdateStreamInput struct {
                                                  
                                                  	// The name of the ProgressUpdateStream. Do not store personal data in this field.
                                                  	//
                                                  	// This member is required.
                                                  	ProgressUpdateStreamName *string
                                                  
                                                  	// Optional boolean flag to indicate whether any effect should take place. Used to
                                                  	// test if the caller has permission to make the call.
                                                  	DryRun bool
                                                  }

                                                  type CreateProgressUpdateStreamOutput

                                                  type CreateProgressUpdateStreamOutput struct {
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type DeleteProgressUpdateStreamInput

                                                  type DeleteProgressUpdateStreamInput struct {
                                                  
                                                  	// The name of the ProgressUpdateStream. Do not store personal data in this field.
                                                  	//
                                                  	// This member is required.
                                                  	ProgressUpdateStreamName *string
                                                  
                                                  	// Optional boolean flag to indicate whether any effect should take place. Used to
                                                  	// test if the caller has permission to make the call.
                                                  	DryRun bool
                                                  }

                                                  type DeleteProgressUpdateStreamOutput

                                                  type DeleteProgressUpdateStreamOutput struct {
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type DescribeApplicationStateInput

                                                  type DescribeApplicationStateInput struct {
                                                  
                                                  	// The configurationId in Application Discovery Service that uniquely identifies
                                                  	// the grouped application.
                                                  	//
                                                  	// This member is required.
                                                  	ApplicationId *string
                                                  }

                                                  type DescribeApplicationStateOutput

                                                  type DescribeApplicationStateOutput struct {
                                                  
                                                  	// Status of the application - Not Started, In-Progress, Complete.
                                                  	ApplicationStatus types.ApplicationStatus
                                                  
                                                  	// The timestamp when the application status was last updated.
                                                  	LastUpdatedTime *time.Time
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type DescribeMigrationTaskInput

                                                  type DescribeMigrationTaskInput struct {
                                                  
                                                  	// The identifier given to the MigrationTask. Do not store personal data in this
                                                  	// field.
                                                  	//
                                                  	// This member is required.
                                                  	MigrationTaskName *string
                                                  
                                                  	// The name of the ProgressUpdateStream.
                                                  	//
                                                  	// This member is required.
                                                  	ProgressUpdateStream *string
                                                  }

                                                  type DescribeMigrationTaskOutput

                                                  type DescribeMigrationTaskOutput struct {
                                                  
                                                  	// Object encapsulating information about the migration task.
                                                  	MigrationTask *types.MigrationTask
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type DisassociateCreatedArtifactInput

                                                  type DisassociateCreatedArtifactInput struct {
                                                  
                                                  	// An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance,
                                                  	// RDS instance, etc.)
                                                  	//
                                                  	// This member is required.
                                                  	CreatedArtifactName *string
                                                  
                                                  	// Unique identifier that references the migration task to be disassociated with
                                                  	// the artifact. Do not store personal data in this field.
                                                  	//
                                                  	// This member is required.
                                                  	MigrationTaskName *string
                                                  
                                                  	// The name of the ProgressUpdateStream.
                                                  	//
                                                  	// This member is required.
                                                  	ProgressUpdateStream *string
                                                  
                                                  	// Optional boolean flag to indicate whether any effect should take place. Used to
                                                  	// test if the caller has permission to make the call.
                                                  	DryRun bool
                                                  }

                                                  type DisassociateCreatedArtifactOutput

                                                  type DisassociateCreatedArtifactOutput struct {
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type DisassociateDiscoveredResourceInput

                                                  type DisassociateDiscoveredResourceInput struct {
                                                  
                                                  	// ConfigurationId of the Application Discovery Service resource to be
                                                  	// disassociated.
                                                  	//
                                                  	// This member is required.
                                                  	ConfigurationId *string
                                                  
                                                  	// The identifier given to the MigrationTask. Do not store personal data in this
                                                  	// field.
                                                  	//
                                                  	// This member is required.
                                                  	MigrationTaskName *string
                                                  
                                                  	// The name of the ProgressUpdateStream.
                                                  	//
                                                  	// This member is required.
                                                  	ProgressUpdateStream *string
                                                  
                                                  	// Optional boolean flag to indicate whether any effect should take place. Used to
                                                  	// test if the caller has permission to make the call.
                                                  	DryRun bool
                                                  }

                                                  type DisassociateDiscoveredResourceOutput

                                                  type DisassociateDiscoveredResourceOutput struct {
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                  type EndpointResolver

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

                                                    EndpointResolver interface for resolving service endpoints.

                                                    func EndpointResolverFromURL

                                                    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

                                                        type EndpointResolverOptions = internalendpoints.Options

                                                          EndpointResolverOptions is the service endpoint resolver options

                                                          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 ImportMigrationTaskInput

                                                          type ImportMigrationTaskInput struct {
                                                          
                                                          	// Unique identifier that references the migration task. Do not store personal data
                                                          	// in this field.
                                                          	//
                                                          	// This member is required.
                                                          	MigrationTaskName *string
                                                          
                                                          	// The name of the ProgressUpdateStream. >
                                                          	//
                                                          	// This member is required.
                                                          	ProgressUpdateStream *string
                                                          
                                                          	// Optional boolean flag to indicate whether any effect should take place. Used to
                                                          	// test if the caller has permission to make the call.
                                                          	DryRun bool
                                                          }

                                                          type ImportMigrationTaskOutput

                                                          type ImportMigrationTaskOutput struct {
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type ListApplicationStatesAPIClient

                                                          type ListApplicationStatesAPIClient interface {
                                                          	ListApplicationStates(context.Context, *ListApplicationStatesInput, ...func(*Options)) (*ListApplicationStatesOutput, error)
                                                          }

                                                            ListApplicationStatesAPIClient is a client that implements the ListApplicationStates operation.

                                                            type ListApplicationStatesInput

                                                            type ListApplicationStatesInput struct {
                                                            
                                                            	// The configurationIds from the Application Discovery Service that uniquely
                                                            	// identifies your applications.
                                                            	ApplicationIds []string
                                                            
                                                            	// Maximum number of results to be returned per page.
                                                            	MaxResults *int32
                                                            
                                                            	// If a NextToken was returned by a previous call, there are more results
                                                            	// available. To retrieve the next page of results, make the call again using the
                                                            	// returned token in NextToken.
                                                            	NextToken *string
                                                            }

                                                            type ListApplicationStatesOutput

                                                            type ListApplicationStatesOutput struct {
                                                            
                                                            	// A list of Applications that exist in Application Discovery Service.
                                                            	ApplicationStateList []types.ApplicationState
                                                            
                                                            	// If a NextToken was returned by a previous call, there are more results
                                                            	// available. To retrieve the next page of results, make the call again using the
                                                            	// returned token in NextToken.
                                                            	NextToken *string
                                                            
                                                            	// Metadata pertaining to the operation's result.
                                                            	ResultMetadata middleware.Metadata
                                                            }

                                                            type ListApplicationStatesPaginator

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

                                                              ListApplicationStatesPaginator is a paginator for ListApplicationStates

                                                              func NewListApplicationStatesPaginator

                                                                NewListApplicationStatesPaginator returns a new ListApplicationStatesPaginator

                                                                func (*ListApplicationStatesPaginator) HasMorePages

                                                                func (p *ListApplicationStatesPaginator) HasMorePages() bool

                                                                  HasMorePages returns a boolean indicating whether more pages are available

                                                                  func (*ListApplicationStatesPaginator) NextPage

                                                                    NextPage retrieves the next ListApplicationStates page.

                                                                    type ListApplicationStatesPaginatorOptions

                                                                    type ListApplicationStatesPaginatorOptions struct {
                                                                    	// Maximum number of results to be returned per page.
                                                                    	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
                                                                    }

                                                                      ListApplicationStatesPaginatorOptions is the paginator options for ListApplicationStates

                                                                      type ListCreatedArtifactsAPIClient

                                                                      type ListCreatedArtifactsAPIClient interface {
                                                                      	ListCreatedArtifacts(context.Context, *ListCreatedArtifactsInput, ...func(*Options)) (*ListCreatedArtifactsOutput, error)
                                                                      }

                                                                        ListCreatedArtifactsAPIClient is a client that implements the ListCreatedArtifacts operation.

                                                                        type ListCreatedArtifactsInput

                                                                        type ListCreatedArtifactsInput struct {
                                                                        
                                                                        	// Unique identifier that references the migration task. Do not store personal data
                                                                        	// in this field.
                                                                        	//
                                                                        	// This member is required.
                                                                        	MigrationTaskName *string
                                                                        
                                                                        	// The name of the ProgressUpdateStream.
                                                                        	//
                                                                        	// This member is required.
                                                                        	ProgressUpdateStream *string
                                                                        
                                                                        	// Maximum number of results to be returned per page.
                                                                        	MaxResults *int32
                                                                        
                                                                        	// If a NextToken was returned by a previous call, there are more results
                                                                        	// available. To retrieve the next page of results, make the call again using the
                                                                        	// returned token in NextToken.
                                                                        	NextToken *string
                                                                        }

                                                                        type ListCreatedArtifactsOutput

                                                                        type ListCreatedArtifactsOutput struct {
                                                                        
                                                                        	// List of created artifacts up to the maximum number of results specified in the
                                                                        	// request.
                                                                        	CreatedArtifactList []types.CreatedArtifact
                                                                        
                                                                        	// If there are more created artifacts than the max result, return the next token
                                                                        	// to be passed to the next call as a bookmark of where to start from.
                                                                        	NextToken *string
                                                                        
                                                                        	// Metadata pertaining to the operation's result.
                                                                        	ResultMetadata middleware.Metadata
                                                                        }

                                                                        type ListCreatedArtifactsPaginator

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

                                                                          ListCreatedArtifactsPaginator is a paginator for ListCreatedArtifacts

                                                                          func NewListCreatedArtifactsPaginator

                                                                            NewListCreatedArtifactsPaginator returns a new ListCreatedArtifactsPaginator

                                                                            func (*ListCreatedArtifactsPaginator) HasMorePages

                                                                            func (p *ListCreatedArtifactsPaginator) HasMorePages() bool

                                                                              HasMorePages returns a boolean indicating whether more pages are available

                                                                              func (*ListCreatedArtifactsPaginator) NextPage

                                                                                NextPage retrieves the next ListCreatedArtifacts page.

                                                                                type ListCreatedArtifactsPaginatorOptions

                                                                                type ListCreatedArtifactsPaginatorOptions struct {
                                                                                	// Maximum number of results to be returned per page.
                                                                                	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
                                                                                }

                                                                                  ListCreatedArtifactsPaginatorOptions is the paginator options for ListCreatedArtifacts

                                                                                  type ListDiscoveredResourcesAPIClient

                                                                                  type ListDiscoveredResourcesAPIClient interface {
                                                                                  	ListDiscoveredResources(context.Context, *ListDiscoveredResourcesInput, ...func(*Options)) (*ListDiscoveredResourcesOutput, error)
                                                                                  }

                                                                                    ListDiscoveredResourcesAPIClient is a client that implements the ListDiscoveredResources operation.

                                                                                    type ListDiscoveredResourcesInput

                                                                                    type ListDiscoveredResourcesInput struct {
                                                                                    
                                                                                    	// The name of the MigrationTask. Do not store personal data in this field.
                                                                                    	//
                                                                                    	// This member is required.
                                                                                    	MigrationTaskName *string
                                                                                    
                                                                                    	// The name of the ProgressUpdateStream.
                                                                                    	//
                                                                                    	// This member is required.
                                                                                    	ProgressUpdateStream *string
                                                                                    
                                                                                    	// The maximum number of results returned per page.
                                                                                    	MaxResults *int32
                                                                                    
                                                                                    	// If a NextToken was returned by a previous call, there are more results
                                                                                    	// available. To retrieve the next page of results, make the call again using the
                                                                                    	// returned token in NextToken.
                                                                                    	NextToken *string
                                                                                    }

                                                                                    type ListDiscoveredResourcesOutput

                                                                                    type ListDiscoveredResourcesOutput struct {
                                                                                    
                                                                                    	// Returned list of discovered resources associated with the given MigrationTask.
                                                                                    	DiscoveredResourceList []types.DiscoveredResource
                                                                                    
                                                                                    	// If there are more discovered resources than the max result, return the next
                                                                                    	// token to be passed to the next call as a bookmark of where to start from.
                                                                                    	NextToken *string
                                                                                    
                                                                                    	// Metadata pertaining to the operation's result.
                                                                                    	ResultMetadata middleware.Metadata
                                                                                    }

                                                                                    type ListDiscoveredResourcesPaginator

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

                                                                                      ListDiscoveredResourcesPaginator is a paginator for ListDiscoveredResources

                                                                                      func NewListDiscoveredResourcesPaginator

                                                                                        NewListDiscoveredResourcesPaginator returns a new ListDiscoveredResourcesPaginator

                                                                                        func (*ListDiscoveredResourcesPaginator) HasMorePages

                                                                                        func (p *ListDiscoveredResourcesPaginator) HasMorePages() bool

                                                                                          HasMorePages returns a boolean indicating whether more pages are available

                                                                                          func (*ListDiscoveredResourcesPaginator) NextPage

                                                                                            NextPage retrieves the next ListDiscoveredResources page.

                                                                                            type ListDiscoveredResourcesPaginatorOptions

                                                                                            type ListDiscoveredResourcesPaginatorOptions struct {
                                                                                            	// The maximum number of results returned per page.
                                                                                            	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
                                                                                            }

                                                                                              ListDiscoveredResourcesPaginatorOptions is the paginator options for ListDiscoveredResources

                                                                                              type ListMigrationTasksAPIClient

                                                                                              type ListMigrationTasksAPIClient interface {
                                                                                              	ListMigrationTasks(context.Context, *ListMigrationTasksInput, ...func(*Options)) (*ListMigrationTasksOutput, error)
                                                                                              }

                                                                                                ListMigrationTasksAPIClient is a client that implements the ListMigrationTasks operation.

                                                                                                type ListMigrationTasksInput

                                                                                                type ListMigrationTasksInput struct {
                                                                                                
                                                                                                	// Value to specify how many results are returned per page.
                                                                                                	MaxResults *int32
                                                                                                
                                                                                                	// If a NextToken was returned by a previous call, there are more results
                                                                                                	// available. To retrieve the next page of results, make the call again using the
                                                                                                	// returned token in NextToken.
                                                                                                	NextToken *string
                                                                                                
                                                                                                	// Filter migration tasks by discovered resource name.
                                                                                                	ResourceName *string
                                                                                                }

                                                                                                type ListMigrationTasksOutput

                                                                                                type ListMigrationTasksOutput struct {
                                                                                                
                                                                                                	// Lists the migration task's summary which includes: MigrationTaskName,
                                                                                                	// ProgressPercent, ProgressUpdateStream, Status, and the UpdateDateTime for each
                                                                                                	// task.
                                                                                                	MigrationTaskSummaryList []types.MigrationTaskSummary
                                                                                                
                                                                                                	// If there are more migration tasks than the max result, return the next token to
                                                                                                	// be passed to the next call as a bookmark of where to start from.
                                                                                                	NextToken *string
                                                                                                
                                                                                                	// Metadata pertaining to the operation's result.
                                                                                                	ResultMetadata middleware.Metadata
                                                                                                }

                                                                                                type ListMigrationTasksPaginator

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

                                                                                                  ListMigrationTasksPaginator is a paginator for ListMigrationTasks

                                                                                                  func NewListMigrationTasksPaginator

                                                                                                  func NewListMigrationTasksPaginator(client ListMigrationTasksAPIClient, params *ListMigrationTasksInput, optFns ...func(*ListMigrationTasksPaginatorOptions)) *ListMigrationTasksPaginator

                                                                                                    NewListMigrationTasksPaginator returns a new ListMigrationTasksPaginator

                                                                                                    func (*ListMigrationTasksPaginator) HasMorePages

                                                                                                    func (p *ListMigrationTasksPaginator) HasMorePages() bool

                                                                                                      HasMorePages returns a boolean indicating whether more pages are available

                                                                                                      func (*ListMigrationTasksPaginator) NextPage

                                                                                                      func (p *ListMigrationTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMigrationTasksOutput, error)

                                                                                                        NextPage retrieves the next ListMigrationTasks page.

                                                                                                        type ListMigrationTasksPaginatorOptions

                                                                                                        type ListMigrationTasksPaginatorOptions struct {
                                                                                                        	// Value to specify how many results are returned per page.
                                                                                                        	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
                                                                                                        }

                                                                                                          ListMigrationTasksPaginatorOptions is the paginator options for ListMigrationTasks

                                                                                                          type ListProgressUpdateStreamsAPIClient

                                                                                                          type ListProgressUpdateStreamsAPIClient interface {
                                                                                                          	ListProgressUpdateStreams(context.Context, *ListProgressUpdateStreamsInput, ...func(*Options)) (*ListProgressUpdateStreamsOutput, error)
                                                                                                          }

                                                                                                            ListProgressUpdateStreamsAPIClient is a client that implements the ListProgressUpdateStreams operation.

                                                                                                            type ListProgressUpdateStreamsInput

                                                                                                            type ListProgressUpdateStreamsInput struct {
                                                                                                            
                                                                                                            	// Filter to limit the maximum number of results to list per page.
                                                                                                            	MaxResults *int32
                                                                                                            
                                                                                                            	// If a NextToken was returned by a previous call, there are more results
                                                                                                            	// available. To retrieve the next page of results, make the call again using the
                                                                                                            	// returned token in NextToken.
                                                                                                            	NextToken *string
                                                                                                            }

                                                                                                            type ListProgressUpdateStreamsOutput

                                                                                                            type ListProgressUpdateStreamsOutput struct {
                                                                                                            
                                                                                                            	// If there are more streams created than the max result, return the next token to
                                                                                                            	// be passed to the next call as a bookmark of where to start from.
                                                                                                            	NextToken *string
                                                                                                            
                                                                                                            	// List of progress update streams up to the max number of results passed in the
                                                                                                            	// input.
                                                                                                            	ProgressUpdateStreamSummaryList []types.ProgressUpdateStreamSummary
                                                                                                            
                                                                                                            	// Metadata pertaining to the operation's result.
                                                                                                            	ResultMetadata middleware.Metadata
                                                                                                            }

                                                                                                            type ListProgressUpdateStreamsPaginator

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

                                                                                                              ListProgressUpdateStreamsPaginator is a paginator for ListProgressUpdateStreams

                                                                                                              func NewListProgressUpdateStreamsPaginator

                                                                                                                NewListProgressUpdateStreamsPaginator returns a new ListProgressUpdateStreamsPaginator

                                                                                                                func (*ListProgressUpdateStreamsPaginator) HasMorePages

                                                                                                                func (p *ListProgressUpdateStreamsPaginator) HasMorePages() bool

                                                                                                                  HasMorePages returns a boolean indicating whether more pages are available

                                                                                                                  func (*ListProgressUpdateStreamsPaginator) NextPage

                                                                                                                    NextPage retrieves the next ListProgressUpdateStreams page.

                                                                                                                    type ListProgressUpdateStreamsPaginatorOptions

                                                                                                                    type ListProgressUpdateStreamsPaginatorOptions struct {
                                                                                                                    	// Filter to limit the maximum number of results to list per page.
                                                                                                                    	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
                                                                                                                    }

                                                                                                                      ListProgressUpdateStreamsPaginatorOptions is the paginator options for ListProgressUpdateStreams

                                                                                                                      type NotifyApplicationStateInput

                                                                                                                      type NotifyApplicationStateInput struct {
                                                                                                                      
                                                                                                                      	// The configurationId in Application Discovery Service that uniquely identifies
                                                                                                                      	// the grouped application.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	ApplicationId *string
                                                                                                                      
                                                                                                                      	// Status of the application - Not Started, In-Progress, Complete.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	Status types.ApplicationStatus
                                                                                                                      
                                                                                                                      	// Optional boolean flag to indicate whether any effect should take place. Used to
                                                                                                                      	// test if the caller has permission to make the call.
                                                                                                                      	DryRun bool
                                                                                                                      
                                                                                                                      	// The timestamp when the application state changed.
                                                                                                                      	UpdateDateTime *time.Time
                                                                                                                      }

                                                                                                                      type NotifyApplicationStateOutput

                                                                                                                      type NotifyApplicationStateOutput struct {
                                                                                                                      	// Metadata pertaining to the operation's result.
                                                                                                                      	ResultMetadata middleware.Metadata
                                                                                                                      }

                                                                                                                      type NotifyMigrationTaskStateInput

                                                                                                                      type NotifyMigrationTaskStateInput struct {
                                                                                                                      
                                                                                                                      	// Unique identifier that references the migration task. Do not store personal data
                                                                                                                      	// in this field.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	MigrationTaskName *string
                                                                                                                      
                                                                                                                      	// Number of seconds after the UpdateDateTime within which the Migration Hub can
                                                                                                                      	// expect an update. If Migration Hub does not receive an update within the
                                                                                                                      	// specified interval, then the migration task will be considered stale.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	NextUpdateSeconds int32
                                                                                                                      
                                                                                                                      	// The name of the ProgressUpdateStream.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	ProgressUpdateStream *string
                                                                                                                      
                                                                                                                      	// Information about the task's progress and status.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	Task *types.Task
                                                                                                                      
                                                                                                                      	// The timestamp when the task was gathered.
                                                                                                                      	//
                                                                                                                      	// This member is required.
                                                                                                                      	UpdateDateTime *time.Time
                                                                                                                      
                                                                                                                      	// Optional boolean flag to indicate whether any effect should take place. Used to
                                                                                                                      	// test if the caller has permission to make the call.
                                                                                                                      	DryRun bool
                                                                                                                      }

                                                                                                                      type NotifyMigrationTaskStateOutput

                                                                                                                      type NotifyMigrationTaskStateOutput struct {
                                                                                                                      	// Metadata pertaining to the operation's result.
                                                                                                                      	ResultMetadata middleware.Metadata
                                                                                                                      }

                                                                                                                      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
                                                                                                                      
                                                                                                                      	// 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 endpoint options to be used when attempting to resolve an endpoint.
                                                                                                                      	EndpointOptions EndpointResolverOptions
                                                                                                                      
                                                                                                                      	// The service endpoint resolver.
                                                                                                                      	EndpointResolver EndpointResolver
                                                                                                                      
                                                                                                                      	// Signature Version 4 (SigV4) Signer
                                                                                                                      	HTTPSignerV4 HTTPSignerV4
                                                                                                                      
                                                                                                                      	// The logger writer interface to write logging messages to.
                                                                                                                      	Logger logging.Logger
                                                                                                                      
                                                                                                                      	// The region to send requests to. (Required)
                                                                                                                      	Region string
                                                                                                                      
                                                                                                                      	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                                                      	// failures. When nil the API client will use a default retryer.
                                                                                                                      	Retryer aws.Retryer
                                                                                                                      
                                                                                                                      	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                                                      	// implementation if nil.
                                                                                                                      	HTTPClient HTTPClient
                                                                                                                      }

                                                                                                                      func (Options) Copy

                                                                                                                      func (o Options) Copy() Options

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

                                                                                                                        type PutResourceAttributesInput

                                                                                                                        type PutResourceAttributesInput struct {
                                                                                                                        
                                                                                                                        	// Unique identifier that references the migration task. Do not store personal data
                                                                                                                        	// in this field.
                                                                                                                        	//
                                                                                                                        	// This member is required.
                                                                                                                        	MigrationTaskName *string
                                                                                                                        
                                                                                                                        	// The name of the ProgressUpdateStream.
                                                                                                                        	//
                                                                                                                        	// This member is required.
                                                                                                                        	ProgressUpdateStream *string
                                                                                                                        
                                                                                                                        	// Information about the resource that is being migrated. This data will be used to
                                                                                                                        	// map the task to a resource in the Application Discovery Service repository.
                                                                                                                        	// Takes the object array of ResourceAttribute where the Type field is reserved for
                                                                                                                        	// the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN |
                                                                                                                        	// VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID |
                                                                                                                        	// MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256
                                                                                                                        	// characters.
                                                                                                                        	//
                                                                                                                        	// * If any "VM" related value is set for a ResourceAttribute object,
                                                                                                                        	// it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID
                                                                                                                        	// is not set, then all "VM" fields will be discarded and "VM" fields will not be
                                                                                                                        	// used for matching the migration task to a server in Application Discovery
                                                                                                                        	// Service repository. See the Example
                                                                                                                        	// (https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples)
                                                                                                                        	// section below for a use case of specifying "VM" related values.
                                                                                                                        	//
                                                                                                                        	// * If a server
                                                                                                                        	// you are trying to match has multiple IP or MAC addresses, you should provide as
                                                                                                                        	// many as you know in separate type/value pairs passed to the
                                                                                                                        	// ResourceAttributeList parameter to maximize the chances of matching.
                                                                                                                        	//
                                                                                                                        	// This member is required.
                                                                                                                        	ResourceAttributeList []types.ResourceAttribute
                                                                                                                        
                                                                                                                        	// Optional boolean flag to indicate whether any effect should take place. Used to
                                                                                                                        	// test if the caller has permission to make the call.
                                                                                                                        	DryRun bool
                                                                                                                        }

                                                                                                                        type PutResourceAttributesOutput

                                                                                                                        type PutResourceAttributesOutput struct {
                                                                                                                        	// Metadata pertaining to the operation's result.
                                                                                                                        	ResultMetadata middleware.Metadata
                                                                                                                        }

                                                                                                                        type ResolveEndpoint

                                                                                                                        type ResolveEndpoint struct {
                                                                                                                        	Resolver EndpointResolver
                                                                                                                        	Options  EndpointResolverOptions
                                                                                                                        }

                                                                                                                        func (*ResolveEndpoint) HandleSerialize

                                                                                                                        func (*ResolveEndpoint) ID

                                                                                                                        func (*ResolveEndpoint) ID() string

                                                                                                                        Directories

                                                                                                                        Path Synopsis
                                                                                                                        internal