URI HTTP methods Schemas Properties See also

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
Name	Type	Required	Description
`clusterArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Query parameters
Name	Type	Required	Description
`topicNameFilter`	String	False	Returns topics starting with given name.
`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 (default maximum 100 results per API call). If there are more results, the response includes a `NextToken` parameter.

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

POST

Operation ID: CreateTopic

Creates a topic using the specified properties in the request on the cluster specified by the Amazon Resource Name (ARN) in the request.

Path parameters
Name	Type	Required	Description
`clusterArn`	String	True	The Amazon Resource Name (ARN) that uniquely identifies the cluster.

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

Schemas

Request bodies


{
  "partitionCount": integer,
  "configs": "string",
  "replicationFactor": integer,
  "topicName": "string"
}

Response bodies


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


{
  "topicName": "string",
  "topicArn": "string",
  "status": enum
}


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

Properties

CreateTopicRequest

Request body for CreateTopic.

Property	Type	Required	Description
`configs`	string	False	Base64 encoded Kafka configs.
`partitionCount`	integer	True	How many partitions in the topic to be created.
`replicationFactor`	integer	True	The replication factor of the topic.
`topicName`	string	True	Name of the topic.

CreateTopicResponse

Returns information about the created topic.

Property	Type	Required	Description
`status`	TopicStatus	False	Status of the topic.
`topicArn`	string	False	ARN of the topic.
`topicName`	string	False	Name of the topic.

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.

ListTopicsResponse

The response contains an array of topics in a cluster.

Property	Type	Required	Description
`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.

Property	Type	Required	Description
`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.

TopicStatus

Status of a kafka topic

CREATING
UPDATING
DELETING
ACTIVE