| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Discovery.StartImportTask
Description
Starts an import task, which allows you to import details of your on-premises environment directly into AWS Migration Hub without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.
To start an import request, do this:
- Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.
- Fill out the template with your server and application data.
- Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.
- Use the console or the
StartImportTaskcommand with the AWS CLI or one of the AWS SDKs to import the records from your file.
For more information, including step-by-step procedures, see Migration Hub Import in the AWS Application Discovery Service User Guide.
There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see AWS Application Discovery Service Limits in the AWS Application Discovery Service User Guide.
Synopsis
- data StartImportTask = StartImportTask' {}
- newStartImportTask :: Text -> Text -> StartImportTask
- startImportTask_clientRequestToken :: Lens' StartImportTask (Maybe Text)
- startImportTask_name :: Lens' StartImportTask Text
- startImportTask_importUrl :: Lens' StartImportTask Text
- data StartImportTaskResponse = StartImportTaskResponse' {
- task :: Maybe ImportTask
- httpStatus :: Int
- newStartImportTaskResponse :: Int -> StartImportTaskResponse
- startImportTaskResponse_task :: Lens' StartImportTaskResponse (Maybe ImportTask)
- startImportTaskResponse_httpStatus :: Lens' StartImportTaskResponse Int
Creating a Request
data StartImportTask Source #
See: newStartImportTask smart constructor.
Constructors
| StartImportTask' | |
Fields
| |
Instances
Create a value of StartImportTask with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientRequestToken:StartImportTask', startImportTask_clientRequestToken - Optional. A unique token that you can provide to prevent the same import
request from occurring more than once. If you don't provide a token, a
token is automatically generated.
Sending more than one StartImportTask request with the same client
request token will return information about the original import task
with that client request token.
$sel:name:StartImportTask', startImportTask_name - A descriptive name for this request. You can use this name to filter
future requests related to this import task, such as identifying
applications and servers that were included in this import task. We
recommend that you use a meaningful name for each import task.
$sel:importUrl:StartImportTask', startImportTask_importUrl - The URL for your import file that you've uploaded to Amazon S3.
If you're using the AWS CLI, this URL is structured as follows:
s3://BucketName/ImportFileName.CSV
Request Lenses
startImportTask_clientRequestToken :: Lens' StartImportTask (Maybe Text) Source #
Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don't provide a token, a token is automatically generated.
Sending more than one StartImportTask request with the same client
request token will return information about the original import task
with that client request token.
startImportTask_name :: Lens' StartImportTask Text Source #
A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.
startImportTask_importUrl :: Lens' StartImportTask Text Source #
The URL for your import file that you've uploaded to Amazon S3.
If you're using the AWS CLI, this URL is structured as follows:
s3://BucketName/ImportFileName.CSV
Destructuring the Response
data StartImportTaskResponse Source #
See: newStartImportTaskResponse smart constructor.
Constructors
| StartImportTaskResponse' | |
Fields
| |
Instances
newStartImportTaskResponse Source #
Create a value of StartImportTaskResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:task:StartImportTaskResponse', startImportTaskResponse_task - An array of information related to the import task request including
status information, times, IDs, the Amazon S3 Object URL for the import
file, and more.
$sel:httpStatus:StartImportTaskResponse', startImportTaskResponse_httpStatus - The response's http status code.
Response Lenses
startImportTaskResponse_task :: Lens' StartImportTaskResponse (Maybe ImportTask) Source #
An array of information related to the import task request including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
startImportTaskResponse_httpStatus :: Lens' StartImportTaskResponse Int Source #
The response's http status code.