Amazon Managed Streaming for Apache Kafka
Amazon MSK API Reference

Configurations

A collection of MSK configurations.

URI

/v1/configurations

HTTP Methods

GET

Operation ID: ListConfigurations

Returns a list of all the MSK configurations in this Region.

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 ListConfigurationsResponse

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.

500 Error

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

503 Error

503 response

POST

Operation ID: CreateConfiguration

Creates a new MSK configuration.

Responses

Status Code Response Model Description
200 CreateConfigurationResponse

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.

409 Error

This cluster name already exists. Retry your request using another name.

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

Request Bodies

Example POST

{ "name": "string", "description": "string", "kafkaVersions": [ "string" ], "serverProperties": "string" }

Response Bodies

Example ListConfigurationsResponse

{ "nextToken": "string", "configurations": [ { "creationTime": "string", "name": "string", "description": "string", "kafkaVersions": [ "string" ], "arn": "string", "latestRevision": { "creationTime": "string", "description": "string", "revision": integer } } ] }

Example CreateConfigurationResponse

{ "creationTime": "string", "name": "string", "arn": "string", "latestRevision": { "creationTime": "string", "description": "string", "revision": integer } }

Example Error

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

Properties

Configuration

Represents an MSK Configuration.

Property Type Required Description
creationTime

string

True

The time when the configuration was created.

name

string

True

The name of the configuration.

description

string

True

The description of the configuration.

kafkaVersions

Array of type string

True

An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.

arn

string

True

The Amazon Resource Name (ARN) of the configuration.

latestRevision

ConfigurationRevision

True

Latest revision of the configuration.

ConfigurationRevision

Describes a configuration revision.

Property Type Required Description
creationTime

string

True

The time when the configuration revision was created.

description

string

False

The description of the configuration revision.

revision

integer

Format: int64

True

The revision number.

CreateConfigurationRequest

Request body for CreateConfiguration.

Property Type Required Description
name

string

True

The name of the configuration.

description

string

False

The description of the configuration.

kafkaVersions

Array of type string

True

The versions of Apache Kafka with which you can use this MSK configuration.

serverProperties

string

True

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

CreateConfigurationResponse

Response body for CreateConfiguration

Property Type Required Description
creationTime

string

False

The time when the configuration was created.

name

string

False

The name of the configuration.

arn

string

False

The Amazon Resource Name (ARN) of the configuration.

latestRevision

ConfigurationRevision

False

Latest revision of the configuration.

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.

ListConfigurationsResponse

The response contains an array of Configuration and a next token if the response is truncated.

Property Type Required Description
nextToken

string

False

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

configurations

Array of type Configuration

False

An array of MSK configurations.

See Also

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

ListConfigurations

CreateConfiguration