Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mgn ]

start-import-file-enrichment

Description

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

Synopsis

  start-import-file-enrichment
[--client-token <value>]
--s3-bucket-source <value>
--s3-bucket-target <value>
[--ip-assignment-strategy <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--client-token (string)

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

--s3-bucket-source (structure)

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

s3Bucket -> (string)

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

s3BucketOwner -> (string)

The AWS account ID of the S3 bucket owner.

s3Key -> (string)

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

Shorthand Syntax:

s3Bucket=string,s3BucketOwner=string,s3Key=string

JSON Syntax:

{
  "s3Bucket": "string",
  "s3BucketOwner": "string",
  "s3Key": "string"
}

--s3-bucket-target (structure)

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

s3Bucket -> (string)

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

s3BucketOwner -> (string)

The AWS account ID of the target S3 bucket owner.

s3Key -> (string)

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

Shorthand Syntax:

s3Bucket=string,s3BucketOwner=string,s3Key=string

JSON Syntax:

{
  "s3Bucket": "string",
  "s3BucketOwner": "string",
  "s3Key": "string"
}

--ip-assignment-strategy (string)

The IP assignment strategy to use when enriching the import file. Can be STATIC or DYNAMIC.

Possible values:

• STATIC
• DYNAMIC

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

jobID -> (string)

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