UNPKG

36.6 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class MigrationHub extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: MigrationHub.Types.ClientConfiguration)
13 config: Config & MigrationHub.Types.ClientConfiguration;
14 /**
15 * 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.
16 */
17 associateCreatedArtifact(params: MigrationHub.Types.AssociateCreatedArtifactRequest, callback?: (err: AWSError, data: MigrationHub.Types.AssociateCreatedArtifactResult) => void): Request<MigrationHub.Types.AssociateCreatedArtifactResult, AWSError>;
18 /**
19 * 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.
20 */
21 associateCreatedArtifact(callback?: (err: AWSError, data: MigrationHub.Types.AssociateCreatedArtifactResult) => void): Request<MigrationHub.Types.AssociateCreatedArtifactResult, AWSError>;
22 /**
23 * Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
24 */
25 associateDiscoveredResource(params: MigrationHub.Types.AssociateDiscoveredResourceRequest, callback?: (err: AWSError, data: MigrationHub.Types.AssociateDiscoveredResourceResult) => void): Request<MigrationHub.Types.AssociateDiscoveredResourceResult, AWSError>;
26 /**
27 * Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.
28 */
29 associateDiscoveredResource(callback?: (err: AWSError, data: MigrationHub.Types.AssociateDiscoveredResourceResult) => void): Request<MigrationHub.Types.AssociateDiscoveredResourceResult, AWSError>;
30 /**
31 * 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.
32 */
33 createProgressUpdateStream(params: MigrationHub.Types.CreateProgressUpdateStreamRequest, callback?: (err: AWSError, data: MigrationHub.Types.CreateProgressUpdateStreamResult) => void): Request<MigrationHub.Types.CreateProgressUpdateStreamResult, AWSError>;
34 /**
35 * 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.
36 */
37 createProgressUpdateStream(callback?: (err: AWSError, data: MigrationHub.Types.CreateProgressUpdateStreamResult) => void): Request<MigrationHub.Types.CreateProgressUpdateStreamResult, AWSError>;
38 /**
39 * 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 realted 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).
40 */
41 deleteProgressUpdateStream(params: MigrationHub.Types.DeleteProgressUpdateStreamRequest, callback?: (err: AWSError, data: MigrationHub.Types.DeleteProgressUpdateStreamResult) => void): Request<MigrationHub.Types.DeleteProgressUpdateStreamResult, AWSError>;
42 /**
43 * 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 realted 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).
44 */
45 deleteProgressUpdateStream(callback?: (err: AWSError, data: MigrationHub.Types.DeleteProgressUpdateStreamResult) => void): Request<MigrationHub.Types.DeleteProgressUpdateStreamResult, AWSError>;
46 /**
47 * Gets the migration status of an application.
48 */
49 describeApplicationState(params: MigrationHub.Types.DescribeApplicationStateRequest, callback?: (err: AWSError, data: MigrationHub.Types.DescribeApplicationStateResult) => void): Request<MigrationHub.Types.DescribeApplicationStateResult, AWSError>;
50 /**
51 * Gets the migration status of an application.
52 */
53 describeApplicationState(callback?: (err: AWSError, data: MigrationHub.Types.DescribeApplicationStateResult) => void): Request<MigrationHub.Types.DescribeApplicationStateResult, AWSError>;
54 /**
55 * Retrieves a list of all attributes associated with a specific migration task.
56 */
57 describeMigrationTask(params: MigrationHub.Types.DescribeMigrationTaskRequest, callback?: (err: AWSError, data: MigrationHub.Types.DescribeMigrationTaskResult) => void): Request<MigrationHub.Types.DescribeMigrationTaskResult, AWSError>;
58 /**
59 * Retrieves a list of all attributes associated with a specific migration task.
60 */
61 describeMigrationTask(callback?: (err: AWSError, data: MigrationHub.Types.DescribeMigrationTaskResult) => void): Request<MigrationHub.Types.DescribeMigrationTaskResult, AWSError>;
62 /**
63 * 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.
64 */
65 disassociateCreatedArtifact(params: MigrationHub.Types.DisassociateCreatedArtifactRequest, callback?: (err: AWSError, data: MigrationHub.Types.DisassociateCreatedArtifactResult) => void): Request<MigrationHub.Types.DisassociateCreatedArtifactResult, AWSError>;
66 /**
67 * 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.
68 */
69 disassociateCreatedArtifact(callback?: (err: AWSError, data: MigrationHub.Types.DisassociateCreatedArtifactResult) => void): Request<MigrationHub.Types.DisassociateCreatedArtifactResult, AWSError>;
70 /**
71 * Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
72 */
73 disassociateDiscoveredResource(params: MigrationHub.Types.DisassociateDiscoveredResourceRequest, callback?: (err: AWSError, data: MigrationHub.Types.DisassociateDiscoveredResourceResult) => void): Request<MigrationHub.Types.DisassociateDiscoveredResourceResult, AWSError>;
74 /**
75 * Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.
76 */
77 disassociateDiscoveredResource(callback?: (err: AWSError, data: MigrationHub.Types.DisassociateDiscoveredResourceResult) => void): Request<MigrationHub.Types.DisassociateDiscoveredResourceResult, AWSError>;
78 /**
79 * 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.
80 */
81 importMigrationTask(params: MigrationHub.Types.ImportMigrationTaskRequest, callback?: (err: AWSError, data: MigrationHub.Types.ImportMigrationTaskResult) => void): Request<MigrationHub.Types.ImportMigrationTaskResult, AWSError>;
82 /**
83 * 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.
84 */
85 importMigrationTask(callback?: (err: AWSError, data: MigrationHub.Types.ImportMigrationTaskResult) => void): Request<MigrationHub.Types.ImportMigrationTaskResult, AWSError>;
86 /**
87 * 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.
88 */
89 listCreatedArtifacts(params: MigrationHub.Types.ListCreatedArtifactsRequest, callback?: (err: AWSError, data: MigrationHub.Types.ListCreatedArtifactsResult) => void): Request<MigrationHub.Types.ListCreatedArtifactsResult, AWSError>;
90 /**
91 * 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.
92 */
93 listCreatedArtifacts(callback?: (err: AWSError, data: MigrationHub.Types.ListCreatedArtifactsResult) => void): Request<MigrationHub.Types.ListCreatedArtifactsResult, AWSError>;
94 /**
95 * Lists discovered resources associated with the given MigrationTask.
96 */
97 listDiscoveredResources(params: MigrationHub.Types.ListDiscoveredResourcesRequest, callback?: (err: AWSError, data: MigrationHub.Types.ListDiscoveredResourcesResult) => void): Request<MigrationHub.Types.ListDiscoveredResourcesResult, AWSError>;
98 /**
99 * Lists discovered resources associated with the given MigrationTask.
100 */
101 listDiscoveredResources(callback?: (err: AWSError, data: MigrationHub.Types.ListDiscoveredResourcesResult) => void): Request<MigrationHub.Types.ListDiscoveredResourcesResult, AWSError>;
102 /**
103 * 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.
104 */
105 listMigrationTasks(params: MigrationHub.Types.ListMigrationTasksRequest, callback?: (err: AWSError, data: MigrationHub.Types.ListMigrationTasksResult) => void): Request<MigrationHub.Types.ListMigrationTasksResult, AWSError>;
106 /**
107 * 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.
108 */
109 listMigrationTasks(callback?: (err: AWSError, data: MigrationHub.Types.ListMigrationTasksResult) => void): Request<MigrationHub.Types.ListMigrationTasksResult, AWSError>;
110 /**
111 * Lists progress update streams associated with the user account making this call.
112 */
113 listProgressUpdateStreams(params: MigrationHub.Types.ListProgressUpdateStreamsRequest, callback?: (err: AWSError, data: MigrationHub.Types.ListProgressUpdateStreamsResult) => void): Request<MigrationHub.Types.ListProgressUpdateStreamsResult, AWSError>;
114 /**
115 * Lists progress update streams associated with the user account making this call.
116 */
117 listProgressUpdateStreams(callback?: (err: AWSError, data: MigrationHub.Types.ListProgressUpdateStreamsResult) => void): Request<MigrationHub.Types.ListProgressUpdateStreamsResult, AWSError>;
118 /**
119 * 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.
120 */
121 notifyApplicationState(params: MigrationHub.Types.NotifyApplicationStateRequest, callback?: (err: AWSError, data: MigrationHub.Types.NotifyApplicationStateResult) => void): Request<MigrationHub.Types.NotifyApplicationStateResult, AWSError>;
122 /**
123 * 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.
124 */
125 notifyApplicationState(callback?: (err: AWSError, data: MigrationHub.Types.NotifyApplicationStateResult) => void): Request<MigrationHub.Types.NotifyApplicationStateResult, AWSError>;
126 /**
127 * 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.
128 */
129 notifyMigrationTaskState(params: MigrationHub.Types.NotifyMigrationTaskStateRequest, callback?: (err: AWSError, data: MigrationHub.Types.NotifyMigrationTaskStateResult) => void): Request<MigrationHub.Types.NotifyMigrationTaskStateResult, AWSError>;
130 /**
131 * 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.
132 */
133 notifyMigrationTaskState(callback?: (err: AWSError, data: MigrationHub.Types.NotifyMigrationTaskStateResult) => void): Request<MigrationHub.Types.NotifyMigrationTaskStateResult, AWSError>;
134 /**
135 * Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s 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 overiding the MAC address. Note the instructions regarding the special use case of the 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.
136 */
137 putResourceAttributes(params: MigrationHub.Types.PutResourceAttributesRequest, callback?: (err: AWSError, data: MigrationHub.Types.PutResourceAttributesResult) => void): Request<MigrationHub.Types.PutResourceAttributesResult, AWSError>;
138 /**
139 * Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s 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 overiding the MAC address. Note the instructions regarding the special use case of the 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.
140 */
141 putResourceAttributes(callback?: (err: AWSError, data: MigrationHub.Types.PutResourceAttributesResult) => void): Request<MigrationHub.Types.PutResourceAttributesResult, AWSError>;
142}
143declare namespace MigrationHub {
144 export type ApplicationId = string;
145 export type ApplicationStatus = "NOT_STARTED"|"IN_PROGRESS"|"COMPLETED"|string;
146 export interface AssociateCreatedArtifactRequest {
147 /**
148 * The name of the ProgressUpdateStream.
149 */
150 ProgressUpdateStream: ProgressUpdateStream;
151 /**
152 * Unique identifier that references the migration task.
153 */
154 MigrationTaskName: MigrationTaskName;
155 /**
156 * An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
157 */
158 CreatedArtifact: CreatedArtifact;
159 /**
160 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
161 */
162 DryRun?: DryRun;
163 }
164 export interface AssociateCreatedArtifactResult {
165 }
166 export interface AssociateDiscoveredResourceRequest {
167 /**
168 * The name of the ProgressUpdateStream.
169 */
170 ProgressUpdateStream: ProgressUpdateStream;
171 /**
172 * The identifier given to the MigrationTask.
173 */
174 MigrationTaskName: MigrationTaskName;
175 /**
176 * Object representing a Resource.
177 */
178 DiscoveredResource: DiscoveredResource;
179 /**
180 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
181 */
182 DryRun?: DryRun;
183 }
184 export interface AssociateDiscoveredResourceResult {
185 }
186 export type ConfigurationId = string;
187 export interface CreateProgressUpdateStreamRequest {
188 /**
189 * The name of the ProgressUpdateStream.
190 */
191 ProgressUpdateStreamName: ProgressUpdateStream;
192 /**
193 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
194 */
195 DryRun?: DryRun;
196 }
197 export interface CreateProgressUpdateStreamResult {
198 }
199 export interface CreatedArtifact {
200 /**
201 * An ARN that uniquely identifies the result of a migration task.
202 */
203 Name: CreatedArtifactName;
204 /**
205 * A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.
206 */
207 Description?: CreatedArtifactDescription;
208 }
209 export type CreatedArtifactDescription = string;
210 export type CreatedArtifactList = CreatedArtifact[];
211 export type CreatedArtifactName = string;
212 export interface DeleteProgressUpdateStreamRequest {
213 /**
214 * The name of the ProgressUpdateStream.
215 */
216 ProgressUpdateStreamName: ProgressUpdateStream;
217 /**
218 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
219 */
220 DryRun?: DryRun;
221 }
222 export interface DeleteProgressUpdateStreamResult {
223 }
224 export interface DescribeApplicationStateRequest {
225 /**
226 * The configurationId in ADS that uniquely identifies the grouped application.
227 */
228 ApplicationId: ApplicationId;
229 }
230 export interface DescribeApplicationStateResult {
231 /**
232 * Status of the application - Not Started, In-Progress, Complete.
233 */
234 ApplicationStatus?: ApplicationStatus;
235 /**
236 * The timestamp when the application status was last updated.
237 */
238 LastUpdatedTime?: UpdateDateTime;
239 }
240 export interface DescribeMigrationTaskRequest {
241 /**
242 * The name of the ProgressUpdateStream.
243 */
244 ProgressUpdateStream: ProgressUpdateStream;
245 /**
246 * The identifier given to the MigrationTask.
247 */
248 MigrationTaskName: MigrationTaskName;
249 }
250 export interface DescribeMigrationTaskResult {
251 /**
252 * Object encapsulating information about the migration task.
253 */
254 MigrationTask?: MigrationTask;
255 }
256 export interface DisassociateCreatedArtifactRequest {
257 /**
258 * The name of the ProgressUpdateStream.
259 */
260 ProgressUpdateStream: ProgressUpdateStream;
261 /**
262 * Unique identifier that references the migration task to be disassociated with the artifact.
263 */
264 MigrationTaskName: MigrationTaskName;
265 /**
266 * An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
267 */
268 CreatedArtifactName: CreatedArtifactName;
269 /**
270 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
271 */
272 DryRun?: DryRun;
273 }
274 export interface DisassociateCreatedArtifactResult {
275 }
276 export interface DisassociateDiscoveredResourceRequest {
277 /**
278 * The name of the ProgressUpdateStream.
279 */
280 ProgressUpdateStream: ProgressUpdateStream;
281 /**
282 * The identifier given to the MigrationTask.
283 */
284 MigrationTaskName: MigrationTaskName;
285 /**
286 * ConfigurationId of the ADS resource to be disassociated.
287 */
288 ConfigurationId: ConfigurationId;
289 /**
290 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
291 */
292 DryRun?: DryRun;
293 }
294 export interface DisassociateDiscoveredResourceResult {
295 }
296 export interface DiscoveredResource {
297 /**
298 * The configurationId in ADS that uniquely identifies the on-premise resource.
299 */
300 ConfigurationId: ConfigurationId;
301 /**
302 * A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.
303 */
304 Description?: DiscoveredResourceDescription;
305 }
306 export type DiscoveredResourceDescription = string;
307 export type DiscoveredResourceList = DiscoveredResource[];
308 export type DryRun = boolean;
309 export interface ImportMigrationTaskRequest {
310 /**
311 * The name of the ProgressUpdateStream.
312 */
313 ProgressUpdateStream: ProgressUpdateStream;
314 /**
315 * Unique identifier that references the migration task.
316 */
317 MigrationTaskName: MigrationTaskName;
318 /**
319 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
320 */
321 DryRun?: DryRun;
322 }
323 export interface ImportMigrationTaskResult {
324 }
325 export type LatestResourceAttributeList = ResourceAttribute[];
326 export interface ListCreatedArtifactsRequest {
327 /**
328 * The name of the ProgressUpdateStream.
329 */
330 ProgressUpdateStream: ProgressUpdateStream;
331 /**
332 * Unique identifier that references the migration task.
333 */
334 MigrationTaskName: MigrationTaskName;
335 /**
336 * 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.
337 */
338 NextToken?: Token;
339 /**
340 * Maximum number of results to be returned per page.
341 */
342 MaxResults?: MaxResultsCreatedArtifacts;
343 }
344 export interface ListCreatedArtifactsResult {
345 /**
346 * 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.
347 */
348 NextToken?: Token;
349 /**
350 * List of created artifacts up to the maximum number of results specified in the request.
351 */
352 CreatedArtifactList?: CreatedArtifactList;
353 }
354 export interface ListDiscoveredResourcesRequest {
355 /**
356 * The name of the ProgressUpdateStream.
357 */
358 ProgressUpdateStream: ProgressUpdateStream;
359 /**
360 * The name of the MigrationTask.
361 */
362 MigrationTaskName: MigrationTaskName;
363 /**
364 * 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.
365 */
366 NextToken?: Token;
367 /**
368 * The maximum number of results returned per page.
369 */
370 MaxResults?: MaxResultsResources;
371 }
372 export interface ListDiscoveredResourcesResult {
373 /**
374 * 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.
375 */
376 NextToken?: Token;
377 /**
378 * Returned list of discovered resources associated with the given MigrationTask.
379 */
380 DiscoveredResourceList?: DiscoveredResourceList;
381 }
382 export interface ListMigrationTasksRequest {
383 /**
384 * 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.
385 */
386 NextToken?: Token;
387 /**
388 * Value to specify how many results are returned per page.
389 */
390 MaxResults?: MaxResults;
391 /**
392 * Filter migration tasks by discovered resource name.
393 */
394 ResourceName?: ResourceName;
395 }
396 export interface ListMigrationTasksResult {
397 /**
398 * 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.
399 */
400 NextToken?: Token;
401 /**
402 * Lists the migration task's summary which includes: MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and the UpdateDateTime for each task.
403 */
404 MigrationTaskSummaryList?: MigrationTaskSummaryList;
405 }
406 export interface ListProgressUpdateStreamsRequest {
407 /**
408 * 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.
409 */
410 NextToken?: Token;
411 /**
412 * Filter to limit the maximum number of results to list per page.
413 */
414 MaxResults?: MaxResults;
415 }
416 export interface ListProgressUpdateStreamsResult {
417 /**
418 * List of progress update streams up to the max number of results passed in the input.
419 */
420 ProgressUpdateStreamSummaryList?: ProgressUpdateStreamSummaryList;
421 /**
422 * 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.
423 */
424 NextToken?: Token;
425 }
426 export type MaxResults = number;
427 export type MaxResultsCreatedArtifacts = number;
428 export type MaxResultsResources = number;
429 export interface MigrationTask {
430 /**
431 * A name that identifies the vendor of the migration tool being used.
432 */
433 ProgressUpdateStream?: ProgressUpdateStream;
434 /**
435 * Unique identifier that references the migration task.
436 */
437 MigrationTaskName?: MigrationTaskName;
438 /**
439 * Task object encapsulating task information.
440 */
441 Task?: Task;
442 /**
443 * The timestamp when the task was gathered.
444 */
445 UpdateDateTime?: UpdateDateTime;
446 /**
447 *
448 */
449 ResourceAttributeList?: LatestResourceAttributeList;
450 }
451 export type MigrationTaskName = string;
452 export interface MigrationTaskSummary {
453 /**
454 * An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool.
455 */
456 ProgressUpdateStream?: ProgressUpdateStream;
457 /**
458 * Unique identifier that references the migration task.
459 */
460 MigrationTaskName?: MigrationTaskName;
461 /**
462 * Status of the task.
463 */
464 Status?: Status;
465 /**
466 *
467 */
468 ProgressPercent?: ProgressPercent;
469 /**
470 * Detail information of what is being done within the overall status state.
471 */
472 StatusDetail?: StatusDetail;
473 /**
474 * The timestamp when the task was gathered.
475 */
476 UpdateDateTime?: UpdateDateTime;
477 }
478 export type MigrationTaskSummaryList = MigrationTaskSummary[];
479 export type NextUpdateSeconds = number;
480 export interface NotifyApplicationStateRequest {
481 /**
482 * The configurationId in ADS that uniquely identifies the grouped application.
483 */
484 ApplicationId: ApplicationId;
485 /**
486 * Status of the application - Not Started, In-Progress, Complete.
487 */
488 Status: ApplicationStatus;
489 /**
490 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
491 */
492 DryRun?: DryRun;
493 }
494 export interface NotifyApplicationStateResult {
495 }
496 export interface NotifyMigrationTaskStateRequest {
497 /**
498 * The name of the ProgressUpdateStream.
499 */
500 ProgressUpdateStream: ProgressUpdateStream;
501 /**
502 * Unique identifier that references the migration task.
503 */
504 MigrationTaskName: MigrationTaskName;
505 /**
506 * Information about the task's progress and status.
507 */
508 Task: Task;
509 /**
510 * The timestamp when the task was gathered.
511 */
512 UpdateDateTime: UpdateDateTime;
513 /**
514 * 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.
515 */
516 NextUpdateSeconds: NextUpdateSeconds;
517 /**
518 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
519 */
520 DryRun?: DryRun;
521 }
522 export interface NotifyMigrationTaskStateResult {
523 }
524 export type ProgressPercent = number;
525 export type ProgressUpdateStream = string;
526 export interface ProgressUpdateStreamSummary {
527 /**
528 * The name of the ProgressUpdateStream.
529 */
530 ProgressUpdateStreamName?: ProgressUpdateStream;
531 }
532 export type ProgressUpdateStreamSummaryList = ProgressUpdateStreamSummary[];
533 export interface PutResourceAttributesRequest {
534 /**
535 * The name of the ProgressUpdateStream.
536 */
537 ProgressUpdateStream: ProgressUpdateStream;
538 /**
539 * Unique identifier that references the migration task.
540 */
541 MigrationTaskName: MigrationTaskName;
542 /**
543 * 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 (ADS)'s 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 (ADS)'s 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.
544 */
545 ResourceAttributeList: ResourceAttributeList;
546 /**
547 * Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.
548 */
549 DryRun?: DryRun;
550 }
551 export interface PutResourceAttributesResult {
552 }
553 export interface ResourceAttribute {
554 /**
555 * Type of resource.
556 */
557 Type: ResourceAttributeType;
558 /**
559 * Value of the resource type.
560 */
561 Value: ResourceAttributeValue;
562 }
563 export type ResourceAttributeList = ResourceAttribute[];
564 export type ResourceAttributeType = "IPV4_ADDRESS"|"IPV6_ADDRESS"|"MAC_ADDRESS"|"FQDN"|"VM_MANAGER_ID"|"VM_MANAGED_OBJECT_REFERENCE"|"VM_NAME"|"VM_PATH"|"BIOS_ID"|"MOTHERBOARD_SERIAL_NUMBER"|string;
565 export type ResourceAttributeValue = string;
566 export type ResourceName = string;
567 export type Status = "NOT_STARTED"|"IN_PROGRESS"|"FAILED"|"COMPLETED"|string;
568 export type StatusDetail = string;
569 export interface Task {
570 /**
571 * Status of the task - Not Started, In-Progress, Complete.
572 */
573 Status: Status;
574 /**
575 * Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.
576 */
577 StatusDetail?: StatusDetail;
578 /**
579 * Indication of the percentage completion of the task.
580 */
581 ProgressPercent?: ProgressPercent;
582 }
583 export type Token = string;
584 export type UpdateDateTime = Date;
585 /**
586 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
587 */
588 export type apiVersion = "2017-05-31"|"latest"|string;
589 export interface ClientApiVersions {
590 /**
591 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
592 */
593 apiVersion?: apiVersion;
594 }
595 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
596 /**
597 * Contains interfaces for use with the MigrationHub client.
598 */
599 export import Types = MigrationHub;
600}
601export = MigrationHub;