Assessments
Assessments scan a cluster for readiness before you change it. An assessment of type
UPDATE_BROKER_TYPE reports every condition that would block or complicate an
in-place upgrade from Standard brokers to Express brokers, so that you can resolve the
conditions before you call UpdateBrokerType.
URI
/v1/clusters/clusterArn/assessments
HTTP methods
GET
Operation ID: ListAssessments
Returns the assessments for a cluster, newest first. Filter by
assessmentType to narrow the list.
| Name | Type | Required | Description |
|---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
| Name | Type | Required | Description |
|---|---|---|---|
assessmentType | String | False | Optional filter. The type of assessment to filter by. |
maxResults | String | False | The maximum number of assessments to return in the response. The default is 25 and the
maximum is 100. If there are more results, the response includes a |
nextToken | String | False | The paginated results marker. When the result of the operation is truncated, the call returns |
| Status code | Response model | Description |
|---|---|---|
200 | ListAssessmentsResponse | 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 |
POST
Operation ID: CreateAssessment
Creates an assessment for a cluster and starts an asynchronous, read-only scan. The
operation returns as soon as the scan starts; poll DescribeAssessment for the
result and call ListAssessmentFindings once the status is
COMPLETE.
A cluster can have only one assessment of a given type in progress at a time. If one is already in progress, this operation returns that assessment rather than creating another. When the cluster has reached its assessment quota, the operation fails; delete a completed or failed assessment to free a slot.
The scan does not lock the cluster and does not change it.
| Name | Type | Required | Description |
|---|---|---|---|
clusterArn | String | True | The Amazon Resource Name (ARN) that uniquely identifies the cluster. |
| Status code | Response model | Description |
|---|---|---|
200 | CreateAssessmentResponse | 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 | An assessment of the same type is already in progress for this cluster. Wait for it to
complete, or read it with |
429 | Error | The cluster has reached its assessment quota. Delete a completed or failed assessment for this cluster, then retry your request. |
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. |
| Status code | Response model | Description |
|---|---|---|
200 | None | Default response for CORS method |
Schemas
Request bodies
{ "assessmentType": enum, "assessmentParameters": { "targetBrokerType": "string", "targetInstanceType": "string" }, "tags": { } }
Response bodies
{ "assessments": [ { "assessmentArn": "string", "clusterArn": "string", "assessmentType": enum, "status": enum, "creationTime": "string", "tags": { } } ], "nextToken": "string" }
{ "assessmentArn": "string", "clusterArn": "string", "assessmentType": enum, "status": enum, "creationTime": "string" }
{ "message": "string", "invalidParameter": "string" }
Properties
AssessmentInfo
Summary information about an assessment, returned by ListAssessments.
| Property | Type | Required | Description |
|---|---|---|---|
assessmentArn | string MaxLength: 2048 | False | The Amazon Resource Name (ARN) of the assessment. |
assessmentType | False | The type of assessment. | |
clusterArn | string MaxLength: 2048 | False | The Amazon Resource Name (ARN) of the cluster that was assessed. |
creationTime | string | False | The time when the assessment was created. |
status | False | The current status of the assessment. | |
tags | object | False | The tags attached to the assessment. |
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
AssessmentType
The type of assessment to perform.
UPDATE_BROKER_TYPE
CreateAssessmentRequest
Creates a new assessment for a cluster. Kicks off an asynchronous scan and returns immediately with an assessment ARN and status.
| Property | Type | Required | Description |
|---|---|---|---|
assessmentParameters | False | Type-specific parameters for the assessment. Required parameters depend on the assessmentType. | |
assessmentType | True | The type of assessment to perform. | |
tags | object | False | The tags to attach to the assessment. |
CreateAssessmentResponse
Returns information about the created assessment.
| Property | Type | Required | Description |
|---|---|---|---|
assessmentArn | string MaxLength: 2048 | False | The Amazon Resource Name (ARN) of the assessment. |
assessmentType | False | The type of assessment. | |
clusterArn | string MaxLength: 2048 | False | The Amazon Resource Name (ARN) of the cluster being assessed. |
creationTime | string | False | The time when the assessment was created. |
status | False | The current status of 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. |
ListAssessmentsResponse
Returns a list of assessments.
| Property | Type | Required | Description |
|---|---|---|---|
assessments | Array of type AssessmentInfo | False | A list of assessment summaries. |
nextToken | string | False | If the response is truncated, it returns a nextToken. Send this in the subsequent request to get the remaining results. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: