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

StartImport

Start import.

Request Syntax


POST /StartImport HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "s3BucketSource": { 
      "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

Start import request client token.

Type: String

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

Required: No

s3BucketSource

Start import request s3 bucket source.

Type: S3BucketSource object

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "importTask": { 
      "creationDateTime": "string",
      "endDateTime": "string",
      "importID": "string",
      "progressPercentage": number,
      "s3BucketSource": { 
         "s3Bucket": "string",
         "s3BucketOwner": "string",
         "s3Key": "string"
      },
      "status": "string",
      "summary": { 
         "applications": { 
            "createdCount": number,
            "modifiedCount": number
         },
         "servers": { 
            "createdCount": number,
            "modifiedCount": number
         },
         "waves": { 
            "createdCount": number,
            "modifiedCount": number
         }
      }
   }
}

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.

importTask

Start import response import task.

Type: ImportTask object

Errors

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

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

ResourceNotFoundException

Resource not found exception.

resourceId: Resource ID not found error.
resourceType: Resource type not found error.

HTTP Status Code: 404

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

UninitializedAccountException

Uninitialized account exception.

HTTP Status Code: 400

ValidationException

Validate exception.

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

HTTP Status Code: 400