URI HTTP methods Schemas Properties See also

Configuration

Represents an MSK configuration. Use this path to describe the configuration.

URI

/v1/configurations/arn

HTTP methods

GET

Operation ID: DescribeConfiguration

Returns a description of this MSK configuration.

Path parameters
Name	Type	Required	Description
`arn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Responses
Status code	Response model	Description
`200`	`DescribeConfigurationResponse`	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

PUT

Operation ID: UpdateConfiguration

Creates a new revision of the cluster configuration. The configuration must be in the ACTIVE state.

Path parameters
Name	Type	Required	Description
`arn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Responses
Status code	Response model	Description
`200`	`UpdateConfigurationResponse`	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.
`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

DELETE

Operation ID: DeleteConfiguration

Deletes a cluster configuration and all its revisions.

Path parameters
Name	Type	Required	Description
`arn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Responses
Status code	Response model	Description
`200`	`DeleteConfigurationResponse`	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

OPTIONS

Enable CORS by returning the correct headers.

Path parameters
Name	Type	Required	Description
`arn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Responses
Status code	Response model	Description
`200`	None	Default response for CORS method

Schemas

Request bodies


{
  "description": "string",
  "serverProperties": "string"
}

Response bodies


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


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


{
  "state": enum,
  "Arn": "string"
}


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

Properties

ConfigurationRevision

Describes a configuration revision.

Property Type Required Description

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.

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.

ConfigurationState

State of a kafka configuration

ACTIVE
DELETING
DELETE_FAILED

DeleteConfigurationResponse

Returns information about the deleted configuration.

Property	Type	Required	Description
`Arn`	string	False	The Amazon Resource Name (ARN) of the configuration.
`state`	ConfigurationState	False	State of the configuration.

DescribeConfigurationResponse

Response body for DescribeConfiguration.

Property	Type	Required	Description
`arn`	string	True	The Amazon Resource Name (ARN) of the configuration.
`creationTime`	string	True	The time when the configuration was created.
`description`	string	True	The description of the configuration.
`kafkaVersions`	Array of type string	True	The versions of Apache Kafka with which you can use this MSK configuration.
`latestRevision`	ConfigurationRevision	True	Latest revision of the configuration.
`name`	string	True	The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".
`state`	ConfigurationState	False	State of the configuration.

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.

UpdateConfigurationRequest

Update an MSK configuration.

Property	Type	Required	Description
`description`	string	False	The description of the 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 console, the SDK, or the CLI, the contents of `server.properties` can be in plaintext.

UpdateConfigurationResponse

Response body for UpdateConfiguration

Property	Type	Required	Description
`arn`	string	False	The Amazon Resource Name (ARN) of the configuration.
`latestRevision`	ConfigurationRevision	False	Latest revision of the configuration.