URI HTTP methods Schemas Properties See also

V2 Operations clusterOperationArn

URI

/api/v2/operations/clusterOperationArn

HTTP methods

GET

Operation ID: DescribeClusterOperationV2

Returns a description of the cluster operation specified by the ARN.

Path parameters
Name	Type	Required	Description
`clusterOperationArn`	String	True	ARN of the cluster operation to describe.

Responses
Status code	Response model	Description
`200`	`DescribeClusterOperationV2Response`	200 response
`400`	None	HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
`401`	None	HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
`403`	None	HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
`404`	None	HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
`429`	None	HTTP Status Code 429: Limit exceeded. Resource limit reached.
`500`	None	HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
`503`	None	HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.

OPTIONS

Enable CORS by returning correct headers.

Path parameters
Name	Type	Required	Description
`clusterOperationArn`	String	True

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Response bodies


{
  "clusterOperationInfo": {
    "clusterType": enum,
    "clusterArn": "string",
    "provisioned": {
      "sourceClusterInfo": {
        "encryptionInfo": {
          "encryptionInTransit": {
            "inCluster": boolean,
            "clientBroker": enum
          },
          "encryptionAtRest": {
            "dataVolumeKMSKeyId": "string"
          }
        },
        "configurationInfo": {
          "arn": "string",
          "revision": integer
        },
        "brokerCountUpdateInfo": {
          "createdBrokerIds": [
            number
          ],
          "deletedBrokerIds": [
            number
          ]
        },
        "instanceType": "string",
        "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"
          }
        ],
        "numberOfBrokerNodes": integer,
        "enhancedMonitoring": enum,
        "storageMode": enum,
        "kafkaVersion": "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
          }
        },
        "openMonitoring": {
          "prometheus": {
            "nodeExporter": {
              "enabledInBroker": boolean
            },
            "jmxExporter": {
              "enabledInBroker": boolean
            }
          }
        }
      },
      "vpcConnectionInfo": {
        "owner": "string",
        "vpcConnectionArn": "string",
        "creationTime": "string",
        "userIdentity": {
          "principalId": "string",
          "type": enum
        }
      },
      "operationSteps": [
        {
          "stepName": "string",
          "stepInfo": {
            "stepStatus": "string"
          }
        }
      ],
      "targetClusterInfo": {
        "encryptionInfo": {
          "encryptionInTransit": {
            "inCluster": boolean,
            "clientBroker": enum
          },
          "encryptionAtRest": {
            "dataVolumeKMSKeyId": "string"
          }
        },
        "configurationInfo": {
          "arn": "string",
          "revision": integer
        },
        "brokerCountUpdateInfo": {
          "createdBrokerIds": [
            number
          ],
          "deletedBrokerIds": [
            number
          ]
        },
        "instanceType": "string",
        "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"
          }
        ],
        "numberOfBrokerNodes": integer,
        "enhancedMonitoring": enum,
        "storageMode": enum,
        "kafkaVersion": "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
          }
        },
        "openMonitoring": {
          "prometheus": {
            "nodeExporter": {
              "enabledInBroker": boolean
            },
            "jmxExporter": {
              "enabledInBroker": boolean
            }
          }
        }
      }
    },
    "operationState": "string",
    "serverless": {
      "vpcConnectionInfo": {
        "owner": "string",
        "vpcConnectionArn": "string",
        "creationTime": "string",
        "userIdentity": {
          "principalId": "string",
          "type": enum
        }
      }
    },
    "errorInfo": {
      "errorString": "string",
      "errorCode": "string"
    },
    "operationType": "string",
    "startTime": "string",
    "endTime": "string",
    "operationArn": "string"
  }
}

Properties

BrokerCountUpdateInfo

Contains the list of broker ids being changed during a broker count update.

Property	Type	Required	Description
`createdBrokerIds`	Array of type number	False	List of Kafka Broker IDs being created.
`deletedBrokerIds`	Array of type number	False	List of Kafka Broker IDs being deleted.

BrokerEBSVolumeInfo

Specifies the EBS volume object per broker which captures broker identifier and corresponding target volume size. Broker identifier could be id or arn or the keyword 'ALL'. If it is 'ALL', all nodes of the cluster will be considered for the operation.

Property	Type	Required	Description
`kafkaBrokerNodeId`	string	True	kafka id of the broker in the cluster to update.
`provisionedThroughput`	ProvisionedThroughput	False	EBS volume provisioned throughput information.
`volumeSizeGB`	integer	False	size of the EBS volume to update.

BrokerLogs

Broker Logs details for cluster.

Property	Type	Required	Description
`cloudWatchLogs`	CloudWatchLogs	False	CloudWatch Log destination details.
`firehose`	Firehose	False
`s3`	S3	False	S3 Log destination details.

ClientAuthentication

Includes all client authentication information.

Property	Type	Required	Description
`sasl`	Sasl	False	Details for ClientAuthentication using SASL.
`tls`	Tls	False	Details for ClientAuthentication using TLS.
`unauthenticated`	Unauthenticated	False	Details for ClientAuthentication using no authentication.

ClientBroker

Client-broker encryption in transit setting.

TLS
TLS_PLAINTEXT
PLAINTEXT

CloudWatchLogs

CloudWatchLogs details for BrokerLogs.

Property	Type	Required	Description
`enabled`	boolean	True	Broker logs for destination CW enabled or not.
`logGroup`	string	False	CloudWatch LogGroup where the logs will be delivered.

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

State information about the operation step.

Property	Type	Required	Description
`stepStatus`	string	False	The steps current status.

ClusterOperationV2

Returns information about a cluster operation.

