Configuration Revision - Amazon Managed Streaming for Apache Kafka
URIHTTP methodsSchemasProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Configuration Revision

Represents a specific revision of an MSK configuration.

URI

/v1/configurations/arn/revisions/revision

HTTP methods

GET

Operation ID: DescribeConfigurationRevision

Returns a description of this revision of the configuration.

Path parameters
NameTypeRequiredDescription
revisionStringTrue

A string that uniquely identifies a revision of an MSK configuration.

arnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Responses
Status codeResponse modelDescription
200 DescribeConfigurationRevisionResponse

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.

Path parameters
NameTypeRequiredDescription
revisionStringTrue

A string that uniquely identifies a revision of an MSK configuration.

arnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method

Schemas

Response bodies

{
  "creationTime": "string",
  "description": "string",
  "serverProperties": "string",
  "arn": "string",
  "revision": integer
}
{
  "message": "string",
  "invalidParameter": "string"
}

Properties

DescribeConfigurationRevisionResponse

Response body for DescribeConfigurationRevision.

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

revision

integer

Format: int64

True

The revision number.

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.

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.