GetAssessment
Retrieves the status of an on-going assessment.
Request Syntax
GET /get-assessment/id
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- id
-
The
assessmentid
returned by StartAssessment.Length Constraints: Minimum length of 0. Maximum length of 52.
Pattern:
[0-9a-z-:]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"assessmentTargets": [
{
"condition": "string",
"name": "string",
"values": [ "string" ]
}
],
"dataCollectionDetails": {
"completionTime": number,
"failed": number,
"inProgress": number,
"servers": number,
"startTime": number,
"status": "string",
"statusMessage": "string",
"success": number
},
"id": "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.
- assessmentTargets
-
List of criteria for assessment.
Type: Array of AssessmentTarget objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- dataCollectionDetails
-
Detailed information about the assessment.
Type: DataCollectionDetails object
- id
-
The ID for the specific assessment task.
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
- ResourceNotFoundException
-
The specified ID in the request is not found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: