Amazon Managed Streaming for Apache Kafka
Amazon MSK API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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.

500 Error

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

503 Error

503 response

Schemas

Response Bodies

Example DescribeConfigurationResponse

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

Example Error

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

Properties

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.

DescribeConfigurationResponse

Response body for DescribeConfiguration.

Property Type Required Description
creationTime

string

True

The time when the configuration was created.

name

string

True

The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z-]+$".

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.

arn

string

True

The Amazon Resource Name (ARN) of the configuration.

latestRevision

ConfigurationRevision

True

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.

See Also

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

DescribeConfiguration