Documentation ¶
Overview ¶
Package migrationhuborchestrator provides the API client, operations, and parameter types for AWS Migration Hub Orchestrator.
This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Migration Hub Orchestrator. The topic for each action shows the API request parameters and responses. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using.
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 AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error)
- func (c *Client) CreateWorkflow(ctx context.Context, params *CreateWorkflowInput, optFns ...func(*Options)) (*CreateWorkflowOutput, error)
- func (c *Client) CreateWorkflowStep(ctx context.Context, params *CreateWorkflowStepInput, optFns ...func(*Options)) (*CreateWorkflowStepOutput, error)
- func (c *Client) CreateWorkflowStepGroup(ctx context.Context, params *CreateWorkflowStepGroupInput, ...) (*CreateWorkflowStepGroupOutput, error)
- func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput, optFns ...func(*Options)) (*DeleteTemplateOutput, error)
- func (c *Client) DeleteWorkflow(ctx context.Context, params *DeleteWorkflowInput, optFns ...func(*Options)) (*DeleteWorkflowOutput, error)
- func (c *Client) DeleteWorkflowStep(ctx context.Context, params *DeleteWorkflowStepInput, optFns ...func(*Options)) (*DeleteWorkflowStepOutput, error)
- func (c *Client) DeleteWorkflowStepGroup(ctx context.Context, params *DeleteWorkflowStepGroupInput, ...) (*DeleteWorkflowStepGroupOutput, error)
- func (c *Client) GetTemplate(ctx context.Context, params *GetTemplateInput, optFns ...func(*Options)) (*GetTemplateOutput, error)
- func (c *Client) GetTemplateStep(ctx context.Context, params *GetTemplateStepInput, optFns ...func(*Options)) (*GetTemplateStepOutput, error)
- func (c *Client) GetTemplateStepGroup(ctx context.Context, params *GetTemplateStepGroupInput, ...) (*GetTemplateStepGroupOutput, error)
- func (c *Client) GetWorkflow(ctx context.Context, params *GetWorkflowInput, optFns ...func(*Options)) (*GetWorkflowOutput, error)
- func (c *Client) GetWorkflowStep(ctx context.Context, params *GetWorkflowStepInput, optFns ...func(*Options)) (*GetWorkflowStepOutput, error)
- func (c *Client) GetWorkflowStepGroup(ctx context.Context, params *GetWorkflowStepGroupInput, ...) (*GetWorkflowStepGroupOutput, error)
- func (c *Client) ListPlugins(ctx context.Context, params *ListPluginsInput, optFns ...func(*Options)) (*ListPluginsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTemplateStepGroups(ctx context.Context, params *ListTemplateStepGroupsInput, ...) (*ListTemplateStepGroupsOutput, error)
- func (c *Client) ListTemplateSteps(ctx context.Context, params *ListTemplateStepsInput, optFns ...func(*Options)) (*ListTemplateStepsOutput, error)
- func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, optFns ...func(*Options)) (*ListTemplatesOutput, error)
- func (c *Client) ListWorkflowStepGroups(ctx context.Context, params *ListWorkflowStepGroupsInput, ...) (*ListWorkflowStepGroupsOutput, error)
- func (c *Client) ListWorkflowSteps(ctx context.Context, params *ListWorkflowStepsInput, optFns ...func(*Options)) (*ListWorkflowStepsOutput, error)
- func (c *Client) ListWorkflows(ctx context.Context, params *ListWorkflowsInput, optFns ...func(*Options)) (*ListWorkflowsOutput, error)
- func (c *Client) Options() Options
- func (c *Client) RetryWorkflowStep(ctx context.Context, params *RetryWorkflowStepInput, optFns ...func(*Options)) (*RetryWorkflowStepOutput, error)
- func (c *Client) StartWorkflow(ctx context.Context, params *StartWorkflowInput, optFns ...func(*Options)) (*StartWorkflowOutput, error)
- func (c *Client) StopWorkflow(ctx context.Context, params *StopWorkflowInput, optFns ...func(*Options)) (*StopWorkflowOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error)
- func (c *Client) UpdateWorkflow(ctx context.Context, params *UpdateWorkflowInput, optFns ...func(*Options)) (*UpdateWorkflowOutput, error)
- func (c *Client) UpdateWorkflowStep(ctx context.Context, params *UpdateWorkflowStepInput, optFns ...func(*Options)) (*UpdateWorkflowStepOutput, error)
- func (c *Client) UpdateWorkflowStepGroup(ctx context.Context, params *UpdateWorkflowStepGroupInput, ...) (*UpdateWorkflowStepGroupOutput, error)
- type CreateTemplateInput
- type CreateTemplateOutput
- type CreateWorkflowInput
- type CreateWorkflowOutput
- type CreateWorkflowStepGroupInput
- type CreateWorkflowStepGroupOutput
- type CreateWorkflowStepInput
- type CreateWorkflowStepOutput
- type DeleteTemplateInput
- type DeleteTemplateOutput
- type DeleteWorkflowInput
- type DeleteWorkflowOutput
- type DeleteWorkflowStepGroupInput
- type DeleteWorkflowStepGroupOutput
- type DeleteWorkflowStepInput
- type DeleteWorkflowStepOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetTemplateInput
- type GetTemplateOutput
- type GetTemplateStepGroupInput
- type GetTemplateStepGroupOutput
- type GetTemplateStepInput
- type GetTemplateStepOutput
- type GetWorkflowInput
- type GetWorkflowOutput
- type GetWorkflowStepGroupInput
- type GetWorkflowStepGroupOutput
- type GetWorkflowStepInput
- type GetWorkflowStepOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListPluginsAPIClient
- type ListPluginsInput
- type ListPluginsOutput
- type ListPluginsPaginator
- type ListPluginsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTemplateStepGroupsAPIClient
- type ListTemplateStepGroupsInput
- type ListTemplateStepGroupsOutput
- type ListTemplateStepGroupsPaginator
- type ListTemplateStepGroupsPaginatorOptions
- type ListTemplateStepsAPIClient
- type ListTemplateStepsInput
- type ListTemplateStepsOutput
- type ListTemplateStepsPaginator
- type ListTemplateStepsPaginatorOptions
- type ListTemplatesAPIClient
- type ListTemplatesInput
- type ListTemplatesOutput
- type ListTemplatesPaginator
- type ListTemplatesPaginatorOptions
- type ListWorkflowStepGroupsAPIClient
- type ListWorkflowStepGroupsInput
- type ListWorkflowStepGroupsOutput
- type ListWorkflowStepGroupsPaginator
- type ListWorkflowStepGroupsPaginatorOptions
- type ListWorkflowStepsAPIClient
- type ListWorkflowStepsInput
- type ListWorkflowStepsOutput
- type ListWorkflowStepsPaginator
- type ListWorkflowStepsPaginatorOptions
- type ListWorkflowsAPIClient
- type ListWorkflowsInput
- type ListWorkflowsOutput
- type ListWorkflowsPaginator
- type ListWorkflowsPaginatorOptions
- type Options
- type ResolveEndpoint
- type RetryWorkflowStepInput
- type RetryWorkflowStepOutput
- type StartWorkflowInput
- type StartWorkflowOutput
- type StopWorkflowInput
- type StopWorkflowOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateTemplateInput
- type UpdateTemplateOutput
- type UpdateWorkflowInput
- type UpdateWorkflowOutput
- type UpdateWorkflowStepGroupInput
- type UpdateWorkflowStepGroupOutput
- type UpdateWorkflowStepInput
- type UpdateWorkflowStepOutput
Constants ¶
const ServiceAPIVersion = "2021-08-28"
const ServiceID = "MigrationHubOrchestrator"
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
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.2.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.5.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.5.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 AuthResolverParameters ¶ added in v1.5.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.5.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 Orchestrator.
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) CreateTemplate ¶ added in v1.9.0
func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error)
Creates a migration workflow template.
func (*Client) CreateWorkflow ¶
func (c *Client) CreateWorkflow(ctx context.Context, params *CreateWorkflowInput, optFns ...func(*Options)) (*CreateWorkflowOutput, error)
Create a workflow to orchestrate your migrations.
func (*Client) CreateWorkflowStep ¶
func (c *Client) CreateWorkflowStep(ctx context.Context, params *CreateWorkflowStepInput, optFns ...func(*Options)) (*CreateWorkflowStepOutput, error)
Create a step in the migration workflow.
func (*Client) CreateWorkflowStepGroup ¶
func (c *Client) CreateWorkflowStepGroup(ctx context.Context, params *CreateWorkflowStepGroupInput, optFns ...func(*Options)) (*CreateWorkflowStepGroupOutput, error)
Create a step group in a migration workflow.
func (*Client) DeleteTemplate ¶ added in v1.9.0
func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput, optFns ...func(*Options)) (*DeleteTemplateOutput, error)
Deletes a migration workflow template.
func (*Client) DeleteWorkflow ¶
func (c *Client) DeleteWorkflow(ctx context.Context, params *DeleteWorkflowInput, optFns ...func(*Options)) (*DeleteWorkflowOutput, error)
Delete a migration workflow. You must pause a running workflow in Migration Hub Orchestrator console to delete it.
func (*Client) DeleteWorkflowStep ¶
func (c *Client) DeleteWorkflowStep(ctx context.Context, params *DeleteWorkflowStepInput, optFns ...func(*Options)) (*DeleteWorkflowStepOutput, error)
Delete a step in a migration workflow. Pause the workflow to delete a running step.
func (*Client) DeleteWorkflowStepGroup ¶
func (c *Client) DeleteWorkflowStepGroup(ctx context.Context, params *DeleteWorkflowStepGroupInput, optFns ...func(*Options)) (*DeleteWorkflowStepGroupOutput, error)
Delete a step group in a migration workflow.
func (*Client) GetTemplate ¶
func (c *Client) GetTemplate(ctx context.Context, params *GetTemplateInput, optFns ...func(*Options)) (*GetTemplateOutput, error)
Get the template you want to use for creating a migration workflow.
func (*Client) GetTemplateStep ¶
func (c *Client) GetTemplateStep(ctx context.Context, params *GetTemplateStepInput, optFns ...func(*Options)) (*GetTemplateStepOutput, error)
Get a specific step in a template.
func (*Client) GetTemplateStepGroup ¶
func (c *Client) GetTemplateStepGroup(ctx context.Context, params *GetTemplateStepGroupInput, optFns ...func(*Options)) (*GetTemplateStepGroupOutput, error)
Get a step group in a template.
func (*Client) GetWorkflow ¶
func (c *Client) GetWorkflow(ctx context.Context, params *GetWorkflowInput, optFns ...func(*Options)) (*GetWorkflowOutput, error)
Get migration workflow.
func (*Client) GetWorkflowStep ¶
func (c *Client) GetWorkflowStep(ctx context.Context, params *GetWorkflowStepInput, optFns ...func(*Options)) (*GetWorkflowStepOutput, error)
Get a step in the migration workflow.
func (*Client) GetWorkflowStepGroup ¶
func (c *Client) GetWorkflowStepGroup(ctx context.Context, params *GetWorkflowStepGroupInput, optFns ...func(*Options)) (*GetWorkflowStepGroupOutput, error)
Get the step group of a migration workflow.
func (*Client) ListPlugins ¶
func (c *Client) ListPlugins(ctx context.Context, params *ListPluginsInput, optFns ...func(*Options)) (*ListPluginsOutput, error)
List AWS Migration Hub Orchestrator plugins.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
List the tags added to a resource.
func (*Client) ListTemplateStepGroups ¶
func (c *Client) ListTemplateStepGroups(ctx context.Context, params *ListTemplateStepGroupsInput, optFns ...func(*Options)) (*ListTemplateStepGroupsOutput, error)
List the step groups in a template.
func (*Client) ListTemplateSteps ¶
func (c *Client) ListTemplateSteps(ctx context.Context, params *ListTemplateStepsInput, optFns ...func(*Options)) (*ListTemplateStepsOutput, error)
List the steps in a template.
func (*Client) ListTemplates ¶
func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, optFns ...func(*Options)) (*ListTemplatesOutput, error)
List the templates available in Migration Hub Orchestrator to create a migration workflow.
func (*Client) ListWorkflowStepGroups ¶
func (c *Client) ListWorkflowStepGroups(ctx context.Context, params *ListWorkflowStepGroupsInput, optFns ...func(*Options)) (*ListWorkflowStepGroupsOutput, error)
List the step groups in a migration workflow.
func (*Client) ListWorkflowSteps ¶
func (c *Client) ListWorkflowSteps(ctx context.Context, params *ListWorkflowStepsInput, optFns ...func(*Options)) (*ListWorkflowStepsOutput, error)
List the steps in a workflow.
func (*Client) ListWorkflows ¶
func (c *Client) ListWorkflows(ctx context.Context, params *ListWorkflowsInput, optFns ...func(*Options)) (*ListWorkflowsOutput, error)
List the migration workflows.
func (*Client) Options ¶ added in v1.6.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) RetryWorkflowStep ¶
func (c *Client) RetryWorkflowStep(ctx context.Context, params *RetryWorkflowStepInput, optFns ...func(*Options)) (*RetryWorkflowStepOutput, error)
Retry a failed step in a migration workflow.
func (*Client) StartWorkflow ¶
func (c *Client) StartWorkflow(ctx context.Context, params *StartWorkflowInput, optFns ...func(*Options)) (*StartWorkflowOutput, error)
Start a migration workflow.
func (*Client) StopWorkflow ¶
func (c *Client) StopWorkflow(ctx context.Context, params *StopWorkflowInput, optFns ...func(*Options)) (*StopWorkflowOutput, error)
Stop an ongoing migration workflow.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Tag a resource by specifying its Amazon Resource Name (ARN).
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Deletes the tags for a resource.
func (*Client) UpdateTemplate ¶ added in v1.9.0
func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error)
Updates a migration workflow template.
func (*Client) UpdateWorkflow ¶
func (c *Client) UpdateWorkflow(ctx context.Context, params *UpdateWorkflowInput, optFns ...func(*Options)) (*UpdateWorkflowOutput, error)
Update a migration workflow.
func (*Client) UpdateWorkflowStep ¶
func (c *Client) UpdateWorkflowStep(ctx context.Context, params *UpdateWorkflowStepInput, optFns ...func(*Options)) (*UpdateWorkflowStepOutput, error)
Update a step in a migration workflow.
func (*Client) UpdateWorkflowStepGroup ¶
func (c *Client) UpdateWorkflowStepGroup(ctx context.Context, params *UpdateWorkflowStepGroupInput, optFns ...func(*Options)) (*UpdateWorkflowStepGroupOutput, error)
Update the step group in a migration workflow.
type CreateTemplateInput ¶ added in v1.9.0
type CreateTemplateInput struct { // The name of the migration workflow template. // // This member is required. TemplateName *string // The source of the migration workflow template. // // This member is required. TemplateSource types.TemplateSource // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. For more information, see [Idempotency]in the Smithy documentation. // // [Idempotency]: https://smithy.io/2.0/spec/behavior-traits.html#idempotencytoken-trait ClientToken *string // The tags to add to the migration workflow template. Tags map[string]string // A description of the migration workflow template. TemplateDescription *string // contains filtered or unexported fields }
type CreateTemplateOutput ¶ added in v1.9.0
type CreateTemplateOutput struct { // The tags added to the migration workflow template. Tags map[string]string // The Amazon Resource Name (ARN) of the migration workflow template. The format // for an Migration Hub Orchestrator template ARN is // arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234 . // For more information about ARNs, see [Amazon Resource Names (ARNs)]in the AWS General Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html TemplateArn *string // The ID of the migration workflow template. TemplateId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateWorkflowInput ¶
type CreateWorkflowInput struct { // The input parameters required to create a migration workflow. // // This member is required. InputParameters map[string]types.StepInput // The name of the migration workflow. // // This member is required. Name *string // The ID of the template. // // This member is required. TemplateId *string // The configuration ID of the application configured in Application Discovery // Service. ApplicationConfigurationId *string // The description of the migration workflow. Description *string // The servers on which a step will be run. StepTargets []string // The tags to add on a migration workflow. Tags map[string]string // contains filtered or unexported fields }
type CreateWorkflowOutput ¶
type CreateWorkflowOutput struct { // The configuration ID of the application configured in Application Discovery // Service. AdsApplicationConfigurationId *string // The Amazon Resource Name (ARN) of the migration workflow. Arn *string // The time at which the migration workflow was created. CreationTime *time.Time // The description of the migration workflow. Description *string // The ID of the migration workflow. Id *string // The name of the migration workflow. Name *string // The status of the migration workflow. Status types.MigrationWorkflowStatusEnum // The servers on which a step will be run. StepTargets []string // The tags to add on a migration workflow. Tags map[string]string // The ID of the template. TemplateId *string // The inputs for creating a migration workflow. WorkflowInputs map[string]types.StepInput // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateWorkflowStepGroupInput ¶
type CreateWorkflowStepGroupInput struct { // The name of the step group. // // This member is required. Name *string // The ID of the migration workflow that will contain the step group. // // This member is required. WorkflowId *string // The description of the step group. Description *string // The next step group. Next []string // The previous step group. Previous []string // contains filtered or unexported fields }
type CreateWorkflowStepGroupOutput ¶
type CreateWorkflowStepGroupOutput struct { // The time at which the step group is created. CreationTime *time.Time // The description of the step group. Description *string // The ID of the step group. Id *string // The name of the step group. Name *string // The next step group. Next []string // The previous step group. Previous []string // List of AWS services utilized in a migration workflow. Tools []types.Tool // The ID of the migration workflow that contains the step group. WorkflowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateWorkflowStepInput ¶
type CreateWorkflowStepInput struct { // The name of the step. // // This member is required. Name *string // The action type of the step. You must run and update the status of a manual // step for the workflow to continue after the completion of the step. // // This member is required. StepActionType types.StepActionType // The ID of the step group. // // This member is required. StepGroupId *string // The ID of the migration workflow. // // This member is required. WorkflowId *string // The description of the step. Description *string // The next step. Next []string // The key value pairs added for the expected output. Outputs []types.WorkflowStepOutput // The previous step. Previous []string // The servers on which a step will be run. StepTarget []string // The custom script to run tests on source or target environments. WorkflowStepAutomationConfiguration *types.WorkflowStepAutomationConfiguration // contains filtered or unexported fields }
type CreateWorkflowStepOutput ¶
type CreateWorkflowStepOutput struct { // The ID of the step. Id *string // The name of the step. Name *string // The ID of the step group. StepGroupId *string // The ID of the migration workflow. WorkflowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteTemplateInput ¶ added in v1.9.0
type DeleteTemplateInput struct { // The ID of the request to delete a migration workflow template. // // This member is required. Id *string // contains filtered or unexported fields }
type DeleteTemplateOutput ¶ added in v1.9.0
type DeleteTemplateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteWorkflowInput ¶
type DeleteWorkflowInput struct { // The ID of the migration workflow you want to delete. // // This member is required. Id *string // contains filtered or unexported fields }
type DeleteWorkflowOutput ¶
type DeleteWorkflowOutput struct { // The Amazon Resource Name (ARN) of the migration workflow. Arn *string // The ID of the migration workflow. Id *string // The status of the migration workflow. Status types.MigrationWorkflowStatusEnum // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteWorkflowStepGroupOutput ¶
type DeleteWorkflowStepGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteWorkflowStepInput ¶
type DeleteWorkflowStepInput struct { // The ID of the step you want to delete. // // This member is required. Id *string // The ID of the step group that contains the step you want to delete. // // This member is required. StepGroupId *string // The ID of the migration workflow. // // This member is required. WorkflowId *string // contains filtered or unexported fields }
type DeleteWorkflowStepOutput ¶
type DeleteWorkflowStepOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointParameters ¶ added in v1.2.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.2.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.2.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 ¶
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 EndpointResolverV2 ¶ added in v1.2.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.2.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetTemplateInput ¶
type GetTemplateInput struct { // The ID of the template. // // This member is required. Id *string // contains filtered or unexported fields }
type GetTemplateOutput ¶
type GetTemplateOutput struct { // The time at which the template was last created. CreationTime *time.Time // The time at which the template was last created. Description *string // The ID of the template. Id *string // The inputs provided for the creation of the migration workflow. Inputs []types.TemplateInput // The name of the template. Name *string // The owner of the migration workflow template. Owner *string // The status of the template. Status types.TemplateStatus // The status message of retrieving migration workflow templates. StatusMessage *string // The tags added to the migration workflow template. Tags map[string]string // >The Amazon Resource Name (ARN) of the migration workflow template. The format // for an Migration Hub Orchestrator template ARN is // arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234 . // For more information about ARNs, see [Amazon Resource Names (ARNs)]in the AWS General Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html TemplateArn *string // The class of the migration workflow template. The available template classes // are: // // - A2C // // - MGN // // - SAP_MULTI // // - SQL_EC2 // // - SQL_RDS // // - VMIE TemplateClass *string // List of AWS services utilized in a migration workflow. Tools []types.Tool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetTemplateStepGroupOutput ¶
type GetTemplateStepGroupOutput struct { // The time at which the step group was created. CreationTime *time.Time // The description of the step group. Description *string // The ID of the step group. Id *string // The time at which the step group was last modified. LastModifiedTime *time.Time // The name of the step group. Name *string // The next step group. Next []string // The previous step group. Previous []string // The status of the step group. Status types.StepGroupStatus // The ID of the template. TemplateId *string // List of AWS services utilized in a migration workflow. Tools []types.Tool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetTemplateStepInput ¶
type GetTemplateStepInput struct { // The ID of the step. // // This member is required. Id *string // The ID of the step group. // // This member is required. StepGroupId *string // The ID of the template. // // This member is required. TemplateId *string // contains filtered or unexported fields }
type GetTemplateStepOutput ¶
type GetTemplateStepOutput struct { // The time at which the step was created. CreationTime *string // The description of the step. Description *string // The ID of the step. Id *string // The name of the step. Name *string // The next step. Next []string // The outputs of the step. Outputs []types.StepOutput // The previous step. Previous []string // The action type of the step. You must run and update the status of a manual // step for the workflow to continue after the completion of the step. StepActionType types.StepActionType // The custom script to run tests on source or target environments. StepAutomationConfiguration *types.StepAutomationConfiguration // The ID of the step group. StepGroupId *string // The ID of the template. TemplateId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetWorkflowInput ¶
type GetWorkflowInput struct { // The ID of the migration workflow. // // This member is required. Id *string // contains filtered or unexported fields }
type GetWorkflowOutput ¶
type GetWorkflowOutput struct { // The configuration ID of the application configured in Application Discovery // Service. AdsApplicationConfigurationId *string // The name of the application configured in Application Discovery Service. AdsApplicationName *string // The Amazon Resource Name (ARN) of the migration workflow. Arn *string // Get a list of completed steps in the migration workflow. CompletedSteps *int32 // The time at which the migration workflow was created. CreationTime *time.Time // The description of the migration workflow. Description *string // The time at which the migration workflow ended. EndTime *time.Time // The ID of the migration workflow. Id *string // The time at which the migration workflow was last modified. LastModifiedTime *time.Time // The time at which the migration workflow was last started. LastStartTime *time.Time // The time at which the migration workflow was last stopped. LastStopTime *time.Time // The name of the migration workflow. Name *string // The status of the migration workflow. Status types.MigrationWorkflowStatusEnum // The status message of the migration workflow. StatusMessage *string // The tags added to the migration workflow. Tags map[string]string // The ID of the template. TemplateId *string // List of AWS services utilized in a migration workflow. Tools []types.Tool // The total number of steps in the migration workflow. TotalSteps *int32 // The Amazon S3 bucket where the migration logs are stored. WorkflowBucket *string // The inputs required for creating the migration workflow. WorkflowInputs map[string]types.StepInput // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetWorkflowStepGroupOutput ¶
type GetWorkflowStepGroupOutput struct { // The time at which the step group was created. CreationTime *time.Time // The description of the step group. Description *string // The time at which the step group ended. EndTime *time.Time // The ID of the step group. Id *string // The time at which the step group was last modified. LastModifiedTime *time.Time // The name of the step group. Name *string // The next step group. Next []string // The owner of the step group. Owner types.Owner // The previous step group. Previous []string // The status of the step group. Status types.StepGroupStatus // List of AWS services utilized in a migration workflow. Tools []types.Tool // The ID of the migration workflow. WorkflowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetWorkflowStepInput ¶
type GetWorkflowStepInput struct { // The ID of the step. // // This member is required. Id *string // The ID of the step group. // // This member is required. StepGroupId *string // The ID of the migration workflow. // // This member is required. WorkflowId *string // contains filtered or unexported fields }
type GetWorkflowStepOutput ¶
type GetWorkflowStepOutput struct { // The time at which the step was created. CreationTime *time.Time // The description of the step. Description *string // The time at which the step ended. EndTime *time.Time // The time at which the workflow was last started. LastStartTime *time.Time // The name of the step. Name *string // The next step. Next []string // The number of servers that have been migrated. NoOfSrvCompleted *int32 // The number of servers that have failed to migrate. NoOfSrvFailed *int32 // The outputs of the step. Outputs []types.WorkflowStepOutput // The owner of the step. Owner types.Owner // The previous step. Previous []string // The output location of the script. ScriptOutputLocation *string // The status of the step. Status types.StepStatus // The status message of the migration workflow. StatusMessage *string // The action type of the step. You must run and update the status of a manual // step for the workflow to continue after the completion of the step. StepActionType types.StepActionType // The ID of the step group. StepGroupId *string // The ID of the step. StepId *string // The servers on which a step will be run. StepTarget []string // The total number of servers that have been migrated. TotalNoOfSrv *int32 // The ID of the migration workflow. WorkflowId *string // The custom script to run tests on source or target environments. WorkflowStepAutomationConfiguration *types.WorkflowStepAutomationConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶ added in v1.9.0
IdempotencyTokenProvider interface for providing idempotency token
type ListPluginsAPIClient ¶
type ListPluginsAPIClient interface {
ListPlugins(context.Context, *ListPluginsInput, ...func(*Options)) (*ListPluginsOutput, error)
}
ListPluginsAPIClient is a client that implements the ListPlugins operation.
type ListPluginsInput ¶
type ListPluginsOutput ¶
type ListPluginsOutput struct { // The pagination token. NextToken *string // Migration Hub Orchestrator plugins. Plugins []types.PluginSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListPluginsPaginator ¶
type ListPluginsPaginator struct {
// contains filtered or unexported fields
}
ListPluginsPaginator is a paginator for ListPlugins
func NewListPluginsPaginator ¶
func NewListPluginsPaginator(client ListPluginsAPIClient, params *ListPluginsInput, optFns ...func(*ListPluginsPaginatorOptions)) *ListPluginsPaginator
NewListPluginsPaginator returns a new ListPluginsPaginator
func (*ListPluginsPaginator) HasMorePages ¶
func (p *ListPluginsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListPluginsPaginator) NextPage ¶
func (p *ListPluginsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPluginsOutput, error)
NextPage retrieves the next ListPlugins page.
type ListPluginsPaginatorOptions ¶
type ListPluginsPaginatorOptions struct { // The maximum number of plugins that can be returned. 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 }
ListPluginsPaginatorOptions is the paginator options for ListPlugins
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The tags added to a resource. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTemplateStepGroupsAPIClient ¶
type ListTemplateStepGroupsAPIClient interface {
ListTemplateStepGroups(context.Context, *ListTemplateStepGroupsInput, ...func(*Options)) (*ListTemplateStepGroupsOutput, error)
}
ListTemplateStepGroupsAPIClient is a client that implements the ListTemplateStepGroups operation.
type ListTemplateStepGroupsOutput ¶
type ListTemplateStepGroupsOutput struct { // The summary of the step group in the template. // // This member is required. TemplateStepGroupSummary []types.TemplateStepGroupSummary // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTemplateStepGroupsPaginator ¶
type ListTemplateStepGroupsPaginator struct {
// contains filtered or unexported fields
}
ListTemplateStepGroupsPaginator is a paginator for ListTemplateStepGroups
func NewListTemplateStepGroupsPaginator ¶
func NewListTemplateStepGroupsPaginator(client ListTemplateStepGroupsAPIClient, params *ListTemplateStepGroupsInput, optFns ...func(*ListTemplateStepGroupsPaginatorOptions)) *ListTemplateStepGroupsPaginator
NewListTemplateStepGroupsPaginator returns a new ListTemplateStepGroupsPaginator
func (*ListTemplateStepGroupsPaginator) HasMorePages ¶
func (p *ListTemplateStepGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTemplateStepGroupsPaginator) NextPage ¶
func (p *ListTemplateStepGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplateStepGroupsOutput, error)
NextPage retrieves the next ListTemplateStepGroups page.
type ListTemplateStepGroupsPaginatorOptions ¶
type ListTemplateStepGroupsPaginatorOptions struct { // The maximum number of results that can be returned. 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 }
ListTemplateStepGroupsPaginatorOptions is the paginator options for ListTemplateStepGroups
type ListTemplateStepsAPIClient ¶
type ListTemplateStepsAPIClient interface {
ListTemplateSteps(context.Context, *ListTemplateStepsInput, ...func(*Options)) (*ListTemplateStepsOutput, error)
}
ListTemplateStepsAPIClient is a client that implements the ListTemplateSteps operation.
type ListTemplateStepsInput ¶
type ListTemplateStepsInput struct { // The ID of the step group. // // This member is required. StepGroupId *string // The ID of the template. // // This member is required. TemplateId *string // The maximum number of results that can be returned. MaxResults int32 // The pagination token. NextToken *string // contains filtered or unexported fields }
type ListTemplateStepsOutput ¶
type ListTemplateStepsOutput struct { // The pagination token. NextToken *string // The list of summaries of steps in a template. TemplateStepSummaryList []types.TemplateStepSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTemplateStepsPaginator ¶
type ListTemplateStepsPaginator struct {
// contains filtered or unexported fields
}
ListTemplateStepsPaginator is a paginator for ListTemplateSteps
func NewListTemplateStepsPaginator ¶
func NewListTemplateStepsPaginator(client ListTemplateStepsAPIClient, params *ListTemplateStepsInput, optFns ...func(*ListTemplateStepsPaginatorOptions)) *ListTemplateStepsPaginator
NewListTemplateStepsPaginator returns a new ListTemplateStepsPaginator
func (*ListTemplateStepsPaginator) HasMorePages ¶
func (p *ListTemplateStepsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTemplateStepsPaginator) NextPage ¶
func (p *ListTemplateStepsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplateStepsOutput, error)
NextPage retrieves the next ListTemplateSteps page.
type ListTemplateStepsPaginatorOptions ¶
type ListTemplateStepsPaginatorOptions struct { // The maximum number of results that can be returned. 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 }
ListTemplateStepsPaginatorOptions is the paginator options for ListTemplateSteps
type ListTemplatesAPIClient ¶
type ListTemplatesAPIClient interface {
ListTemplates(context.Context, *ListTemplatesInput, ...func(*Options)) (*ListTemplatesOutput, error)
}
ListTemplatesAPIClient is a client that implements the ListTemplates operation.
type ListTemplatesInput ¶
type ListTemplatesOutput ¶
type ListTemplatesOutput struct { // The summary of the template. // // This member is required. TemplateSummary []types.TemplateSummary // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTemplatesPaginator ¶
type ListTemplatesPaginator struct {
// contains filtered or unexported fields
}
ListTemplatesPaginator is a paginator for ListTemplates
func NewListTemplatesPaginator ¶
func NewListTemplatesPaginator(client ListTemplatesAPIClient, params *ListTemplatesInput, optFns ...func(*ListTemplatesPaginatorOptions)) *ListTemplatesPaginator
NewListTemplatesPaginator returns a new ListTemplatesPaginator
func (*ListTemplatesPaginator) HasMorePages ¶
func (p *ListTemplatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTemplatesPaginator) NextPage ¶
func (p *ListTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplatesOutput, error)
NextPage retrieves the next ListTemplates page.
type ListTemplatesPaginatorOptions ¶
type ListTemplatesPaginatorOptions struct { // The maximum number of results that can be returned. 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 }
ListTemplatesPaginatorOptions is the paginator options for ListTemplates
type ListWorkflowStepGroupsAPIClient ¶
type ListWorkflowStepGroupsAPIClient interface {
ListWorkflowStepGroups(context.Context, *ListWorkflowStepGroupsInput, ...func(*Options)) (*ListWorkflowStepGroupsOutput, error)
}
ListWorkflowStepGroupsAPIClient is a client that implements the ListWorkflowStepGroups operation.
type ListWorkflowStepGroupsOutput ¶
type ListWorkflowStepGroupsOutput struct { // The summary of step groups in a migration workflow. // // This member is required. WorkflowStepGroupsSummary []types.WorkflowStepGroupSummary // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListWorkflowStepGroupsPaginator ¶
type ListWorkflowStepGroupsPaginator struct {
// contains filtered or unexported fields
}
ListWorkflowStepGroupsPaginator is a paginator for ListWorkflowStepGroups
func NewListWorkflowStepGroupsPaginator ¶
func NewListWorkflowStepGroupsPaginator(client ListWorkflowStepGroupsAPIClient, params *ListWorkflowStepGroupsInput, optFns ...func(*ListWorkflowStepGroupsPaginatorOptions)) *ListWorkflowStepGroupsPaginator
NewListWorkflowStepGroupsPaginator returns a new ListWorkflowStepGroupsPaginator
func (*ListWorkflowStepGroupsPaginator) HasMorePages ¶
func (p *ListWorkflowStepGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListWorkflowStepGroupsPaginator) NextPage ¶
func (p *ListWorkflowStepGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowStepGroupsOutput, error)
NextPage retrieves the next ListWorkflowStepGroups page.
type ListWorkflowStepGroupsPaginatorOptions ¶
type ListWorkflowStepGroupsPaginatorOptions struct { // The maximum number of results that can be returned. 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 }
ListWorkflowStepGroupsPaginatorOptions is the paginator options for ListWorkflowStepGroups
type ListWorkflowStepsAPIClient ¶
type ListWorkflowStepsAPIClient interface {
ListWorkflowSteps(context.Context, *ListWorkflowStepsInput, ...func(*Options)) (*ListWorkflowStepsOutput, error)
}
ListWorkflowStepsAPIClient is a client that implements the ListWorkflowSteps operation.
type ListWorkflowStepsInput ¶
type ListWorkflowStepsInput struct { // The ID of the step group. // // This member is required. StepGroupId *string // The ID of the migration workflow. // // This member is required. WorkflowId *string // The maximum number of results that can be returned. MaxResults int32 // The pagination token. NextToken *string // contains filtered or unexported fields }
type ListWorkflowStepsOutput ¶
type ListWorkflowStepsOutput struct { // The summary of steps in a migration workflow. // // This member is required. WorkflowStepsSummary []types.WorkflowStepSummary // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListWorkflowStepsPaginator ¶
type ListWorkflowStepsPaginator struct {
// contains filtered or unexported fields
}
ListWorkflowStepsPaginator is a paginator for ListWorkflowSteps
func NewListWorkflowStepsPaginator ¶
func NewListWorkflowStepsPaginator(client ListWorkflowStepsAPIClient, params *ListWorkflowStepsInput, optFns ...func(*ListWorkflowStepsPaginatorOptions)) *ListWorkflowStepsPaginator
NewListWorkflowStepsPaginator returns a new ListWorkflowStepsPaginator
func (*ListWorkflowStepsPaginator) HasMorePages ¶
func (p *ListWorkflowStepsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListWorkflowStepsPaginator) NextPage ¶
func (p *ListWorkflowStepsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowStepsOutput, error)
NextPage retrieves the next ListWorkflowSteps page.
type ListWorkflowStepsPaginatorOptions ¶
type ListWorkflowStepsPaginatorOptions struct { // The maximum number of results that can be returned. 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 }
ListWorkflowStepsPaginatorOptions is the paginator options for ListWorkflowSteps
type ListWorkflowsAPIClient ¶
type ListWorkflowsAPIClient interface {
ListWorkflows(context.Context, *ListWorkflowsInput, ...func(*Options)) (*ListWorkflowsOutput, error)
}
ListWorkflowsAPIClient is a client that implements the ListWorkflows operation.
type ListWorkflowsInput ¶
type ListWorkflowsInput struct { // The name of the application configured in Application Discovery Service. AdsApplicationConfigurationName *string // The maximum number of results that can be returned. MaxResults int32 // The name of the migration workflow. Name *string // The pagination token. NextToken *string // The status of the migration workflow. Status types.MigrationWorkflowStatusEnum // The ID of the template. TemplateId *string // contains filtered or unexported fields }
type ListWorkflowsOutput ¶
type ListWorkflowsOutput struct { // The summary of the migration workflow. // // This member is required. MigrationWorkflowSummary []types.MigrationWorkflowSummary // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListWorkflowsPaginator ¶
type ListWorkflowsPaginator struct {
// contains filtered or unexported fields
}
ListWorkflowsPaginator is a paginator for ListWorkflows
func NewListWorkflowsPaginator ¶
func NewListWorkflowsPaginator(client ListWorkflowsAPIClient, params *ListWorkflowsInput, optFns ...func(*ListWorkflowsPaginatorOptions)) *ListWorkflowsPaginator
NewListWorkflowsPaginator returns a new ListWorkflowsPaginator
func (*ListWorkflowsPaginator) HasMorePages ¶
func (p *ListWorkflowsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListWorkflowsPaginator) NextPage ¶
func (p *ListWorkflowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkflowsOutput, error)
NextPage retrieves the next ListWorkflows page.
type ListWorkflowsPaginatorOptions ¶
type ListWorkflowsPaginatorOptions struct { // The maximum number of results that can be returned. 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 }
ListWorkflowsPaginatorOptions is the paginator options for ListWorkflows
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 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // 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.5.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
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
type RetryWorkflowStepInput ¶
type RetryWorkflowStepInput struct { // The ID of the step. // // This member is required. Id *string // The ID of the step group. // // This member is required. StepGroupId *string // The ID of the migration workflow. // // This member is required. WorkflowId *string // contains filtered or unexported fields }
type RetryWorkflowStepOutput ¶
type RetryWorkflowStepOutput struct { // The ID of the step. Id *string // The status of the step. Status types.StepStatus // The ID of the step group. StepGroupId *string // The ID of the migration workflow. WorkflowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartWorkflowInput ¶
type StartWorkflowInput struct { // The ID of the migration workflow. // // This member is required. Id *string // contains filtered or unexported fields }
type StartWorkflowOutput ¶
type StartWorkflowOutput struct { // The Amazon Resource Name (ARN) of the migration workflow. Arn *string // The ID of the migration workflow. Id *string // The time at which the migration workflow was last started. LastStartTime *time.Time // The status of the migration workflow. Status types.MigrationWorkflowStatusEnum // The status message of the migration workflow. StatusMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopWorkflowInput ¶
type StopWorkflowInput struct { // The ID of the migration workflow. // // This member is required. Id *string // contains filtered or unexported fields }
type StopWorkflowOutput ¶
type StopWorkflowOutput struct { // The Amazon Resource Name (ARN) of the migration workflow. Arn *string // The ID of the migration workflow. Id *string // The time at which the migration workflow was stopped. LastStopTime *time.Time // The status of the migration workflow. Status types.MigrationWorkflowStatusEnum // The status message of the migration workflow. StatusMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource to which you want to add tags. // // This member is required. ResourceArn *string // A collection of labels, in the form of key:value pairs, that apply to this // resource. // // This member is required. Tags map[string]string // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource from which you want to remove // tags. // // This member is required. ResourceArn *string // One or more tag keys. Specify only the tag keys, not the tag values. // // This member is required. TagKeys []string // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateTemplateInput ¶ added in v1.9.0
type UpdateTemplateInput struct { // The ID of the request to update a migration workflow template. // // This member is required. Id *string // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientToken *string // The description of the migration workflow template to update. TemplateDescription *string // The name of the migration workflow template to update. TemplateName *string // contains filtered or unexported fields }
type UpdateTemplateOutput ¶ added in v1.9.0
type UpdateTemplateOutput struct { // The tags added to the migration workflow template. Tags map[string]string // The ARN of the migration workflow template being updated. The format for an // Migration Hub Orchestrator template ARN is // arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234 . // For more information about ARNs, see [Amazon Resource Names (ARNs)]in the AWS General Reference. // // [Amazon Resource Names (ARNs)]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html TemplateArn *string // The ID of the migration workflow template being updated. TemplateId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateWorkflowInput ¶
type UpdateWorkflowInput struct { // The ID of the migration workflow. // // This member is required. Id *string // The description of the migration workflow. Description *string // The input parameters required to update a migration workflow. InputParameters map[string]types.StepInput // The name of the migration workflow. Name *string // The servers on which a step will be run. StepTargets []string // contains filtered or unexported fields }
type UpdateWorkflowOutput ¶
type UpdateWorkflowOutput struct { // The ID of the application configured in Application Discovery Service. AdsApplicationConfigurationId *string // The Amazon Resource Name (ARN) of the migration workflow. Arn *string // The time at which the migration workflow was created. CreationTime *time.Time // The description of the migration workflow. Description *string // The ID of the migration workflow. Id *string // The time at which the migration workflow was last modified. LastModifiedTime *time.Time // The name of the migration workflow. Name *string // The status of the migration workflow. Status types.MigrationWorkflowStatusEnum // The servers on which a step will be run. StepTargets []string // The tags added to the migration workflow. Tags map[string]string // The ID of the template. TemplateId *string // The inputs required to update a migration workflow. WorkflowInputs map[string]types.StepInput // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateWorkflowStepGroupInput ¶
type UpdateWorkflowStepGroupInput struct { // The ID of the step group. // // This member is required. Id *string // The ID of the migration workflow. // // This member is required. WorkflowId *string // The description of the step group. Description *string // The name of the step group. Name *string // The next step group. Next []string // The previous step group. Previous []string // contains filtered or unexported fields }
type UpdateWorkflowStepGroupOutput ¶
type UpdateWorkflowStepGroupOutput struct { // The description of the step group. Description *string // The ID of the step group. Id *string // The time at which the step group was last modified. LastModifiedTime *time.Time // The name of the step group. Name *string // The next step group. Next []string // The previous step group. Previous []string // List of AWS services utilized in a migration workflow. Tools []types.Tool // The ID of the migration workflow. WorkflowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateWorkflowStepInput ¶
type UpdateWorkflowStepInput struct { // The ID of the step. // // This member is required. Id *string // The ID of the step group. // // This member is required. StepGroupId *string // The ID of the migration workflow. // // This member is required. WorkflowId *string // The description of the step. Description *string // The name of the step. Name *string // The next step. Next []string // The outputs of a step. Outputs []types.WorkflowStepOutput // The previous step. Previous []string // The status of the step. Status types.StepStatus // The action type of the step. You must run and update the status of a manual // step for the workflow to continue after the completion of the step. StepActionType types.StepActionType // The servers on which a step will be run. StepTarget []string // The custom script to run tests on the source and target environments. WorkflowStepAutomationConfiguration *types.WorkflowStepAutomationConfiguration // contains filtered or unexported fields }
type UpdateWorkflowStepOutput ¶
type UpdateWorkflowStepOutput struct { // The ID of the step. Id *string // The name of the step. Name *string // The ID of the step group. StepGroupId *string // The ID of the migration workflow. WorkflowId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_CreateTemplate.go
- api_op_CreateWorkflow.go
- api_op_CreateWorkflowStep.go
- api_op_CreateWorkflowStepGroup.go
- api_op_DeleteTemplate.go
- api_op_DeleteWorkflow.go
- api_op_DeleteWorkflowStep.go
- api_op_DeleteWorkflowStepGroup.go
- api_op_GetTemplate.go
- api_op_GetTemplateStep.go
- api_op_GetTemplateStepGroup.go
- api_op_GetWorkflow.go
- api_op_GetWorkflowStep.go
- api_op_GetWorkflowStepGroup.go
- api_op_ListPlugins.go
- api_op_ListTagsForResource.go
- api_op_ListTemplateStepGroups.go
- api_op_ListTemplateSteps.go
- api_op_ListTemplates.go
- api_op_ListWorkflowStepGroups.go
- api_op_ListWorkflowSteps.go
- api_op_ListWorkflows.go
- api_op_RetryWorkflowStep.go
- api_op_StartWorkflow.go
- api_op_StopWorkflow.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateTemplate.go
- api_op_UpdateWorkflow.go
- api_op_UpdateWorkflowStep.go
- api_op_UpdateWorkflowStepGroup.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go