@aws-sdk/client-migrationhuborchestrator 3.295.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { MigrationHubOrchestratorServiceException as __BaseException } from "./MigrationHubOrchestratorServiceException";
 /**
+ * @public
  * <p>You do not have sufficient access to perform this action.</p>
  */
 export declare class AccessDeniedException extends __BaseException {
@@ -12,12 +13,18 @@ export declare class AccessDeniedException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource.</p>
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The tags added to a resource.</p>
@@ -25,6 +32,7 @@ export interface ListTagsForResourceResponse {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>The resource is not available.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -36,6 +44,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -48,10 +57,14 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p>A map of key value pairs that is generated when you create a migration workflow. The
  *             key value pairs will differ based on your selection of the template.</p>
  */
 export type StepInput = StepInput.IntegerValueMember | StepInput.ListOfStringsValueMember | StepInput.MapOfStringValueMember | StepInput.StringValueMember | StepInput.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace StepInput {
     /**
      * <p>The value of the integer.</p>
@@ -109,6 +122,9 @@ export declare namespace StepInput {
     }
     const visit: <T>(value: StepInput, visitor: Visitor<T>) => T;
 }
+/**
+ * @public
+ */
 export interface CreateMigrationWorkflowRequest {
     /**
      * <p>The name of the migration workflow.</p>
@@ -139,6 +155,9 @@ export interface CreateMigrationWorkflowRequest {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export declare enum MigrationWorkflowStatusEnum {
     COMPLETED = "COMPLETED",
     CREATING = "CREATING",
@@ -155,6 +174,9 @@ export declare enum MigrationWorkflowStatusEnum {
     USER_ATTENTION_REQUIRED = "USER_ATTENTION_REQUIRED",
     WORKFLOW_FAILED = "WORKFLOW_FAILED"
 }
+/**
+ * @public
+ */
 export interface CreateMigrationWorkflowResponse {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -202,6 +224,7 @@ export interface CreateMigrationWorkflowResponse {
     tags?: Record<string, string>;
 }
 /**
+ * @public
  * <p>An internal error has occurred.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -213,6 +236,7 @@ export declare class InternalServerException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied due to request throttling.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -223,12 +247,18 @@ export declare class ThrottlingException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteMigrationWorkflowRequest {
     /**
      * <p>The ID of the migration workflow you want to delete.</p>
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteMigrationWorkflowResponse {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -243,6 +273,9 @@ export interface DeleteMigrationWorkflowResponse {
      */
     status?: MigrationWorkflowStatusEnum | string;
 }
+/**
+ * @public
+ */
 export interface GetMigrationWorkflowRequest {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -250,6 +283,7 @@ export interface GetMigrationWorkflowRequest {
     id: string | undefined;
 }
 /**
+ * @public
  * <p>List of AWS services utilized in a migration workflow.</p>
  */
 export interface Tool {
@@ -262,6 +296,9 @@ export interface Tool {
      */
     url?: string;
 }
+/**
+ * @public
+ */
 export interface GetMigrationWorkflowResponse {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -344,6 +381,9 @@ export interface GetMigrationWorkflowResponse {
      */
     workflowBucket?: string;
 }
+/**
+ * @public
+ */
 export interface ListMigrationWorkflowsRequest {
     /**
      * <p>The maximum number of results that can be returned.</p>
@@ -371,6 +411,7 @@ export interface ListMigrationWorkflowsRequest {
     name?: string;
 }
 /**
+ * @public
  * <p>The summary of a migration workflow.</p>
  */
 export interface MigrationWorkflowSummary {
@@ -415,6 +456,9 @@ export interface MigrationWorkflowSummary {
      */
     totalSteps?: number;
 }
+/**
+ * @public
+ */
 export interface ListMigrationWorkflowsResponse {
     /**
      * <p>The pagination token.</p>
@@ -425,12 +469,18 @@ export interface ListMigrationWorkflowsResponse {
      */
     migrationWorkflowSummary: MigrationWorkflowSummary[] | undefined;
 }
+/**
+ * @public
+ */
 export interface StartMigrationWorkflowRequest {
     /**
      * <p>The ID of the migration workflow.</p>
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StartMigrationWorkflowResponse {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -453,12 +503,18 @@ export interface StartMigrationWorkflowResponse {
      */
     lastStartTime?: Date;
 }
+/**
+ * @public
+ */
 export interface StopMigrationWorkflowRequest {
     /**
      * <p>The ID of the migration workflow.</p>
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopMigrationWorkflowResponse {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -481,6 +537,9 @@ export interface StopMigrationWorkflowResponse {
      */
     lastStopTime?: Date;
 }
+/**
+ * @public
+ */
 export interface UpdateMigrationWorkflowRequest {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -503,6 +562,9 @@ export interface UpdateMigrationWorkflowRequest {
      */
     stepTargets?: string[];
 }
+/**
+ * @public
+ */
 export interface UpdateMigrationWorkflowResponse {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -553,12 +615,18 @@ export interface UpdateMigrationWorkflowResponse {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
 export interface GetMigrationWorkflowTemplateRequest {
     /**
      * <p>The ID of the template.</p>
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum DataType {
     INTEGER = "INTEGER",
     STRING = "STRING",
@@ -566,6 +634,7 @@ export declare enum DataType {
     STRINGMAP = "STRINGMAP"
 }
 /**
+ * @public
  * <p>The input parameters of a template.</p>
  */
 export interface TemplateInput {
@@ -582,9 +651,15 @@ export interface TemplateInput {
      */
     required?: boolean;
 }
+/**
+ * @public
+ */
 export declare enum TemplateStatus {
     CREATED = "CREATED"
 }
+/**
+ * @public
+ */
 export interface GetMigrationWorkflowTemplateResponse {
     /**
      * <p>The ID of the template.</p>
@@ -615,6 +690,9 @@ export interface GetMigrationWorkflowTemplateResponse {
      */
     creationTime?: Date;
 }
+/**
+ * @public
+ */
 export interface ListMigrationWorkflowTemplatesRequest {
     /**
      * <p>The maximum number of results that can be returned.</p>
@@ -630,6 +708,7 @@ export interface ListMigrationWorkflowTemplatesRequest {
     name?: string;
 }
 /**
+ * @public
  * <p>The summary of the template.</p>
  */
 export interface TemplateSummary {
@@ -650,6 +729,9 @@ export interface TemplateSummary {
      */
     description?: string;
 }
+/**
+ * @public
+ */
 export interface ListMigrationWorkflowTemplatesResponse {
     /**
      * <p>The pagination token.</p>
@@ -660,6 +742,9 @@ export interface ListMigrationWorkflowTemplatesResponse {
      */
     templateSummary: TemplateSummary[] | undefined;
 }
+/**
+ * @public
+ */
 export interface ListPluginsRequest {
     /**
      * <p>The maximum number of plugins that can be returned.</p>
@@ -670,11 +755,15 @@ export interface ListPluginsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum PluginHealth {
     PLUGIN_HEALTHY = "HEALTHY",
     PLUGIN_UNHEALTHY = "UNHEALTHY"
 }
 /**
+ * @public
  * <p>The summary of the Migration Hub Orchestrator plugin.</p>
  */
 export interface PluginSummary {
@@ -703,6 +792,9 @@ export interface PluginSummary {
      */
     registeredTime?: string;
 }
+/**
+ * @public
+ */
 export interface ListPluginsResponse {
     /**
      * <p>The pagination token.</p>
@@ -713,6 +805,9 @@ export interface ListPluginsResponse {
      */
     plugins?: PluginSummary[];
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource to which you want to add tags.</p>
@@ -724,8 +819,14 @@ export interface TagResourceRequest {
      */
     tags: Record<string, string> | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface GetTemplateStepRequest {
     /**
      * <p>The ID of the step.</p>
@@ -741,6 +842,7 @@ export interface GetTemplateStepRequest {
     stepGroupId: string | undefined;
 }
 /**
+ * @public
  * <p>The output of the step.</p>
  */
 export interface StepOutput {
@@ -757,11 +859,15 @@ export interface StepOutput {
      */
     required?: boolean;
 }
+/**
+ * @public
+ */
 export declare enum StepActionType {
     AUTOMATED = "AUTOMATED",
     MANUAL = "MANUAL"
 }
 /**
+ * @public
  * <p>Command to be run on a particular operating system.</p>
  */
 export interface PlatformCommand {
@@ -774,11 +880,15 @@ export interface PlatformCommand {
      */
     windows?: string;
 }
+/**
+ * @public
+ */
 export declare enum RunEnvironment {
     AWS = "AWS",
     ONPREMISE = "ONPREMISE"
 }
 /**
+ * @public
  * <p>The script location for a particular operating system.</p>
  */
 export interface PlatformScriptKey {
@@ -791,12 +901,16 @@ export interface PlatformScriptKey {
      */
     windows?: string;
 }
+/**
+ * @public
+ */
 export declare enum TargetType {
     ALL = "ALL",
     NONE = "NONE",
     SINGLE = "SINGLE"
 }
 /**
+ * @public
  * <p>The custom script to run tests on source or target environments.</p>
  */
 export interface StepAutomationConfiguration {
@@ -821,6 +935,9 @@ export interface StepAutomationConfiguration {
      */
     targetType?: TargetType | string;
 }
+/**
+ * @public
+ */
 export interface GetTemplateStepResponse {
     /**
      * <p>The ID of the step.</p>
@@ -868,6 +985,9 @@ export interface GetTemplateStepResponse {
      */
     stepAutomationConfiguration?: StepAutomationConfiguration;
 }
+/**
+ * @public
+ */
 export interface ListTemplateStepsRequest {
     /**
      * <p>The maximum number of results that can be returned.</p>
@@ -886,11 +1006,15 @@ export interface ListTemplateStepsRequest {
      */
     stepGroupId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum Owner {
     AWSManaged = "AWS_MANAGED",
     CUSTOM = "CUSTOM"
 }
 /**
+ * @public
  * <p>The summary of the step.</p>
  */
 export interface TemplateStepSummary {
@@ -932,6 +1056,9 @@ export interface TemplateStepSummary {
      */
     next?: string[];
 }
+/**
+ * @public
+ */
 export interface ListTemplateStepsResponse {
     /**
      * <p>The pagination token.</p>
@@ -942,6 +1069,9 @@ export interface ListTemplateStepsResponse {
      */
     templateStepSummaryList?: TemplateStepSummary[];
 }
+/**
+ * @public
+ */
 export interface GetTemplateStepGroupRequest {
     /**
      * <p>The ID of the template.</p>
@@ -952,6 +1082,9 @@ export interface GetTemplateStepGroupRequest {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum StepGroupStatus {
     AWAITING_DEPENDENCIES = "AWAITING_DEPENDENCIES",
     COMPLETED = "COMPLETED",
@@ -962,6 +1095,9 @@ export declare enum StepGroupStatus {
     READY = "READY",
     USER_ATTENTION_REQUIRED = "USER_ATTENTION_REQUIRED"
 }
+/**
+ * @public
+ */
 export interface GetTemplateStepGroupResponse {
     /**
      * <p>The ID of the template.</p>
@@ -1004,6 +1140,9 @@ export interface GetTemplateStepGroupResponse {
      */
     next?: string[];
 }
+/**
+ * @public
+ */
 export interface ListTemplateStepGroupsRequest {
     /**
      * <p>The maximum number of results that can be returned.</p>
@@ -1019,6 +1158,7 @@ export interface ListTemplateStepGroupsRequest {
     templateId: string | undefined;
 }
 /**
+ * @public
  * <p>The summary of the step group in the template.</p>
  */
 export interface TemplateStepGroupSummary {
@@ -1039,6 +1179,9 @@ export interface TemplateStepGroupSummary {
      */
     next?: string[];
 }
+/**
+ * @public
+ */
 export interface ListTemplateStepGroupsResponse {
     /**
      * <p>The pagination token.</p>
@@ -1049,6 +1192,9 @@ export interface ListTemplateStepGroupsResponse {
      */
     templateStepGroupSummary: TemplateStepGroupSummary[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the resource from which you want to remove
@@ -1060,12 +1206,19 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
 /**
+ * @public
  * <p>A structure to hold multiple values of an output.</p>
  */
 export type WorkflowStepOutputUnion = WorkflowStepOutputUnion.IntegerValueMember | WorkflowStepOutputUnion.ListOfStringValueMember | WorkflowStepOutputUnion.StringValueMember | WorkflowStepOutputUnion.$UnknownMember;
+/**
+ * @public
+ */
 export declare namespace WorkflowStepOutputUnion {
     /**
      * <p>The integer value. </p>
@@ -1109,6 +1262,7 @@ export declare namespace WorkflowStepOutputUnion {
     const visit: <T>(value: WorkflowStepOutputUnion, visitor: Visitor<T>) => T;
 }
 /**
+ * @public
  * <p>The output of a step.</p>
  */
 export interface WorkflowStepOutput {
@@ -1130,6 +1284,7 @@ export interface WorkflowStepOutput {
     value?: WorkflowStepOutputUnion;
 }
 /**
+ * @public
  * <p>The custom script to run tests on source or target environments.</p>
  */
 export interface WorkflowStepAutomationConfiguration {
@@ -1154,6 +1309,9 @@ export interface WorkflowStepAutomationConfiguration {
      */
     targetType?: TargetType | string;
 }
+/**
+ * @public
+ */
 export interface CreateWorkflowStepRequest {
     /**
      * <p>The name of the step.</p>
@@ -1197,6 +1355,9 @@ export interface CreateWorkflowStepRequest {
      */
     next?: string[];
 }
+/**
+ * @public
+ */
 export interface CreateWorkflowStepResponse {
     /**
      * <p>The ID of the step.</p>
@@ -1215,6 +1376,9 @@ export interface CreateWorkflowStepResponse {
      */
     name?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteWorkflowStepRequest {
     /**
      * <p>The ID of the step you want to delete.</p>
@@ -1229,8 +1393,14 @@ export interface DeleteWorkflowStepRequest {
      */
     workflowId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteWorkflowStepResponse {
 }
+/**
+ * @public
+ */
 export interface GetWorkflowStepRequest {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -1245,6 +1415,9 @@ export interface GetWorkflowStepRequest {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum StepStatus {
     AWAITING_DEPENDENCIES = "AWAITING_DEPENDENCIES",
     COMPLETED = "COMPLETED",
@@ -1254,6 +1427,9 @@ export declare enum StepStatus {
     READY = "READY",
     USER_ATTENTION_REQUIRED = "USER_ATTENTION_REQUIRED"
 }
+/**
+ * @public
+ */
 export interface GetWorkflowStepResponse {
     /**
      * <p>The name of the step.</p>
@@ -1341,6 +1517,9 @@ export interface GetWorkflowStepResponse {
      */
     totalNoOfSrv?: number;
 }
+/**
+ * @public
+ */
 export interface ListWorkflowStepsRequest {
     /**
      * <p>The pagination token.</p>
@@ -1360,6 +1539,7 @@ export interface ListWorkflowStepsRequest {
     stepGroupId: string | undefined;
 }
 /**
+ * @public
  * <p>The summary of the step in a migration workflow.</p>
  */
 export interface WorkflowStepSummary {
@@ -1417,6 +1597,9 @@ export interface WorkflowStepSummary {
      */
     scriptLocation?: string;
 }
+/**
+ * @public
+ */
 export interface ListWorkflowStepsResponse {
     /**
      * <p>The pagination token.</p>
@@ -1427,6 +1610,9 @@ export interface ListWorkflowStepsResponse {
      */
     workflowStepsSummary: WorkflowStepSummary[] | undefined;
 }
+/**
+ * @public
+ */
 export interface RetryWorkflowStepRequest {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -1441,6 +1627,9 @@ export interface RetryWorkflowStepRequest {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface RetryWorkflowStepResponse {
     /**
      * <p>The ID of the step group.</p>
@@ -1459,6 +1648,9 @@ export interface RetryWorkflowStepResponse {
      */
     status?: StepStatus | string;
 }
+/**
+ * @public
+ */
 export interface UpdateWorkflowStepRequest {
     /**
      * <p>The ID of the step.</p>
@@ -1510,6 +1702,9 @@ export interface UpdateWorkflowStepRequest {
      */
     status?: StepStatus | string;
 }
+/**
+ * @public
+ */
 export interface UpdateWorkflowStepResponse {
     /**
      * <p>The ID of the step.</p>
@@ -1528,6 +1723,9 @@ export interface UpdateWorkflowStepResponse {
      */
     name?: string;
 }
+/**
+ * @public
+ */
 export interface CreateWorkflowStepGroupRequest {
     /**
      * <p>The ID of the migration workflow that will contain the step group.</p>
@@ -1550,6 +1748,9 @@ export interface CreateWorkflowStepGroupRequest {
      */
     previous?: string[];
 }
+/**
+ * @public
+ */
 export interface CreateWorkflowStepGroupResponse {
     /**
      * <p>The ID of the migration workflow that contains the step group.</p>
@@ -1584,6 +1785,9 @@ export interface CreateWorkflowStepGroupResponse {
      */
     creationTime?: Date;
 }
+/**
+ * @public
+ */
 export interface DeleteWorkflowStepGroupRequest {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -1594,8 +1798,14 @@ export interface DeleteWorkflowStepGroupRequest {
      */
     id: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteWorkflowStepGroupResponse {
 }
+/**
+ * @public
+ */
 export interface GetWorkflowStepGroupRequest {
     /**
      * <p>The ID of the step group.</p>
@@ -1606,6 +1816,9 @@ export interface GetWorkflowStepGroupRequest {
      */
     workflowId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface GetWorkflowStepGroupResponse {
     /**
      * <p>The ID of the step group.</p>
@@ -1656,6 +1869,9 @@ export interface GetWorkflowStepGroupResponse {
      */
     next?: string[];
 }
+/**
+ * @public
+ */
 export interface ListWorkflowStepGroupsRequest {
     /**
      * <p>The pagination token.</p>
@@ -1671,6 +1887,7 @@ export interface ListWorkflowStepGroupsRequest {
     workflowId: string | undefined;
 }
 /**
+ * @public
  * <p>The summary of a step group in a workflow.</p>
  */
 export interface WorkflowStepGroupSummary {
@@ -1699,6 +1916,9 @@ export interface WorkflowStepGroupSummary {
      */
     next?: string[];
 }
+/**
+ * @public
+ */
 export interface ListWorkflowStepGroupsResponse {
     /**
      * <p>The pagination token.</p>
@@ -1709,6 +1929,9 @@ export interface ListWorkflowStepGroupsResponse {
      */
     workflowStepGroupsSummary: WorkflowStepGroupSummary[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateWorkflowStepGroupRequest {
     /**
      * <p>The ID of the migration workflow.</p>
@@ -1735,6 +1958,9 @@ export interface UpdateWorkflowStepGroupRequest {
      */
     previous?: string[];
 }
+/**
+ * @public
+ */
 export interface UpdateWorkflowStepGroupResponse {
     /**
      * <p>The ID of the migration workflow.</p>