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

StartAssessment

Starts the assessment of an on-premises environment.

Request Syntax


POST /start-assessment HTTP/1.1
Content-type: application/json

{
   "assessmentDataSourceType": "string",
   "assessmentTargets": [ 
      { 
         "condition": "string",
         "name": "string",
         "values": [ "string" ]
      }
   ],
   "s3bucketForAnalysisData": "string",
   "s3bucketForReportData": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

assessmentDataSourceType

The data source type of an assessment request to start.

Type: String

Valid Values: StrategyRecommendationsApplicationDataCollector | ManualImport | ApplicationDiscoveryService

Required: No

assessmentTargets

List of criteria for assessment.

Type: Array of AssessmentTarget objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

s3bucketForAnalysisData

The S3 bucket used by the collectors to send analysis data to the service. The bucket name must begin with migrationhub-strategy-.

Type: String

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

Pattern: [0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+

Required: No

s3bucketForReportData

The S3 bucket where all the reports generated by the service are stored. The bucket name must begin with migrationhub-strategy-.

Type: String

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

Pattern: [0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assessmentId": "string"
}

Response Elements

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

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

assessmentId

The ID of the assessment.

Type: String

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

Pattern: [0-9a-z-:]+

Errors

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

AccessDeniedException

The user does not have permission to perform the action. Check the AWS Identity and Access Management (IAM) policy associated with this user.

HTTP Status Code: 403

InternalServerException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ServiceQuotaExceededException

The AWS account has reached its quota of imports. Contact AWS Support to increase the quota for this account.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429