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
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AssociateCreatedArtifactInput
- type AssociateCreatedArtifactOutput
- type AssociateDiscoveredResourceInput
- type AssociateDiscoveredResourceOutput
- type AssociateSourceResourceInput
- type AssociateSourceResourceOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) AssociateCreatedArtifact(ctx context.Context, params *AssociateCreatedArtifactInput, ...) (*AssociateCreatedArtifactOutput, error)
- func (c *Client) AssociateDiscoveredResource(ctx context.Context, params *AssociateDiscoveredResourceInput, ...) (*AssociateDiscoveredResourceOutput, error)
- func (c *Client) AssociateSourceResource(ctx context.Context, params *AssociateSourceResourceInput, ...) (*AssociateSourceResourceOutput, error)
- func (c *Client) CreateProgressUpdateStream(ctx context.Context, params *CreateProgressUpdateStreamInput, ...) (*CreateProgressUpdateStreamOutput, error)
- func (c *Client) DeleteProgressUpdateStream(ctx context.Context, params *DeleteProgressUpdateStreamInput, ...) (*DeleteProgressUpdateStreamOutput, error)
- func (c *Client) DescribeApplicationState(ctx context.Context, params *DescribeApplicationStateInput, ...) (*DescribeApplicationStateOutput, error)
- func (c *Client) DescribeMigrationTask(ctx context.Context, params *DescribeMigrationTaskInput, ...) (*DescribeMigrationTaskOutput, error)
- func (c *Client) DisassociateCreatedArtifact(ctx context.Context, params *DisassociateCreatedArtifactInput, ...) (*DisassociateCreatedArtifactOutput, error)
- func (c *Client) DisassociateDiscoveredResource(ctx context.Context, params *DisassociateDiscoveredResourceInput, ...) (*DisassociateDiscoveredResourceOutput, error)
- func (c *Client) DisassociateSourceResource(ctx context.Context, params *DisassociateSourceResourceInput, ...) (*DisassociateSourceResourceOutput, error)
- func (c *Client) ImportMigrationTask(ctx context.Context, params *ImportMigrationTaskInput, ...) (*ImportMigrationTaskOutput, error)
- func (c *Client) ListApplicationStates(ctx context.Context, params *ListApplicationStatesInput, ...) (*ListApplicationStatesOutput, error)
- func (c *Client) ListCreatedArtifacts(ctx context.Context, params *ListCreatedArtifactsInput, ...) (*ListCreatedArtifactsOutput, error)
- func (c *Client) ListDiscoveredResources(ctx context.Context, params *ListDiscoveredResourcesInput, ...) (*ListDiscoveredResourcesOutput, error)
- func (c *Client) ListMigrationTaskUpdates(ctx context.Context, params *ListMigrationTaskUpdatesInput, ...) (*ListMigrationTaskUpdatesOutput, error)
- func (c *Client) ListMigrationTasks(ctx context.Context, params *ListMigrationTasksInput, optFns ...func(*Options)) (*ListMigrationTasksOutput, error)
- func (c *Client) ListProgressUpdateStreams(ctx context.Context, params *ListProgressUpdateStreamsInput, ...) (*ListProgressUpdateStreamsOutput, error)
- func (c *Client) ListSourceResources(ctx context.Context, params *ListSourceResourcesInput, ...) (*ListSourceResourcesOutput, error)
- func (c *Client) NotifyApplicationState(ctx context.Context, params *NotifyApplicationStateInput, ...) (*NotifyApplicationStateOutput, error)
- func (c *Client) NotifyMigrationTaskState(ctx context.Context, params *NotifyMigrationTaskStateInput, ...) (*NotifyMigrationTaskStateOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PutResourceAttributes(ctx context.Context, params *PutResourceAttributesInput, ...) (*PutResourceAttributesOutput, error)
- type CreateProgressUpdateStreamInput
- type CreateProgressUpdateStreamOutput
- type DeleteProgressUpdateStreamInput
- type DeleteProgressUpdateStreamOutput
- type DescribeApplicationStateInput
- type DescribeApplicationStateOutput
- type DescribeMigrationTaskInput
- type DescribeMigrationTaskOutput
- type DisassociateCreatedArtifactInput
- type DisassociateCreatedArtifactOutput
- type DisassociateDiscoveredResourceInput
- type DisassociateDiscoveredResourceOutput
- type DisassociateSourceResourceInput
- type DisassociateSourceResourceOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type HTTPClient
- type HTTPSignerV4
- type ImportMigrationTaskInput
- type ImportMigrationTaskOutput
- type ListApplicationStatesAPIClient
- type ListApplicationStatesInput
- type ListApplicationStatesOutput
- type ListApplicationStatesPaginator
- type ListApplicationStatesPaginatorOptions
- type ListCreatedArtifactsAPIClient
- type ListCreatedArtifactsInput
- type ListCreatedArtifactsOutput
- type ListCreatedArtifactsPaginator
- type ListCreatedArtifactsPaginatorOptions
- type ListDiscoveredResourcesAPIClient
- type ListDiscoveredResourcesInput
- type ListDiscoveredResourcesOutput
- type ListDiscoveredResourcesPaginator
- type ListDiscoveredResourcesPaginatorOptions
- type ListMigrationTaskUpdatesAPIClient
- type ListMigrationTaskUpdatesInput
- type ListMigrationTaskUpdatesOutput
- type ListMigrationTaskUpdatesPaginator
- type ListMigrationTaskUpdatesPaginatorOptions
- type ListMigrationTasksAPIClient
- type ListMigrationTasksInput
- type ListMigrationTasksOutput
- type ListMigrationTasksPaginator
- type ListMigrationTasksPaginatorOptions
- type ListProgressUpdateStreamsAPIClient
- type ListProgressUpdateStreamsInput
- type ListProgressUpdateStreamsOutput
- type ListProgressUpdateStreamsPaginator
- type ListProgressUpdateStreamsPaginatorOptions
- type ListSourceResourcesAPIClient
- type ListSourceResourcesInput
- type ListSourceResourcesOutput
- type ListSourceResourcesPaginator
- type ListSourceResourcesPaginatorOptions
- type NotifyApplicationStateInput
- type NotifyApplicationStateOutput
- type NotifyMigrationTaskStateInput
- type NotifyMigrationTaskStateOutput
- type Options
- type PutResourceAttributesInput
- type PutResourceAttributesOutput
- type ResolveEndpoint
Constants ¶
const ServiceAPIVersion = "2017-05-31"
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 ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.14.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.17.2
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.17.2
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type 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 // contains filtered or unexported fields }
type AssociateCreatedArtifactOutput ¶
type AssociateCreatedArtifactOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type AssociateDiscoveredResourceOutput ¶
type AssociateDiscoveredResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AssociateSourceResourceInput ¶ added in v1.25.0
type AssociateSourceResourceInput struct { // A unique identifier that references the migration task. Do not include // sensitive data in this field. // // This member is required. MigrationTaskName *string // The name of the progress-update stream, which is used for access control as // well as a namespace for migration-task names that is implicitly linked to your // AWS account. The progress-update stream 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. // // This member is required. ProgressUpdateStream *string // The source resource that you want to associate. // // This member is required. SourceResource *types.SourceResource // This is an optional parameter that you can use to test whether the call will // succeed. Set this parameter to true to verify that you have the permissions // that are required to make the call, and that you have specified the other // parameters in the call correctly. DryRun bool // contains filtered or unexported fields }
type AssociateSourceResourceOutput ¶ added in v1.25.0
type AssociateSourceResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶ added in v1.17.2
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.17.2
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Migration Hub.
func New ¶
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 ¶
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) AssociateSourceResource ¶ added in v1.25.0
func (c *Client) AssociateSourceResource(ctx context.Context, params *AssociateSourceResourceInput, optFns ...func(*Options)) (*AssociateSourceResourceOutput, error)
Associates a source resource with a migration task. For example, the source resource can be a source server, an application, or a migration wave.
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) DisassociateSourceResource ¶ added in v1.25.0
func (c *Client) DisassociateSourceResource(ctx context.Context, params *DisassociateSourceResourceInput, optFns ...func(*Options)) (*DisassociateSourceResourceOutput, error)
Removes the association between a source resource and 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) ListMigrationTaskUpdates ¶ added in v1.25.0
func (c *Client) ListMigrationTaskUpdates(ctx context.Context, params *ListMigrationTaskUpdatesInput, optFns ...func(*Options)) (*ListMigrationTaskUpdatesOutput, error)
This is a paginated API that returns all the migration-task states for the specified MigrationTaskName and ProgressUpdateStream .
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) ListSourceResources ¶ added in v1.25.0
func (c *Client) ListSourceResources(ctx context.Context, params *ListSourceResourcesInput, optFns ...func(*Options)) (*ListSourceResourcesOutput, error)
Lists all the source resource that are associated with the specified MigrationTaskName and ProgressUpdateStream .
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) Options ¶ added in v1.18.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) 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 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 // contains filtered or unexported fields }
type CreateProgressUpdateStreamOutput ¶
type CreateProgressUpdateStreamOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DeleteProgressUpdateStreamOutput ¶
type DeleteProgressUpdateStreamOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeApplicationStateInput ¶
type DescribeApplicationStateInput struct { // The configurationId in Application Discovery Service that uniquely identifies // the grouped application. // // This member is required. ApplicationId *string // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DisassociateCreatedArtifactOutput ¶
type DisassociateCreatedArtifactOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type DisassociateDiscoveredResourceOutput ¶
type DisassociateDiscoveredResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateSourceResourceInput ¶ added in v1.25.0
type DisassociateSourceResourceInput struct { // A unique identifier that references the migration task. Do not include // sensitive data in this field. // // This member is required. MigrationTaskName *string // The name of the progress-update stream, which is used for access control as // well as a namespace for migration-task names that is implicitly linked to your // AWS account. The progress-update stream 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. // // This member is required. ProgressUpdateStream *string // The name that was specified for the source resource. // // This member is required. SourceResourceName *string // This is an optional parameter that you can use to test whether the call will // succeed. Set this parameter to true to verify that you have the permissions // that are required to make the call, and that you have specified the other // parameters in the call correctly. DryRun bool // contains filtered or unexported fields }
type DisassociateSourceResourceOutput ¶ added in v1.25.0
type DisassociateSourceResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.14.0
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.14.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.14.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.14.0
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.14.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type HTTPSignerV4 ¶
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 // contains filtered or unexported fields }
type ImportMigrationTaskOutput ¶
type ImportMigrationTaskOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListApplicationStatesAPIClient ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListApplicationStatesPaginator ¶ added in v0.30.0
type ListApplicationStatesPaginator struct {
// contains filtered or unexported fields
}
ListApplicationStatesPaginator is a paginator for ListApplicationStates
func NewListApplicationStatesPaginator ¶ added in v0.30.0
func NewListApplicationStatesPaginator(client ListApplicationStatesAPIClient, params *ListApplicationStatesInput, optFns ...func(*ListApplicationStatesPaginatorOptions)) *ListApplicationStatesPaginator
NewListApplicationStatesPaginator returns a new ListApplicationStatesPaginator
func (*ListApplicationStatesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListApplicationStatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListApplicationStatesPaginator) NextPage ¶ added in v0.30.0
func (p *ListApplicationStatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationStatesOutput, error)
NextPage retrieves the next ListApplicationStates page.
type ListApplicationStatesPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListCreatedArtifactsPaginator ¶ added in v0.30.0
type ListCreatedArtifactsPaginator struct {
// contains filtered or unexported fields
}
ListCreatedArtifactsPaginator is a paginator for ListCreatedArtifacts
func NewListCreatedArtifactsPaginator ¶ added in v0.30.0
func NewListCreatedArtifactsPaginator(client ListCreatedArtifactsAPIClient, params *ListCreatedArtifactsInput, optFns ...func(*ListCreatedArtifactsPaginatorOptions)) *ListCreatedArtifactsPaginator
NewListCreatedArtifactsPaginator returns a new ListCreatedArtifactsPaginator
func (*ListCreatedArtifactsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListCreatedArtifactsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListCreatedArtifactsPaginator) NextPage ¶ added in v0.30.0
func (p *ListCreatedArtifactsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCreatedArtifactsOutput, error)
NextPage retrieves the next ListCreatedArtifacts page.
type ListCreatedArtifactsPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListDiscoveredResourcesPaginator ¶ added in v0.30.0
type ListDiscoveredResourcesPaginator struct {
// contains filtered or unexported fields
}
ListDiscoveredResourcesPaginator is a paginator for ListDiscoveredResources
func NewListDiscoveredResourcesPaginator ¶ added in v0.30.0
func NewListDiscoveredResourcesPaginator(client ListDiscoveredResourcesAPIClient, params *ListDiscoveredResourcesInput, optFns ...func(*ListDiscoveredResourcesPaginatorOptions)) *ListDiscoveredResourcesPaginator
NewListDiscoveredResourcesPaginator returns a new ListDiscoveredResourcesPaginator
func (*ListDiscoveredResourcesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDiscoveredResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDiscoveredResourcesPaginator) NextPage ¶ added in v0.30.0
func (p *ListDiscoveredResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDiscoveredResourcesOutput, error)
NextPage retrieves the next ListDiscoveredResources page.
type ListDiscoveredResourcesPaginatorOptions ¶ added in v0.30.0
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 ListMigrationTaskUpdatesAPIClient ¶ added in v1.25.0
type ListMigrationTaskUpdatesAPIClient interface {
ListMigrationTaskUpdates(context.Context, *ListMigrationTaskUpdatesInput, ...func(*Options)) (*ListMigrationTaskUpdatesOutput, error)
}
ListMigrationTaskUpdatesAPIClient is a client that implements the ListMigrationTaskUpdates operation.
type ListMigrationTaskUpdatesInput ¶ added in v1.25.0
type ListMigrationTaskUpdatesInput struct { // A unique identifier that references the migration task. Do not include // sensitive data in this field. // // This member is required. MigrationTaskName *string // The name of the progress-update stream, which is used for access control as // well as a namespace for migration-task names that is implicitly linked to your // AWS account. The progress-update stream 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. // // This member is required. ProgressUpdateStream *string // The maximum number of results to include in the response. If more results exist // than the value that you specify here for MaxResults , the response will include // a token that you can use to retrieve the next set of results. MaxResults *int32 // If NextToken was returned by a previous call, there are more results available. // The value of NextToken is a unique pagination token for each page. To retrieve // the next page of results, specify the NextToken value that the previous call // returned. Keep all other arguments unchanged. Each pagination token expires // after 24 hours. Using an expired pagination token will return an HTTP 400 // InvalidToken error. NextToken *string // contains filtered or unexported fields }
type ListMigrationTaskUpdatesOutput ¶ added in v1.25.0
type ListMigrationTaskUpdatesOutput struct { // The list of migration-task updates. MigrationTaskUpdateList []types.MigrationTaskUpdate // If the response includes a NextToken value, that means that there are more // results available. The value of NextToken is a unique pagination token for each // page. To retrieve the next page of results, call this API again and specify this // NextToken value in the request. Keep all other arguments unchanged. Each // pagination token expires after 24 hours. Using an expired pagination token will // return an HTTP 400 InvalidToken error. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListMigrationTaskUpdatesPaginator ¶ added in v1.25.0
type ListMigrationTaskUpdatesPaginator struct {
// contains filtered or unexported fields
}
ListMigrationTaskUpdatesPaginator is a paginator for ListMigrationTaskUpdates
func NewListMigrationTaskUpdatesPaginator ¶ added in v1.25.0
func NewListMigrationTaskUpdatesPaginator(client ListMigrationTaskUpdatesAPIClient, params *ListMigrationTaskUpdatesInput, optFns ...func(*ListMigrationTaskUpdatesPaginatorOptions)) *ListMigrationTaskUpdatesPaginator
NewListMigrationTaskUpdatesPaginator returns a new ListMigrationTaskUpdatesPaginator
func (*ListMigrationTaskUpdatesPaginator) HasMorePages ¶ added in v1.25.0
func (p *ListMigrationTaskUpdatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListMigrationTaskUpdatesPaginator) NextPage ¶ added in v1.25.0
func (p *ListMigrationTaskUpdatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMigrationTaskUpdatesOutput, error)
NextPage retrieves the next ListMigrationTaskUpdates page.
type ListMigrationTaskUpdatesPaginatorOptions ¶ added in v1.25.0
type ListMigrationTaskUpdatesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist // than the value that you specify here for MaxResults , the response will include // a token that you can use to retrieve the next set of results. 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 }
ListMigrationTaskUpdatesPaginatorOptions is the paginator options for ListMigrationTaskUpdates
type ListMigrationTasksAPIClient ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListMigrationTasksPaginator ¶ added in v0.30.0
type ListMigrationTasksPaginator struct {
// contains filtered or unexported fields
}
ListMigrationTasksPaginator is a paginator for ListMigrationTasks
func NewListMigrationTasksPaginator ¶ added in v0.30.0
func NewListMigrationTasksPaginator(client ListMigrationTasksAPIClient, params *ListMigrationTasksInput, optFns ...func(*ListMigrationTasksPaginatorOptions)) *ListMigrationTasksPaginator
NewListMigrationTasksPaginator returns a new ListMigrationTasksPaginator
func (*ListMigrationTasksPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListMigrationTasksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListMigrationTasksPaginator) NextPage ¶ added in v0.30.0
func (p *ListMigrationTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMigrationTasksOutput, error)
NextPage retrieves the next ListMigrationTasks page.
type ListMigrationTasksPaginatorOptions ¶ added in v0.30.0
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 ¶ added in v0.30.0
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 // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type ListProgressUpdateStreamsPaginator ¶ added in v0.30.0
type ListProgressUpdateStreamsPaginator struct {
// contains filtered or unexported fields
}
ListProgressUpdateStreamsPaginator is a paginator for ListProgressUpdateStreams
func NewListProgressUpdateStreamsPaginator ¶ added in v0.30.0
func NewListProgressUpdateStreamsPaginator(client ListProgressUpdateStreamsAPIClient, params *ListProgressUpdateStreamsInput, optFns ...func(*ListProgressUpdateStreamsPaginatorOptions)) *ListProgressUpdateStreamsPaginator
NewListProgressUpdateStreamsPaginator returns a new ListProgressUpdateStreamsPaginator
func (*ListProgressUpdateStreamsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListProgressUpdateStreamsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListProgressUpdateStreamsPaginator) NextPage ¶ added in v0.30.0
func (p *ListProgressUpdateStreamsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProgressUpdateStreamsOutput, error)
NextPage retrieves the next ListProgressUpdateStreams page.
type ListProgressUpdateStreamsPaginatorOptions ¶ added in v0.30.0
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 ListSourceResourcesAPIClient ¶ added in v1.25.0
type ListSourceResourcesAPIClient interface {
ListSourceResources(context.Context, *ListSourceResourcesInput, ...func(*Options)) (*ListSourceResourcesOutput, error)
}
ListSourceResourcesAPIClient is a client that implements the ListSourceResources operation.
type ListSourceResourcesInput ¶ added in v1.25.0
type ListSourceResourcesInput struct { // A unique identifier that references the migration task. Do not store // confidential data in this field. // // This member is required. MigrationTaskName *string // The name of the progress-update stream, which is used for access control as // well as a namespace for migration-task names that is implicitly linked to your // AWS account. The progress-update stream 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. // // This member is required. ProgressUpdateStream *string // The maximum number of results to include in the response. If more results exist // than the value that you specify here for MaxResults , the response will include // a token that you can use to retrieve the next set of results. MaxResults *int32 // If NextToken was returned by a previous call, there are more results available. // The value of NextToken is a unique pagination token for each page. To retrieve // the next page of results, specify the NextToken value that the previous call // returned. Keep all other arguments unchanged. Each pagination token expires // after 24 hours. Using an expired pagination token will return an HTTP 400 // InvalidToken error. NextToken *string // contains filtered or unexported fields }
type ListSourceResourcesOutput ¶ added in v1.25.0
type ListSourceResourcesOutput struct { // If the response includes a NextToken value, that means that there are more // results available. The value of NextToken is a unique pagination token for each // page. To retrieve the next page of results, call this API again and specify this // NextToken value in the request. Keep all other arguments unchanged. Each // pagination token expires after 24 hours. Using an expired pagination token will // return an HTTP 400 InvalidToken error. NextToken *string // The list of source resources. SourceResourceList []types.SourceResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListSourceResourcesPaginator ¶ added in v1.25.0
type ListSourceResourcesPaginator struct {
// contains filtered or unexported fields
}
ListSourceResourcesPaginator is a paginator for ListSourceResources
func NewListSourceResourcesPaginator ¶ added in v1.25.0
func NewListSourceResourcesPaginator(client ListSourceResourcesAPIClient, params *ListSourceResourcesInput, optFns ...func(*ListSourceResourcesPaginatorOptions)) *ListSourceResourcesPaginator
NewListSourceResourcesPaginator returns a new ListSourceResourcesPaginator
func (*ListSourceResourcesPaginator) HasMorePages ¶ added in v1.25.0
func (p *ListSourceResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSourceResourcesPaginator) NextPage ¶ added in v1.25.0
func (p *ListSourceResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSourceResourcesOutput, error)
NextPage retrieves the next ListSourceResources page.
type ListSourceResourcesPaginatorOptions ¶ added in v1.25.0
type ListSourceResourcesPaginatorOptions struct { // The maximum number of results to include in the response. If more results exist // than the value that you specify here for MaxResults , the response will include // a token that you can use to retrieve the next set of results. 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 }
ListSourceResourcesPaginatorOptions is the paginator options for ListSourceResources
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 // contains filtered or unexported fields }
type NotifyApplicationStateOutput ¶
type NotifyApplicationStateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
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 // contains filtered or unexported fields }
type NotifyMigrationTaskStateOutput ¶
type NotifyMigrationTaskStateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The client meter provider. MeterProvider metrics.MeterProvider // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The client tracer provider. TracerProvider tracing.TracerProvider // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) GetIdentityResolver ¶ added in v1.17.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
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]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. // // [Example]: https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples // // 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 // contains filtered or unexported fields }
type PutResourceAttributesOutput ¶
type PutResourceAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
Source Files
¶
- api_client.go
- api_op_AssociateCreatedArtifact.go
- api_op_AssociateDiscoveredResource.go
- api_op_AssociateSourceResource.go
- api_op_CreateProgressUpdateStream.go
- api_op_DeleteProgressUpdateStream.go
- api_op_DescribeApplicationState.go
- api_op_DescribeMigrationTask.go
- api_op_DisassociateCreatedArtifact.go
- api_op_DisassociateDiscoveredResource.go
- api_op_DisassociateSourceResource.go
- api_op_ImportMigrationTask.go
- api_op_ListApplicationStates.go
- api_op_ListCreatedArtifacts.go
- api_op_ListDiscoveredResources.go
- api_op_ListMigrationTaskUpdates.go
- api_op_ListMigrationTasks.go
- api_op_ListProgressUpdateStreams.go
- api_op_ListSourceResources.go
- api_op_NotifyApplicationState.go
- api_op_NotifyMigrationTaskState.go
- api_op_PutResourceAttributes.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go