StartImportFileTask - Migration Hub Strategy Recommendations

StartImportFileTask

Starts a file import.

Request Syntax

POST /start-import-file-task HTTP/1.1 Content-type: application/json { "dataSourceType": "string", "groupId": [ { "name": "string", "value": "string" } ], "name": "string", "S3Bucket": "string", "s3bucketForReportData": "string", "s3key": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

dataSourceType

Specifies the source that the servers are coming from. By default, Strategy Recommendations assumes that the servers specified in the import file are available in AWS Application Discovery Service.

Type: String

Valid Values: ApplicationDiscoveryService | MPA

Required: No

groupId

Groups the resources in the import file together with a unique name. This ID can be as filter in ListApplicationComponents and ListServers.

Type: Array of Group objects

Required: No

name

A descriptive name for the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

S3Bucket

The S3 bucket where the import file is located. The bucket name is required to begin with migrationhub-strategy-.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: [0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+

Required: Yes

s3bucketForReportData

The S3 bucket where Strategy Recommendations uploads import results. The bucket name is required to begin with migrationhub-strategy-.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: [0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+

Required: No

s3key

The Amazon S3 key name of the import file.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*\S.*

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "id": "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.

id

The ID for a specific import task. The ID is unique within an AWS account.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: .*\S.*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The AWS user account does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this account.

HTTP Status Code: 403

InternalServerException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ServiceQuotaExceededException

The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this account.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request body isn't valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: