Apache Kafka Versions - Amazon Managed Streaming for Apache Kafka

Apache Kafka Versions

Objects that represent Apache Kafka versions.

URI

/v1/kafka-versions

HTTP methods

GET

Operation ID: ListKafkaVersions

Returns the Apache Kafka version objects.

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

maxResultsStringFalse

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

Responses
Status codeResponse modelDescription
200 ListKafkaVersionsResponse

200 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

OPTIONS

Enable CORS by returning the correct headers.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Response bodies

{ "nextToken": "string", "kafkaVersions": [ { "version": "string", "status": enum } ] }
{ "message": "string", "invalidParameter": "string" }

Properties

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

KafkaVersion

Information about an Apache Kafka version.

PropertyTypeRequiredDescription
status

KafkaVersionStatus

False

The status of the Apache Kafka version.

version

string

False

The Apache Kafka version.

KafkaVersionStatus

The status of an Apache Kafka version.

  • ACTIVE

  • DEPRECATED

ListKafkaVersionsResponse

Response for ListKafkaVersions.

PropertyTypeRequiredDescription
kafkaVersions

Array of type KafkaVersion

False

An array of Apache Kafka version objects.

nextToken

string

False

Paginated results marker.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListKafkaVersions