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
Name Type Required Description
nextToken String False

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.

maxResults String False

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

Responses
Status Code Response Model Description
200 ListKafkaVersionsResponse

200 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

Schemas

Response Bodies

Example ListKafkaVersionsResponse

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

Example Error

{ "message": "string", "invalidParameter": "string" }

Properties

Error

Returns information about an error.

Property Type Required Description
message

string

False

The description of the error.

invalidParameter

string

False

The parameter that caused the error.

KafkaVersion

Information about an Apache Kafka version.

Property Type Required Description
version

string

False

The Apache Kafka version.

status

KafkaVersionStatus

False

The status of the Apache Kafka version.

KafkaVersionStatus

The status of an Apache Kafka version.

  • ACTIVE

  • DEPRECATED

ListKafkaVersionsResponse

Response for ListKafkaVersions.

Property Type Required Description
nextToken

string

False

Paginated results marker.

kafkaVersions

Array of type KafkaVersion

False

An array of Apache Kafka version objects.

See Also

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

ListKafkaVersions