Property	Type	Required	Description
`clusterArn`	string	False	ARN of the cluster.
`clusterType`	ClusterType	False	Type of the backend cluster.
`endTime`	string	False	The time at which the operation finished.
`errorInfo`	ErrorInfo	False	If cluster operation failed from an error, it describes the error.
`operationArn`	string	False	ARN of the cluster operation.
`operationState`	string	False	State of the cluster operation.
`operationType`	string	False	Type of the cluster operation.
`provisioned`	ClusterOperationV2Provisioned	False	Properties of a provisioned cluster.
`serverless`	ClusterOperationV2Serverless	False	Properties of a serverless cluster.
`startTime`	string	False	The time at which operation was created.

ClusterOperationV2Provisioned

Returns information about a provisioned cluster operation.

Property	Type	Required	Description
`operationSteps`	Array of type ClusterOperationStep	False	Steps completed during the 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.

ClusterOperationV2Serverless

Returns information about a serverless cluster operation.

Property	Type	Required	Description
`vpcConnectionInfo`	VpcConnectionInfoServerless	False	Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

ClusterType

The type of backend cluster.

PROVISIONED
SERVERLESS

ConfigurationInfo

Specifies the configuration to be used on 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 brokers
`vpcConnectivity`	VpcConnectivity	False	VPC connection control settings for brokers

DescribeClusterOperationV2Response

Information about a cluster operation.

Property	Type	Required	Description
`clusterOperationInfo`	ClusterOperationV2	False	Cluster operation information.

EncryptionAtRest

Details for encryption at rest.

Property	Type	Required	Description
`dataVolumeKMSKeyId`	string	True	KMS key used for data volume encryption.

EncryptionInTransit

Details for encryption in transit.

Property	Type	Required	Description
`clientBroker`	ClientBroker	False	Client-broker encryption in transit setting.
`inCluster`	boolean	False	In-cluster encryption in transit setting.

EncryptionInfo

Includes all encryption related information.

Property	Type	Required	Description
`encryptionAtRest`	EncryptionAtRest	False	Details for encryption at rest.
`encryptionInTransit`	EncryptionInTransit	False	Details for encryption in transit.

EnhancedMonitoring

Controls level of cluster metrics Amazon pushes to customer's cloudwatch account.

DEFAULT
PER_BROKER
PER_TOPIC_PER_BROKER
PER_TOPIC_PER_PARTITION

ErrorInfo

Error Information about a failed cluster operation.

Property	Type	Required	Description
`errorCode`	string	False	error code.
`errorString`	string	False	error message.

Firehose

Firehose details for BrokerLogs.

Property	Type	Required	Description
`deliveryStream`	string	False	Firehose delivery stream where the logs will be delivered.
`enabled`	boolean	True	Broker logs for destination firehose enabled or not.

IAM

Details for SASL/IAM client authentication.

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

JmxExporter

JMX Exporter details.

Property	Type	Required	Description
`enabledInBroker`	boolean	True	JMX Exporter being enabled in broker.

LoggingInfo

Logging info details for the cluster.

Property	Type	Required	Description
`brokerLogs`	BrokerLogs	True	Broker Logs details.

MutableClusterInfo

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

Property	Type	Required	Description
`brokerCountUpdateInfo`	BrokerCountUpdateInfo	False	Describes brokers being changed during a broker count update.
`brokerEBSVolumeInfo`	Array of type BrokerEBSVolumeInfo	False
`clientAuthentication`	ClientAuthentication	False	Client Authentication details.
`configurationInfo`	ConfigurationInfo	False	Information about the Kafka configuration deployed on the brokers of the cluster.
`connectivityInfo`	ConnectivityInfo	False	Defines the connectivity configuration of the cluster.
`encryptionInfo`	EncryptionInfo	False	Encryption details.
`enhancedMonitoring`	EnhancedMonitoring	False	This knob controls level of metrics pushed customer's cloudwatch account.
`instanceType`	string	False	The instance type.
`kafkaVersion`	string	False	The Kafka version.
`loggingInfo`	LoggingInfo	False	LoggingInfo details.
`numberOfBrokerNodes`	integer	False	The number of kafka broker nodes of the Cluster.
`openMonitoring`	OpenMonitoring	False	Open monitoring details.
`storageMode`	StorageMode	False	This controls storage mode for supported storage tiers.

NodeExporter

Node Exporter details.

Property	Type	Required	Description
`enabledInBroker`	boolean	True	Node Exporter being enabled in broker.

OpenMonitoring

JMX and Node monitoring for cluster.

Property	Type	Required	Description
`prometheus`	Prometheus	True	Prometheus details.

Prometheus

Prometheus details.

Property	Type	Required	Description
`jmxExporter`	JmxExporter	False	JMX Exporter details.
`nodeExporter`	NodeExporter	False	Node Exporter details.

ProvisionedThroughput

Contains information about provisioned throughput for the EBS storage volumes that are attached to the brokers.

Property	Type	Required	Description
`enabled`	boolean	False	Whether provisioned throughput is turned on.
`volumeThroughput`	integer	False	Throughput value of the EBS volumes for the data drive on each broker in MiB per second.

PublicAccess

Broker access controls

Property	Type	Required	Description
`type`	string	False	If public access is disabled, or if enabled the EIP provider

S3

S3 details for BrokerLogs.

Property	Type	Required	Description
`bucket`	string	False	Name of the bucket where the logs will be delivered.
`enabled`	boolean	True	Broker logs for destination S3 enabled or not.
`prefix`	string	False	prefix to the S3 bucket where the logs will be delivered.

Sasl

Details for client authentication using SASL.

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

The details of client authentication using TLS.

Property	Type	Required	Description
`certificateAuthorityArnList`	Array of type string	False	List of ACM CertificateAuthority ARNs.
`enabled`	boolean	False	Whether TLS authentication is turned on.

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.

VpcConnectionInfoServerless

Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.

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.