ListCreatedArtifactsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MigrationHubClient, ListCreatedArtifactsCommand } from "@aws-sdk/client-migration-hub"; // ES Modules import
// const { MigrationHubClient, ListCreatedArtifactsCommand } = require("@aws-sdk/client-migration-hub"); // CommonJS import
const client = new MigrationHubClient(config);
const input = { // ListCreatedArtifactsRequest
  ProgressUpdateStream: "STRING_VALUE", // required
  MigrationTaskName: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListCreatedArtifactsCommand(input);
const response = await client.send(command);
// { // ListCreatedArtifactsResult
//   NextToken: "STRING_VALUE",
//   CreatedArtifactList: [ // CreatedArtifactList
//     { // CreatedArtifact
//       Name: "STRING_VALUE", // required
//       Description: "STRING_VALUE",
//     },
//   ],
// };

ListCreatedArtifactsCommand Input

See ListCreatedArtifactsCommandInput for more details

Parameter
Type
Description
MigrationTaskName
Required
string | undefined

Unique identifier that references the migration task. Do not store personal data in this field.

ProgressUpdateStream
Required
string | undefined

The name of the ProgressUpdateStream.

MaxResults
number | undefined

Maximum number of results to be returned per page.

NextToken
string | undefined

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.

ListCreatedArtifactsCommand Output

See ListCreatedArtifactsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreatedArtifactList
CreatedArtifact[] | undefined

List of created artifacts up to the maximum number of results specified in the request.

NextToken
string | undefined

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.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

HomeRegionNotSetException
client

The home region is not set. Set the home region to continue.

InternalServerError
server

Exception raised when an internal, configuration, or dependency error is encountered.

InvalidInputException
client

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

ResourceNotFoundException
client

Exception raised when the request references a resource (Application Discovery Service configuration, update stream, migration task, etc.) that does not exist in Application Discovery Service (Application Discovery Service) or in Migration Hub's repository.

ServiceUnavailableException
server

Exception raised when there is an internal, configuration, or dependency error encountered.

ThrottlingException
client

The request was denied due to request throttling.

MigrationHubServiceException
Base exception class for all service exceptions from MigrationHub service.