Amazonka.Discovery.StartImportTask

Starts an import task, which allows you to import details of your on-premises environment directly into Amazon Web Services 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:

1. 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.
2. Fill out the template with your server and application data.
3. 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.
4. Use the console or the StartImportTask command with the Amazon Web Services CLI or one of the Amazon Web Services SDKs to import the records from your file.

For more information, including step-by-step procedures, see Migration Hub Import in the Amazon Web Services Application Discovery Service User Guide.

There are limits to the number of import tasks you can create (and delete) in an Amazon Web Services account. For more information, see Amazon Web Services Application Discovery Service Limits in the Amazon Web Services Application Discovery Service User Guide.

Creating a Request

data StartImportTask

See: newStartImportTask smart constructor.

Constructors

StartImportTask'

Fields

• clientRequestToken :: Maybe Text

  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.

• name :: Text

  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.

• importUrl :: Text

  The URL for your import file that you've uploaded to Amazon S3.

  If you're using the Amazon Web Services CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV

Instances

ToJSON StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Methods

toJSON :: StartImportTask -> Value

toEncoding :: StartImportTask -> Encoding

toJSONList :: [StartImportTask] -> Value

toEncodingList :: [StartImportTask] -> Encoding

ToHeaders StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Methods

toHeaders :: StartImportTask -> [Header]

ToPath StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Methods

toPath :: StartImportTask -> ByteString

ToQuery StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Methods

toQuery :: StartImportTask -> QueryString

AWSRequest StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Associated Types

type AWSResponse StartImportTask

Methods

request :: (Service -> Service) -> StartImportTask -> Request StartImportTask

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartImportTask -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartImportTask)))

Generic StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Associated Types

type Rep StartImportTask :: Type -> Type

Methods

from :: StartImportTask -> Rep StartImportTask x

to :: Rep StartImportTask x -> StartImportTask

Read StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Methods

readsPrec :: Int -> ReadS StartImportTask

readList :: ReadS [StartImportTask]

readPrec :: ReadPrec StartImportTask

readListPrec :: ReadPrec [StartImportTask]

Show StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Methods

showsPrec :: Int -> StartImportTask -> ShowS

show :: StartImportTask -> String

showList :: [StartImportTask] -> ShowS

NFData StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Methods

rnf :: StartImportTask -> ()

Eq StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Methods

(==) :: StartImportTask -> StartImportTask -> Bool

(/=) :: StartImportTask -> StartImportTask -> Bool

Hashable StartImportTask

Defined in Amazonka.Discovery.StartImportTask

Methods

hashWithSalt :: Int -> StartImportTask -> Int

hash :: StartImportTask -> Int

type AWSResponse StartImportTask

Defined in Amazonka.Discovery.StartImportTask

type AWSResponse StartImportTask = StartImportTaskResponse

type Rep StartImportTask

Defined in Amazonka.Discovery.StartImportTask

type Rep StartImportTask = D1 ('MetaData "StartImportTask" "Amazonka.Discovery.StartImportTask" "amazonka-discovery-2.0-FHPaShbhCtL10K1sBxZHs" 'False) (C1 ('MetaCons "StartImportTask'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "importUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartImportTask

Arguments

:: Text

StartImportTask

-> Text

StartImportTask

-> StartImportTask

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:

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.

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.

StartImportTask, startImportTask_importUrl - The URL for your import file that you've uploaded to Amazon S3.

If you're using the Amazon Web Services CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV

Request Lenses

startImportTask_clientRequestToken :: Lens' StartImportTask (Maybe Text)

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

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

The URL for your import file that you've uploaded to Amazon S3.

If you're using the Amazon Web Services CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV

Destructuring the Response

data StartImportTaskResponse

See: newStartImportTaskResponse smart constructor.

Constructors

StartImportTaskResponse'

Fields

• task :: Maybe ImportTask

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartImportTaskResponse

Defined in Amazonka.Discovery.StartImportTask

Associated Types

type Rep StartImportTaskResponse :: Type -> Type

Methods

from :: StartImportTaskResponse -> Rep StartImportTaskResponse x

to :: Rep StartImportTaskResponse x -> StartImportTaskResponse

Read StartImportTaskResponse

Defined in Amazonka.Discovery.StartImportTask

Methods

readsPrec :: Int -> ReadS StartImportTaskResponse

readList :: ReadS [StartImportTaskResponse]

readPrec :: ReadPrec StartImportTaskResponse

readListPrec :: ReadPrec [StartImportTaskResponse]

Show StartImportTaskResponse

Defined in Amazonka.Discovery.StartImportTask

Methods

showsPrec :: Int -> StartImportTaskResponse -> ShowS

show :: StartImportTaskResponse -> String

showList :: [StartImportTaskResponse] -> ShowS

NFData StartImportTaskResponse

Defined in Amazonka.Discovery.StartImportTask

Methods

rnf :: StartImportTaskResponse -> ()

Eq StartImportTaskResponse

Defined in Amazonka.Discovery.StartImportTask

Methods

(==) :: StartImportTaskResponse -> StartImportTaskResponse -> Bool

(/=) :: StartImportTaskResponse -> StartImportTaskResponse -> Bool

type Rep StartImportTaskResponse

Defined in Amazonka.Discovery.StartImportTask

type Rep StartImportTaskResponse = D1 ('MetaData "StartImportTaskResponse" "Amazonka.Discovery.StartImportTask" "amazonka-discovery-2.0-FHPaShbhCtL10K1sBxZHs" 'False) (C1 ('MetaCons "StartImportTaskResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImportTask)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartImportTaskResponse

Arguments

:: Int

$sel:httpStatus:StartImportTaskResponse'

-> StartImportTaskResponse

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)

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

The response's http status code.