Topics - 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).

Topics

URI

/v1/clusters/clusterArn/topics

HTTP methods

GET

Operation ID: ListTopics

Returns all topics in a cluster.

This API response reflects data that updates approximately every minute. For the most current topic state after making changes, allow approximately one minute before querying.

Path parameters
NameTypeRequiredDescription
clusterArnStringTrue

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Query parameters
NameTypeRequiredDescription
topicNameFilterStringFalse

Returns topics starting with given name.

nextTokenStringFalse

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.

maxResultsStringFalse

The maximum number of results to return in the response (default maximum 100 results per API call). If there are more results, the response includes a NextToken parameter.

Responses
Status codeResponse modelDescription
200ListTopicsResponse

Successful 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

Schemas

Response bodies

{
  "topics": [
    {
      "partitionCount": number,
      "replicationFactor": number,
      "topicName": "string",
      "outOfSyncReplicaCount": number,
      "topicArn": "string"
    }
  ],
  "nextToken": "string"
}
{
  "message": "string",
  "invalidParameter": "string"
}

Properties

Error

Returns information about an error.

PropertyTypeRequiredDescription
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

ListTopicsResponse

The response contains an array of topics in a cluster.

PropertyTypeRequiredDescription
nextToken

string

False

If the response of ListTopics is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListTopics.

topics

Array of type TopicInfo

False

List containing topics info.

TopicInfo

Includes identification info about the topic.

PropertyTypeRequiredDescription
outOfSyncReplicaCount

number

False

Number of out of sync replica for topic

partitionCount

number

False

Partition count for a topic

replicationFactor

number

False

Replication factor for a topic

topicArn

string

False

ARN of the topic.

topicName

string

False

Name for a topic.