Assessment - Amazon Managed Streaming for Apache Kafka
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

assessmentArnStringTrue

The Amazon Resource Name (ARN) of the assessment.

Responses
Status codeResponse modelDescription
200DescribeAssessmentResponse

Successful response.

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

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.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

assessmentArnStringTrue

The Amazon Resource Name (ARN) of the assessment to delete.

Responses
Status codeResponse modelDescription
200DeleteAssessmentResponse

Successful response.

400Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401Error

The request is not authorized. The provided credentials couldn't be validated.

403Error

Access forbidden. Check your credentials and then retry your request.

404Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

409Error

The assessment is still in progress. Wait for it to complete, then retry your request.

429Error

429 response

500Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503Error

503 response

OPTIONS

Enable CORS by returning correct headers

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

assessmentArnStringTrue
Responses
Status codeResponse modelDescription
200None

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.

PropertyTypeRequiredDescription
targetBrokerType

string

MaxLength: 64

False

The broker type to assess readiness for. Specify EXPRESS to assess an upgrade from Standard brokers to Express brokers. This parameter is required when assessmentType is UPDATE_BROKER_TYPE.

targetInstanceType

string

MaxLength: 256

False

The specific instance type to assess readiness for, for example express.m7g.large. Omit it to have the assessment recommend an instance type instead, which it reports as a CAPACITY finding.

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_PROGRESS

  • COMPLETE

  • FAILED

  • DELETING

AssessmentSummary

Summary of assessment findings broken down by category and severity.

PropertyTypeRequiredDescription
byCategory

object

False

Count of findings grouped by category.

bySeverity

object

False

Count of findings grouped by severity.

findingsCapped

boolean

False

true when the assessment found more findings than it stores, so ListAssessmentFindings returns fewer findings than totalFindings. Resolve the findings you can see and run the assessment again to surface the rest.

hasBlockingFindings

boolean

False

true when the assessment found at least one ERROR-severity finding. The upgrade is blocked until every one of them is resolved. Check this field rather than counting findings yourself.

totalFindings

integer

False

How many findings the assessment detected in total. When findingsCapped is true, this count is higher than the number of findings ListAssessmentFindings returns.

AssessmentType

The type of assessment to perform.

  • UPDATE_BROKER_TYPE

DeleteAssessmentResponse

Returns the result of deleting an assessment.

PropertyTypeRequiredDescription
assessmentArn

string

MaxLength: 2048

False

The Amazon Resource Name (ARN) of the assessment being deleted.

status

AssessmentStatus

False

The current status of the assessment. Will be DELETING.

DescribeAssessmentResponse

Returns the status and summary of an assessment.

PropertyTypeRequiredDescription
assessmentArn

string

MaxLength: 2048

False

The Amazon Resource Name (ARN) of the assessment.

assessmentParameters

AssessmentParameters

False

The parameters that were provided when creating the assessment.

assessmentType

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

AssessmentStatus

False

The current status of the assessment.

statusMessage

string

False

Additional information about the current status. Present when status is FAILED.

summary

AssessmentSummary

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.

PropertyTypeRequiredDescription
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:

DescribeAssessment

DeleteAssessment