mgn / Client / start_import_file_enrichment

start_import_file_enrichment

mgn.Client.start_import_file_enrichment(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.start_import_file_enrichment(
    clientToken='string',
    s3BucketSource={
        's3Bucket': 'string',
        's3BucketOwner': 'string',
        's3Key': 'string'
    },
    s3BucketTarget={
        's3Bucket': 'string',
        's3BucketOwner': 'string',
        's3Key': 'string'
    },
    ipAssignmentStrategy='STATIC'|'DYNAMIC'
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • s3BucketSource (dict) –

    [REQUIRED]

    The S3 configuration specifying the source location of the import file to be enriched.

    • s3Bucket (string) – [REQUIRED]

      The name of the S3 bucket containing the source import file.

    • s3BucketOwner (string) – [REQUIRED]

      The AWS account ID of the S3 bucket owner.

    • s3Key (string) – [REQUIRED]

      The S3 key (path) for the source import file.

  • s3BucketTarget (dict) –

    [REQUIRED]

    The S3 configuration specifying the target location where the enriched import file will be stored.

    • s3Bucket (string) – [REQUIRED]

      The name of the S3 bucket where the enriched import file will be stored.

    • s3BucketOwner (string) – [REQUIRED]

      The AWS account ID of the target S3 bucket owner.

    • s3Key (string) – [REQUIRED]

      The S3 key (path) where the enriched import file will be stored.

  • ipAssignmentStrategy (string) – The IP assignment strategy to use when enriching the import file. Can be STATIC or DYNAMIC.

Return type:

dict

Returns:

Response Syntax

{
    'jobID': 'string'
}

Response Structure

  • (dict) –

    • jobID (string) –

      The unique identifier of the import file enrichment job that was started.

Exceptions