Assessment
URI
/v1/clusters/clusterArn/assessments/assessmentArn
HTTP methods
GET
Operation ID: DescribeAssessment
Returns the status of an assessment and, once the assessment is complete, a summary of
its findings by category and severity. The individual findings are returned by
ListAssessmentFindings.
| Name | Type | Required | Description |
|---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
assessmentArn | String | True | The Amazon Resource Name (ARN) of the assessment. |
| Status code | Response model | Description |
|---|---|---|
200 | DescribeAssessmentResponse | Successful response. |
400 | Error | The request isn't valid because the input is incorrect. Correct your input and then submit it again. |
401 | Error | The request is not authorized. The provided credentials couldn't be validated. |
403 | Error | Access forbidden. Check your credentials and then retry your request. |
404 | Error | The resource could not be found due to incorrect input. Correct the input, then retry the request. |
429 | Error | 429 response |
500 | Error | There was an unexpected internal server error. Retrying your request might resolve the issue. |
503 | Error | 503 response |
DELETE
Operation ID: DeleteAssessment
Deletes an assessment and its findings, and frees one slot against the cluster's
assessment quota. The assessment moves to DELETING and its findings are
removed asynchronously.
An assessment that is still in progress cannot be deleted. Deleting an assessment that is already being deleted succeeds.
| Name | Type | Required | Description |
|---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
assessmentArn | String | True | The Amazon Resource Name (ARN) of the assessment to delete. |
| Status code | Response model | Description |
|---|---|---|
200 | DeleteAssessmentResponse | Successful response. |
400 | Error | The request isn't valid because the input is incorrect. Correct your input and then submit it again. |
401 | Error | The request is not authorized. The provided credentials couldn't be validated. |
403 | Error | Access forbidden. Check your credentials and then retry your request. |
404 | Error | The resource could not be found due to incorrect input. Correct the input, then retry the request. |
409 | Error | The assessment is still in progress. Wait for it to complete, then retry your request. |
429 | Error | 429 response |
500 | Error | There was an unexpected internal server error. Retrying your request might resolve the issue. |
503 | Error | 503 response |
OPTIONS
Enable CORS by returning correct headers
| Name | Type | Required | Description |
|---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
assessmentArn | String | True |
| Status code | Response model | Description |
|---|---|---|
200 | None | Default response for CORS method |
Schemas
Response bodies
{ "assessmentArn": "string", "clusterArn": "string", "assessmentType": enum, "status": enum, "statusMessage": "string", "creationTime": "string", "completionTime": "string", "assessmentParameters": { "targetBrokerType": "string", "targetInstanceType": "string" }, "summary": { "totalFindings": integer, "hasBlockingFindings": boolean, "findingsCapped": boolean, "byCategory": { }, "bySeverity": { } }, "tags": { } }
{ "assessmentArn": "string", "status": enum }
{ "message": "string", "invalidParameter": "string" }
Properties
AssessmentParameters
Type-specific parameters for the assessment. The required fields depend on the assessmentType.
| Property | Type | Required | Description |
|---|---|---|---|
targetBrokerType | string MaxLength: 64 | False | The broker type to assess readiness for. Specify |
targetInstanceType | string MaxLength: 256 | False | The specific instance type to assess readiness for, for example
|
AssessmentStatus
The lifecycle status of the assessment. While the status is
IN_PROGRESS the scan is running and no findings are available. When it
reaches COMPLETE, read summary here and the individual findings
through ListAssessmentFindings. FAILED means that the scan did
not finish, and statusMessage explains why. DELETING means that
the assessment is being deleted and its findings are being removed.
IN_PROGRESSCOMPLETEFAILEDDELETING
AssessmentSummary
Summary of assessment findings broken down by category and severity.
| Property | Type | Required | Description |
|---|---|---|---|
byCategory | object | False | Count of findings grouped by category. |
bySeverity | object | False | Count of findings grouped by severity. |
findingsCapped | boolean | False |
|
hasBlockingFindings | boolean | False |
|
totalFindings | integer | False | How many findings the assessment detected in total. When |
AssessmentType
The type of assessment to perform.
UPDATE_BROKER_TYPE
DeleteAssessmentResponse
Returns the result of deleting an assessment.
| Property | Type | Required | Description |
|---|---|---|---|
assessmentArn | string MaxLength: 2048 | False | The Amazon Resource Name (ARN) of the assessment being deleted. |
status | False | The current status of the assessment. Will be DELETING. |
DescribeAssessmentResponse
Returns the status and summary of an assessment.
| Property | Type | Required | Description |
|---|---|---|---|
assessmentArn | string MaxLength: 2048 | False | The Amazon Resource Name (ARN) of the assessment. |
assessmentParameters | False | The parameters that were provided when creating the assessment. | |
assessmentType | False | The type of assessment. | |
clusterArn | string MaxLength: 2048 | False | The Amazon Resource Name (ARN) of the cluster that was assessed. |
completionTime | string | False | The time when the assessment completed. Present only when status is COMPLETE or FAILED. |
creationTime | string | False | The time when the assessment was created. |
status | False | The current status of the assessment. | |
statusMessage | string | False | Additional information about the current status. Present when status is FAILED. |
summary | False | Summary of findings by category and severity. Present only when status is COMPLETE. | |
tags | object | False | The tags attached to the assessment. |
Error
Returns information about an error.
| Property | Type | Required | Description |
|---|---|---|---|
invalidParameter | string | False | The parameter that caused the error. |
message | string | False | The description of the error. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: