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

StartExport

Start export.

Request Syntax


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

{
   "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.

s3Bucket

Start export request s3 bucket.

Type: String

Pattern: ^[a-zA-Z0-9.\-_]{1,255}$

Required: Yes

s3BucketOwner

Start export request s3 bucket owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12,}

Required: No

s3Key

Start export request s3key.

Type: String

Pattern: ^[^\x00]{1,1020}\.csv$

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "exportTask": { 
      "creationDateTime": "string",
      "endDateTime": "string",
      "exportID": "string",
      "progressPercentage": number,
      "s3Bucket": "string",
      "s3BucketOwner": "string",
      "s3Key": "string",
      "status": "string",
      "summary": { 
         "applicationsCount": number,
         "serversCount": number,
         "wavesCount": 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.

exportTask

Start export response export task.

Type: ExportTask object

Errors

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

ServiceQuotaExceededException

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

HTTP Status Code: 402

UninitializedAccountException

Uninitialized account exception.

HTTP Status Code: 400

ValidationException

Validate exception.

HTTP Status Code: 400