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
AssociateCreatedArtifactAPI. -
Lists created artifacts in a paginated interface.
Request Syntax
{
"MaxResults": number,
"MigrationTaskName": "string",
"NextToken": "string",
"ProgressUpdateStream": "string"
}Request Parameters
The request accepts the following data in JSON format.
- MaxResults
-
Maximum number of results to be returned per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
- MigrationTaskName
-
Unique identifier that references the migration task. Do not store personal data in this field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[^:|]+Required: Yes
- NextToken
-
If a
NextTokenwas 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 inNextToken.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^[a-zA-Z0-9\/\+\=]{0,2048}$Required: No
- ProgressUpdateStream
-
The name of the ProgressUpdateStream.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
[^/:|\000-\037]+Required: Yes
Response Syntax
{
"CreatedArtifactList": [
{
"Description": "string",
"Name": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreatedArtifactList
-
List of created artifacts up to the maximum number of results specified in the request.
Type: Array of CreatedArtifact objects
- NextToken
-
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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^[a-zA-Z0-9\/\+\=]{0,2048}$
Errors
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- HomeRegionNotSetException
-
The home region is not set. Set the home region to continue.
HTTP Status Code: 400
- InternalServerError
-
Exception raised when an internal, configuration, or dependency error is encountered.
HTTP Status Code: 500
- InvalidInputException
-
Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.
HTTP Status Code: 400
- ResourceNotFoundException
-
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.
HTTP Status Code: 400
- ServiceUnavailableException
-
Exception raised when there is an internal, configuration, or dependency error encountered.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
Examples
List created artifacts associated with a migration task and update stream
The following example lists the created artifact name and its description that is
associated with the values passed to the required parameters of
MigrationTaskName and ProgressUpdateStream in the
request.
Sample Request
{
"ProgressUpdateStream": "SMS",
"MigrationTaskName": "sms-12de3cf1a",
"MaxResults": 1
}Sample Response
{
"CreatedArtifactList": [
{
"Name": "arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b",
"Description": "Using SMS to migrate server to EC2"
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
