Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartImportFileEnrichment

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

Request Syntax


POST /network-migration/StartImportFileEnrichment HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "ipAssignmentStrategy": "string",
   "s3BucketSource": { 
      "s3Bucket": "string",
      "s3BucketOwner": "string",
      "s3Key": "string"
   },
   "s3BucketTarget": { 
      "s3Bucket": "string",
      "s3BucketOwner": "string",
      "s3Key": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: No

ipAssignmentStrategy

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

Type: String

Valid Values: STATIC | DYNAMIC

Required: No

s3BucketSource

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

Type: EnrichmentSourceS3Configuration object

Required: Yes

s3BucketTarget

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

Type: EnrichmentTargetS3Configuration object

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "jobID": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

jobID

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Operating denied due to a file permission or access check error.

HTTP Status Code: 403

ConflictException

The request could not be completed due to a conflict with the current state of the target resource.

errors: Conflict Exception specific errors.
resourceId: A conflict occurred when prompting for the Resource ID.
resourceType: A conflict occurred when prompting for resource type.

HTTP Status Code: 409

ServiceQuotaExceededException

The request could not be completed because its exceeded the service quota.

quotaCode: Exceeded the service quota code.
quotaValue: Exceeded the service quota value.
resourceId: Exceeded the service quota resource ID.
resourceType: Exceeded the service quota resource type.
serviceCode: Exceeded the service quota service code.

HTTP Status Code: 402

ThrottlingException

Reached throttling quota exception.

quotaCode: Reached throttling quota exception.
retryAfterSeconds: Reached throttling quota exception will retry after x seconds.
serviceCode: Reached throttling quota exception service code.

HTTP Status Code: 429

ValidationException

Validate exception.

fieldList: Validate exception field list.
reason: Validate exception reason.

HTTP Status Code: 400