import_file_tasks

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

Overview

Name	import_file_tasks
Type	Resource
Id	aws.migrationhubstrategy.import_file_tasks

Fields

The following fields are returned by SELECT queries:

get_import_file_task

Name	Datatype	Description
id	string	The import file task id returned in the response of StartImportFileTask. (pattern: <code>.\S.</code>)
completion_time	string (date-time)	The time that the import task completed.
import_name	string	The name of the import task given in StartImportFileTask. (pattern: <code>.\S.</code>)
input_s3_bucket	string	The S3 bucket where import file is located. (pattern: <code>[0-9a-z]+[0-9a-z.-]*[0-9a-z]+</code>)
input_s3_key	string	The Amazon S3 key name of the import file. (pattern: <code>.\S.</code>)
number_of_records_failed	integer	The number of records that failed to be imported.
number_of_records_success	integer	The number of records successfully imported.
start_time	string (date-time)	Start time of the import task.
status	string	Status of import file task. (ImportInProgress, ImportFailed, ImportPartialSuccess, ImportSuccess, DeleteInProgress, DeleteFailed, DeletePartialSuccess, DeleteSuccess)
status_report_s3_bucket	string	The S3 bucket name for status report of import task. (pattern: <code>[0-9a-z]+[0-9a-z.-]*[0-9a-z]+</code>)
status_report_s3_key	string	The Amazon S3 key name for status report of import task. The report contains details about whether each record imported successfully or why it did not. (pattern: <code>.\S.</code>)

list_import_file_task

Name	Datatype	Description
id	string	The ID of the import file task. (pattern: <code>.\S.</code>)
completion_time	string (date-time)	The time that the import task completes.
import_name	string	The name of the import task given in StartImportFileTask. (pattern: <code>.\S.</code>)
input_s3_bucket	string	The S3 bucket where the import file is located. (pattern: <code>[0-9a-z]+[0-9a-z.-]*[0-9a-z]+</code>)
input_s3_key	string	The Amazon S3 key name of the import file. (pattern: <code>.\S.</code>)
number_of_records_failed	integer	The number of records that failed to be imported.
number_of_records_success	integer	The number of records successfully imported.
start_time	string (date-time)	Start time of the import task.
status	string	Status of import file task. (ImportInProgress, ImportFailed, ImportPartialSuccess, ImportSuccess, DeleteInProgress, DeleteFailed, DeletePartialSuccess, DeleteSuccess)
status_report_s3_bucket	string	The S3 bucket name for status report of import task. (pattern: <code>[0-9a-z]+[0-9a-z.-]*[0-9a-z]+</code>)
status_report_s3_key	string	The Amazon S3 key name for status report of import task. The report contains details about whether each record imported successfully or why it did not. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_import_file_task	select	id, region		Retrieves the details about a specific import task.
list_import_file_task	select	region	maxResults, nextToken	Retrieves a list of all the imports performed.

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.

Name	Datatype	Description
id	string	The ID of the import file task. This ID is returned in the response of StartImportFileTask.
region	string	AWS region (default: us-east-1)
maxResults	integer	The total number of items to return. The maximum value is 100.
nextToken	string	The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

SELECT examples

get_import_file_task

Retrieves the details about a specific import task.

SELECT
id,
completion_time,
import_name,
input_s3_bucket,
input_s3_key,
number_of_records_failed,
number_of_records_success,
start_time,
status,
status_report_s3_bucket,
status_report_s3_key
FROM aws.migrationhubstrategy.import_file_tasks
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_import_file_task

Retrieves a list of all the imports performed.

SELECT
id,
completion_time,
import_name,
input_s3_bucket,
input_s3_key,
number_of_records_failed,
number_of_records_success,
start_time,
status,
status_report_s3_bucket,
status_report_s3_key
FROM aws.migrationhubstrategy.import_file_tasks
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;