Skip to main content

imports

Creates, updates, deletes, gets or lists an imports resource.

Overview

Nameimports
TypeResource
Idaws.mgn.imports

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
arnstringImportTask arn.
creation_date_timestringImport task creation datetime. (pattern: <code>[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.[0-9]+)?Z</code>)
end_date_timestringImport task end datetime. (pattern: <code>[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.[0-9]+)?Z</code>)
import_idstringImport task id. (pattern: <code>import-[0-9a-zA-Z]{17}</code>)
progress_percentagenumber (float)Import task progress percentage.
s_3_bucket_sourceobjectImport task s3 bucket source.
statusstringImport task status. (PENDING, STARTED, FAILED, SUCCEEDED)
summaryobjectImport task summary.
tagsobjectImport task tags.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_importsselectregionList imports.
start_import_file_enrichmentexecregion, s3BucketSource, s3BucketTargetStarts an import file enrichment job to process and enrich network migration import files with additional metadata and IP assignment strategies.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

List imports.

SELECT
arn,
creation_date_time,
end_date_time,
import_id,
progress_percentage,
s_3_bucket_source,
status,
summary,
tags
FROM aws.mgn.imports
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

Starts an import file enrichment job to process and enrich network migration import files with additional metadata and IP assignment strategies.

EXEC aws.mgn.imports.start_import_file_enrichment
@region='{{ region }}' --required
@@json=
'{
"clientToken": "{{ clientToken }}",
"s3BucketSource": "{{ s3BucketSource }}",
"s3BucketTarget": "{{ s3BucketTarget }}",
"ipAssignmentStrategy": "{{ ipAssignmentStrategy }}"
}'
;