URI HTTP methods Schemas Properties See also

Cluster Operations

Represents the operations that have been performed on an MSK cluster.

URI

/v1/clusters/clusterArn/operations

HTTP methods

GET

Operation ID: ListClusterOperations

Returns a list of all the operations that have been performed on the specified MSK cluster.

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
`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`	`ListClusterOperationsResponse`	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

OPTIONS

Enable CORS by returning the correct headers.

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`	None	Default response for CORS method

Schemas

Response bodies


{
  "nextToken": "string",
  "clusterOperationInfoList": [
    {
      "clusterArn": "string",
      "creationTime": "string",
      "clientRequestId": "string",
      "operationState": "string",
      "sourceClusterInfo": {
        "encryptionInfo": {
          "encryptionInTransit": {
            "inCluster": boolean,
            "clientBroker": enum
          },
          "encryptionAtRest": {
            "dataVolumeKMSKeyId": "string"
          }
        },
        "numberOfBrokerNodes": integer,
        "configurationInfo": {
          "arn": "string",
          "revision": integer
        },
        "enhancedMonitoring": enum,
        "storageMode": enum,
        "kafkaVersion": "string",
        "instanceType": "string",
        "connectivityInfo": {
          "vpcConnectivity": {
            "clientAuthentication": {
              "sasl": {
                "iam": {
                  "enabled": boolean
                },
                "scram": {
                  "enabled": boolean
                }
              },
              "tls": {
                "enabled": boolean
              }
            }
          },
          "publicAccess": {
            "type": "string"
          }
        },
        "clientAuthentication": {
          "sasl": {
            "iam": {
              "enabled": boolean
            },
            "scram": {
              "enabled": boolean
            }
          },
          "unauthenticated": {
            "enabled": boolean
          },
          "tls": {
            "certificateAuthorityArnList": [
              "string"
            ],
            "enabled": boolean
          }
        },
        "loggingInfo": {
          "brokerLogs": {
            "s3": {
              "bucket": "string",
              "prefix": "string",
              "enabled": boolean
            },
            "firehose": {
              "deliveryStream": "string",
              "enabled": boolean
            },
            "cloudWatchLogs": {
              "logGroup": "string",
              "enabled": boolean
            }
          }
        },
        "brokerEBSVolumeInfo": [
          {
            "volumeSizeGB": integer,
            "provisionedThroughput": {
              "volumeThroughput": integer,
              "enabled": boolean
            },
            "kafkaBrokerNodeId": "string"
          }
        ],
        "openMonitoring": {
          "prometheus": {
            "nodeExporter": {
              "enabledInBroker": boolean
            },
            "jmxExporter": {
              "enabledInBroker": boolean
            }
          }
        }
      },
      "errorInfo": {
        "errorString": "string",
        "errorCode": "string"
      },
      "vpcConnectionInfo": {
        "owner": "string",
        "vpcConnectionArn": "string",
        "creationTime": "string",
        "userIdentity": {
          "principalId": "string",
          "type": enum
        }
      },
      "operationType": "string",
      "endTime": "string",
      "operationSteps": [
        {
          "stepName": "string",
          "stepInfo": {
            "stepStatus": "string"
          }
        }
      ],
      "operationArn": "string",
      "targetClusterInfo": {
        "encryptionInfo": {
          "encryptionInTransit": {
            "inCluster": boolean,
            "clientBroker": enum
          },
          "encryptionAtRest": {
            "dataVolumeKMSKeyId": "string"
          }
        },
        "numberOfBrokerNodes": integer,
        "configurationInfo": {
          "arn": "string",
          "revision": integer
        },
        "enhancedMonitoring": enum,
        "storageMode": enum,
        "kafkaVersion": "string",
        "instanceType": "string",
        "connectivityInfo": {
          "vpcConnectivity": {
            "clientAuthentication": {
              "sasl": {
                "iam": {
                  "enabled": boolean
                },
                "scram": {
                  "enabled": boolean
                }
              },
              "tls": {
                "enabled": boolean
              }
            }
          },
          "publicAccess": {
            "type": "string"
          }
        },
        "clientAuthentication": {
          "sasl": {
            "iam": {
              "enabled": boolean
            },
            "scram": {
              "enabled": boolean
            }
          },
          "unauthenticated": {
            "enabled": boolean
          },
          "tls": {
            "certificateAuthorityArnList": [
              "string"
            ],
            "enabled": boolean
          }
        },
        "loggingInfo": {
          "brokerLogs": {
            "s3": {
              "bucket": "string",
              "prefix": "string",
              "enabled": boolean
            },
            "firehose": {
              "deliveryStream": "string",
              "enabled": boolean
            },
            "cloudWatchLogs": {
              "logGroup": "string",
              "enabled": boolean
            }
          }
        },
        "brokerEBSVolumeInfo": [
          {
            "volumeSizeGB": integer,
            "provisionedThroughput": {
              "volumeThroughput": integer,
              "enabled": boolean
            },
            "kafkaBrokerNodeId": "string"
          }
        ],
        "openMonitoring": {
          "prometheus": {
            "nodeExporter": {
              "enabledInBroker": boolean
            },
            "jmxExporter": {
              "enabledInBroker": boolean
            }
          }
        }
      }
    }
  ]
}


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

Properties

BrokerEBSVolumeInfo

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

Property	Type	Required	Description
`kafkaBrokerNodeId`	string	True	The ID of the broker to update. The only allowed value is `ALL`. This means that Amazon MSK applies the same storage update to all broker nodes.
`provisionedThroughput`	ProvisionedThroughput	False	EBS volume provisioned throughput information.
`volumeSizeGB`	integer	False	Size of the EBS volume to update.

BrokerLogs

The broker logs configuration for this MSK cluster.

Property	Type	Required	Description
`cloudWatchLogs`	CloudWatchLogs	False	Details of the CloudWatch Logs destination for broker logs.
`firehose`	Firehose	False	Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.
`s3`	S3	False	Details of the Amazon S3 destination for broker logs.

ClientAuthentication

Includes all client authentication information.

Property	Type	Required	Description
`sasl`	Sasl	False	Details for client authentication using SASL. To turn on SASL, you must also turn on `EncryptionInTransit` by setting `inCluster` to true. You must set `clientBroker` to either `TLS` or `TLS_PLAINTEXT`. If you choose `TLS_PLAINTEXT`, then you must also set `unauthenticated` to true.
`tls`	Tls	False	Details for ClientAuthentication using TLS. To turn on TLS access control, you must also turn on `EncryptionInTransit` by setting `inCluster` to true and `clientBroker` to `TLS`.
`unauthenticated`	Unauthenticated	False	Details for ClientAuthentication using no authentication.

ClientBroker

Client-broker encryption in transit setting.

TLS
TLS_PLAINTEXT
PLAINTEXT

CloudWatchLogs

Details of the CloudWatch Logs destination for broker logs.

Property	Type	Required	Description
`enabled`	boolean	True	Specifies whether broker logs get sent to the specified CloudWatch Logs destination.
`logGroup`	string	False	The CloudWatch log group that is the destination for broker logs.

ClusterOperationInfo

Returns information about a cluster operation.

Property	Type	Required	Description
`clientRequestId`	string	False	The ID of the API request that triggered this operation.
`clusterArn`	string	False	ARN of the cluster.
`creationTime`	string	False	The time that the operation was created.
`endTime`	string	False	The time at which the operation finished.
`errorInfo`	ErrorInfo	False	Describes the error if the operation fails.
`operationArn`	string	False	ARN of the cluster operation.
`operationState`	string	False	State of the cluster operation.
`operationSteps`	Array of type ClusterOperationStep	False	Steps completed during the operation.
`operationType`	string	False	Type of the cluster operation.
`sourceClusterInfo`	MutableClusterInfo	False	Information about cluster attributes before a cluster is updated.
`targetClusterInfo`	MutableClusterInfo	False	Information about cluster attributes after a cluster is updated.
`vpcConnectionInfo`	VpcConnectionInfo	False	Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

ClusterOperationStep

Step taken during a cluster operation.

Property	Type	Required	Description
`stepInfo`	ClusterOperationStepInfo	False	Information about the step and its status.
`stepName`	string	False	The name of the step.

ClusterOperationStepInfo

Information about a step in an operation.

Property	Type	Required	Description
`stepStatus`	string	False	The step's current status.

ConfigurationInfo

Specifies the configuration to use for the brokers.

Property Type Required Description

Property	Type	Required	Description
`arn`	string	True	ARN of the configuration to use.
`revision`	integer Format: int64 Minimum: 1	True	The revision of the configuration to use.

arn

string

True

ARN of the configuration to use.

revision

integer

Format: int64

Minimum: 1

True

The revision of the configuration to use.

ConnectivityInfo

Broker access controls.

Property	Type	Required	Description
`publicAccess`	PublicAccess	False	Access control settings for the cluster's brokers.
`vpcConnectivity`	VpcConnectivity	False	VPC connection control settings for brokers

EncryptionAtRest

The data-volume encryption details. You can't update encryption at rest settings for existing clusters.

Property	Type	Required	Description
`dataVolumeKMSKeyId`	string	True	The ARN of the Amazon KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

EncryptionInTransit

The settings for encrypting data in transit.

Property Type Required Description

Property	Type	Required	Description
`clientBroker`	ClientBroker	False	Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values. `TLS` means that client-broker communication is enabled with TLS only. `TLS_PLAINTEXT` means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. `PLAINTEXT` means that client-broker communication is enabled in plaintext only. The default value is `TLS`.
`inCluster`	boolean	False	When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext. The default value is true.

clientBroker

ClientBroker

False

Indicates the encryption setting for data in transit between clients and brokers. You must set it to one of the following values.

TLS means that client-broker communication is enabled with TLS only.

TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

PLAINTEXT means that client-broker communication is enabled in plaintext only.

The default value is TLS.

inCluster

boolean

False

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

The default value is true.

EncryptionInfo

Includes encryption-related information, such as the Amazon KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

Property	Type	Required	Description
`encryptionAtRest`	EncryptionAtRest	False	The data-volume encryption details.
`encryptionInTransit`	EncryptionInTransit	False	The details for encryption in transit.

EnhancedMonitoring

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.

DEFAULT
PER_BROKER
PER_TOPIC_PER_BROKER
PER_TOPIC_PER_PARTITION

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.

ErrorInfo

Returns information about an error state of the cluster.

Property	Type	Required	Description
`errorCode`	string	False	A number describing the error programmatically.
`errorString`	string	False	An optional field to provide more details about the error.

Firehose

Firehose details for BrokerLogs.

Property	Type	Required	Description
`deliveryStream`	string	False	The Kinesis Data Firehose delivery stream that is the destination for broker logs.
`enabled`	boolean	True	Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream.

IAM

Details for SASL/IAM client authentication.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/IAM authentication is enabled or not.

JmxExporter

Indicates whether you want to enable or disable the JMX Exporter.

Property	Type	Required	Description
`enabledInBroker`	boolean	True	Indicates whether you want to enable or disable the JMX Exporter.

ListClusterOperationsResponse

The response contains an array containing cluster operation information and a next token if the response is truncated.

Property	Type	Required	Description
`clusterOperationInfoList`	Array of type ClusterOperationInfo	False	An array of cluster operation information objects.
`nextToken`	string	False	If the response of ListClusterOperations is truncated, Amazon MSK returns a NextToken in the response. Send this NextToken in your subsequent request to ListClusterOperations.

LoggingInfo

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

Property	Type	Required	Description
`brokerLogs`	BrokerLogs	True	You can configure your MSK cluster to send broker logs to different destination types. This configuration specifies the details of these destinations.

MutableClusterInfo

Information about cluster attributes that can be updated via update APIs.

Property	Type	Required	Description
`brokerEBSVolumeInfo`	Array of type BrokerEBSVolumeInfo	False	Specifies the size of the EBS volume and the ID of the associated broker.
`clientAuthentication`	ClientAuthentication	False	Client Authentication details.
`configurationInfo`	ConfigurationInfo	False	Information about the changes in the configuration of the brokers.
`connectivityInfo`	ConnectivityInfo	False	Defines the connectivity setting of the cluster.
`encryptionInfo`	EncryptionInfo	False	Encryption details.
`enhancedMonitoring`	EnhancedMonitoring	False	The monitoring level.
`instanceType`	string	False	The broker type.
`kafkaVersion`	string	False	The Apache Kafka version.
`loggingInfo`	LoggingInfo	False	LoggingInfo details.
`numberOfBrokerNodes`	integer	False	The number of broker nodes in the cluster.
`openMonitoring`	OpenMonitoring	False	Open monitoring details.
`storageMode`	StorageMode	False	This controls storage mode for supported storage tiers.

NodeExporter

Indicates whether you want to enable or disable the Node Exporter.

Property	Type	Required	Description
`enabledInBroker`	boolean	True	Indicates whether you want to enable or disable the Node Exporter.

OpenMonitoring

JMX and Node monitoring for the MSK cluster.

Property	Type	Required	Description
`prometheus`	Prometheus	True	Prometheus exporter settings.

Prometheus

Prometheus settings for open monitoring.

Property	Type	Required	Description
`jmxExporter`	JmxExporter	False	Indicates whether you want to enable or disable the JMX Exporter.
`nodeExporter`	NodeExporter	False	Indicates whether you want to enable or disable the Node Exporter.

ProvisionedThroughput

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

Property	Type	Required	Description
`enabled`	boolean	False	Provisioned throughput is enabled or not.
`volumeThroughput`	integer	False	Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

PublicAccess

Broker access controls

Property	Type	Required	Description
`type`	string	False	DISABLED means that public access is turned off. SERVICE_PROVIDED_EIPS means that public access is turned on.

S3

The details of the Amazon S3 destination for broker logs.

Property	Type	Required	Description
`bucket`	string	False	The name of the S3 bucket that is the destination for broker logs.
`enabled`	boolean	True	Specifies whether broker logs get sent to the specified Amazon S3 destination.
`prefix`	string	False	The S3 prefix that is the destination for broker logs.

Sasl

Details for client authentication using SASL. To turn on SASL, you must also turn on EncryptionInTransit by setting inCluster to true. You must set clientBroker to either TLS or TLS_PLAINTEXT. If you choose TLS_PLAINTEXT, then you must also set unauthenticated to true.

Property	Type	Required	Description
`iam`	IAM	False	Details for ClientAuthentication using IAM.
`scram`	Scram	False	Details for SASL/SCRAM client authentication.

Scram

Details for SASL/SCRAM client authentication.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/SCRAM authentication is enabled or not.

StorageMode

Controls storage mode for various supported storage tiers.

LOCAL
TIERED

Tls

Details for client authentication using TLS.

Property	Type	Required	Description
`certificateAuthorityArnList`	Array of type string	False	List of AWS Private CA ARNs.
`enabled`	boolean	False	TLS authentication is enabled or not.

Unauthenticated

Details for allowing no client authentication.

Property	Type	Required	Description
`enabled`	boolean	False	Unauthenticated is enabled or not.

UserIdentity

Description of the requester that calls the API operation.

Property	Type	Required	Description
`principalId`	string	False	A unique identifier for the requester that calls the API operation.
`type`	UserIdentityType	False	The identity type of the requester that calls the API operation.

UserIdentityType

The identity type of the requester that calls the API operation.

AWSAccount
AWSService

VpcConnectionInfo

Description of the VPC connection.

Property	Type	Required	Description
`creationTime`	string	False	The time when Amazon MSK creates the VPC Connnection.
`owner`	string	False	The owner of the VPC Connection.
`userIdentity`	UserIdentity	False	Description of the requester that calls the API operation.
`vpcConnectionArn`	string	False	The Amazon Resource Name (ARN) of the VPC connection.

VpcConnectivity

VPC connection control settings for brokers.

Property	Type	Required	Description
`clientAuthentication`	VpcConnectivityClientAuthentication	False	VPC connection control settings for brokers.

VpcConnectivityClientAuthentication

Includes all client authentication information for VpcConnectivity.

Property	Type	Required	Description
`sasl`	VpcConnectivitySasl	False	Details for VpcConnectivity ClientAuthentication using SASL.
`tls`	VpcConnectivityTls	False	Details for VpcConnectivity ClientAuthentication using TLS.

VpcConnectivityIAM

Details for SASL/IAM client authentication for VpcConnectivity.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/IAM authentication is enabled or not.

VpcConnectivitySasl

Details for client authentication using SASL for VpcConnectivity.

Property	Type	Required	Description
`iam`	VpcConnectivityIAM	False	Details for ClientAuthentication using IAM for VpcConnectivity.
`scram`	VpcConnectivityScram	False	Details for SASL/SCRAM client authentication for VpcConnectivity.

VpcConnectivityScram

Details for SASL/SCRAM client authentication for vpcConnectivity.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/SCRAM authentication is enabled or not.

VpcConnectivityTls

Details for client authentication using TLS for vpcConnectivity.

Property	Type	Required	Description
`enabled`	boolean	False	TLS authentication is enabled or not.