Returns a description of the cluster operation specified by the ARN.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, DescribeClusterOperationV2Command } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, DescribeClusterOperationV2Command } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const input = { // DescribeClusterOperationV2Request + * ClusterOperationArn: "STRING_VALUE", // required + * }; + * const command = new DescribeClusterOperationV2Command(input); + * const response = await client.send(command); + * // { // DescribeClusterOperationV2Response + * // ClusterOperationInfo: { // ClusterOperationV2 + * // ClusterArn: "STRING_VALUE", + * // ClusterType: "PROVISIONED" || "SERVERLESS", + * // StartTime: new Date("TIMESTAMP"), + * // EndTime: new Date("TIMESTAMP"), + * // ErrorInfo: { // ErrorInfo + * // ErrorCode: "STRING_VALUE", + * // ErrorString: "STRING_VALUE", + * // }, + * // OperationArn: "STRING_VALUE", + * // OperationState: "STRING_VALUE", + * // OperationType: "STRING_VALUE", + * // Provisioned: { // ClusterOperationV2Provisioned + * // OperationSteps: [ // __listOfClusterOperationStep + * // { // ClusterOperationStep + * // StepInfo: { // ClusterOperationStepInfo + * // StepStatus: "STRING_VALUE", + * // }, + * // StepName: "STRING_VALUE", + * // }, + * // ], + * // SourceClusterInfo: { // MutableClusterInfo + * // BrokerEBSVolumeInfo: [ // __listOfBrokerEBSVolumeInfo + * // { // BrokerEBSVolumeInfo + * // KafkaBrokerNodeId: "STRING_VALUE", // required + * // ProvisionedThroughput: { // ProvisionedThroughput + * // Enabled: true || false, + * // VolumeThroughput: Number("int"), + * // }, + * // VolumeSizeGB: Number("int"), + * // }, + * // ], + * // ConfigurationInfo: { // ConfigurationInfo + * // Arn: "STRING_VALUE", // required + * // Revision: Number("long"), // required + * // }, + * // NumberOfBrokerNodes: Number("int"), + * // EnhancedMonitoring: "DEFAULT" || "PER_BROKER" || "PER_TOPIC_PER_BROKER" || "PER_TOPIC_PER_PARTITION", + * // OpenMonitoring: { // OpenMonitoring + * // Prometheus: { // Prometheus + * // JmxExporter: { // JmxExporter + * // EnabledInBroker: true || false, // required + * // }, + * // NodeExporter: { // NodeExporter + * // EnabledInBroker: true || false, // required + * // }, + * // }, + * // }, + * // KafkaVersion: "STRING_VALUE", + * // LoggingInfo: { // LoggingInfo + * // BrokerLogs: { // BrokerLogs + * // CloudWatchLogs: { // CloudWatchLogs + * // Enabled: true || false, // required + * // LogGroup: "STRING_VALUE", + * // }, + * // Firehose: { // Firehose + * // DeliveryStream: "STRING_VALUE", + * // Enabled: true || false, // required + * // }, + * // S3: { // S3 + * // Bucket: "STRING_VALUE", + * // Enabled: true || false, // required + * // Prefix: "STRING_VALUE", + * // }, + * // }, + * // }, + * // InstanceType: "STRING_VALUE", + * // ClientAuthentication: { // ClientAuthentication + * // Sasl: { // Sasl + * // Scram: { // Scram + * // Enabled: true || false, + * // }, + * // Iam: { // Iam + * // Enabled: true || false, + * // }, + * // }, + * // Tls: { // Tls + * // CertificateAuthorityArnList: [ // __listOf__string + * // "STRING_VALUE", + * // ], + * // Enabled: true || false, + * // }, + * // Unauthenticated: { // Unauthenticated + * // Enabled: true || false, + * // }, + * // }, + * // EncryptionInfo: { // EncryptionInfo + * // EncryptionAtRest: { // EncryptionAtRest + * // DataVolumeKMSKeyId: "STRING_VALUE", // required + * // }, + * // EncryptionInTransit: { // EncryptionInTransit + * // ClientBroker: "TLS" || "TLS_PLAINTEXT" || "PLAINTEXT", + * // InCluster: true || false, + * // }, + * // }, + * // ConnectivityInfo: { // ConnectivityInfo + * // PublicAccess: { // PublicAccess + * // Type: "STRING_VALUE", + * // }, + * // VpcConnectivity: { // VpcConnectivity + * // ClientAuthentication: { // VpcConnectivityClientAuthentication + * // Sasl: { // VpcConnectivitySasl + * // Scram: { // VpcConnectivityScram + * // Enabled: true || false, + * // }, + * // Iam: { // VpcConnectivityIam + * // Enabled: true || false, + * // }, + * // }, + * // Tls: { // VpcConnectivityTls + * // Enabled: true || false, + * // }, + * // }, + * // }, + * // }, + * // StorageMode: "LOCAL" || "TIERED", + * // }, + * // TargetClusterInfo: { + * // BrokerEBSVolumeInfo: [ + * // { + * // KafkaBrokerNodeId: "STRING_VALUE", // required + * // ProvisionedThroughput: { + * // Enabled: true || false, + * // VolumeThroughput: Number("int"), + * // }, + * // VolumeSizeGB: Number("int"), + * // }, + * // ], + * // ConfigurationInfo: { + * // Arn: "STRING_VALUE", // required + * // Revision: Number("long"), // required + * // }, + * // NumberOfBrokerNodes: Number("int"), + * // EnhancedMonitoring: "DEFAULT" || "PER_BROKER" || "PER_TOPIC_PER_BROKER" || "PER_TOPIC_PER_PARTITION", + * // OpenMonitoring: { + * // Prometheus: { + * // JmxExporter: { + * // EnabledInBroker: true || false, // required + * // }, + * // NodeExporter: { + * // EnabledInBroker: true || false, // required + * // }, + * // }, + * // }, + * // KafkaVersion: "STRING_VALUE", + * // LoggingInfo: { + * // BrokerLogs: { + * // CloudWatchLogs: { + * // Enabled: true || false, // required + * // LogGroup: "STRING_VALUE", + * // }, + * // Firehose: { + * // DeliveryStream: "STRING_VALUE", + * // Enabled: true || false, // required + * // }, + * // S3: { + * // Bucket: "STRING_VALUE", + * // Enabled: true || false, // required + * // Prefix: "STRING_VALUE", + * // }, + * // }, + * // }, + * // InstanceType: "STRING_VALUE", + * // ClientAuthentication: { + * // Sasl: { + * // Scram: { + * // Enabled: true || false, + * // }, + * // Iam: { + * // Enabled: true || false, + * // }, + * // }, + * // Tls: { + * // CertificateAuthorityArnList: [ + * // "STRING_VALUE", + * // ], + * // Enabled: true || false, + * // }, + * // Unauthenticated: { + * // Enabled: true || false, + * // }, + * // }, + * // EncryptionInfo: { + * // EncryptionAtRest: { + * // DataVolumeKMSKeyId: "STRING_VALUE", // required + * // }, + * // EncryptionInTransit: { + * // ClientBroker: "TLS" || "TLS_PLAINTEXT" || "PLAINTEXT", + * // InCluster: true || false, + * // }, + * // }, + * // ConnectivityInfo: { + * // PublicAccess: { + * // Type: "STRING_VALUE", + * // }, + * // VpcConnectivity: { + * // ClientAuthentication: { + * // Sasl: { + * // Scram: { + * // Enabled: true || false, + * // }, + * // Iam: { + * // Enabled: true || false, + * // }, + * // }, + * // Tls: { + * // Enabled: true || false, + * // }, + * // }, + * // }, + * // }, + * // StorageMode: "LOCAL" || "TIERED", + * // }, + * // VpcConnectionInfo: { // VpcConnectionInfo + * // VpcConnectionArn: "STRING_VALUE", + * // Owner: "STRING_VALUE", + * // UserIdentity: { // UserIdentity + * // Type: "AWSACCOUNT" || "AWSSERVICE", + * // PrincipalId: "STRING_VALUE", + * // }, + * // CreationTime: new Date("TIMESTAMP"), + * // }, + * // }, + * // Serverless: { // ClusterOperationV2Serverless + * // VpcConnectionInfo: { // VpcConnectionInfoServerless + * // CreationTime: new Date("TIMESTAMP"), + * // Owner: "STRING_VALUE", + * // UserIdentity: { + * // Type: "AWSACCOUNT" || "AWSSERVICE", + * // PrincipalId: "STRING_VALUE", + * // }, + * // VpcConnectionArn: "STRING_VALUE", + * // }, + * // }, + * // }, + * // }; + * + * ``` + * + * @param DescribeClusterOperationV2CommandInput - {@link DescribeClusterOperationV2CommandInput} + * @returns {@link DescribeClusterOperationV2CommandOutput} + * @see {@link DescribeClusterOperationV2CommandInput} for command's `input` shape. + * @see {@link DescribeClusterOperationV2CommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Returns information about an error.
+ * + * @throws {@link ForbiddenException} (client fault) + *Returns information about an error.
+ * + * @throws {@link InternalServerErrorException} (server fault) + *Returns information about an error.
+ * + * @throws {@link NotFoundException} (client fault) + *Returns information about an error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *Returns information about an error.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Returns information about an error.
+ * + * @throws {@link UnauthorizedException} (client fault) + *Returns information about an error.
+ * + * @throws {@link KafkaServiceException} + *Base exception class for all service exceptions from Kafka service.
+ * + */ +export class DescribeClusterOperationV2Command extends $Command< + DescribeClusterOperationV2CommandInput, + DescribeClusterOperationV2CommandOutput, + KafkaClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DescribeClusterOperationV2CommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of all the operations that have been performed on the specified MSK cluster.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { KafkaClient, ListClusterOperationsV2Command } from "@aws-sdk/client-kafka"; // ES Modules import + * // const { KafkaClient, ListClusterOperationsV2Command } = require("@aws-sdk/client-kafka"); // CommonJS import + * const client = new KafkaClient(config); + * const input = { // ListClusterOperationsV2Request + * ClusterArn: "STRING_VALUE", // required + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListClusterOperationsV2Command(input); + * const response = await client.send(command); + * // { // ListClusterOperationsV2Response + * // ClusterOperationInfoList: [ // __listOfClusterOperationV2Summary + * // { // ClusterOperationV2Summary + * // ClusterArn: "STRING_VALUE", + * // ClusterType: "PROVISIONED" || "SERVERLESS", + * // StartTime: new Date("TIMESTAMP"), + * // EndTime: new Date("TIMESTAMP"), + * // OperationArn: "STRING_VALUE", + * // OperationState: "STRING_VALUE", + * // OperationType: "STRING_VALUE", + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListClusterOperationsV2CommandInput - {@link ListClusterOperationsV2CommandInput} + * @returns {@link ListClusterOperationsV2CommandOutput} + * @see {@link ListClusterOperationsV2CommandInput} for command's `input` shape. + * @see {@link ListClusterOperationsV2CommandOutput} for command's `response` shape. + * @see {@link KafkaClientResolvedConfig | config} for KafkaClient's `config` shape. + * + * @throws {@link BadRequestException} (client fault) + *Returns information about an error.
+ * + * @throws {@link ForbiddenException} (client fault) + *Returns information about an error.
+ * + * @throws {@link InternalServerErrorException} (server fault) + *Returns information about an error.
+ * + * @throws {@link NotFoundException} (client fault) + *Returns information about an error.
+ * + * @throws {@link ServiceUnavailableException} (server fault) + *Returns information about an error.
+ * + * @throws {@link TooManyRequestsException} (client fault) + *Returns information about an error.
+ * + * @throws {@link UnauthorizedException} (client fault) + *Returns information about an error.
+ * + * @throws {@link KafkaServiceException} + *Base exception class for all service exceptions from Kafka service.
+ * + */ +export class ListClusterOperationsV2Command extends $Command< + ListClusterOperationsV2CommandInput, + ListClusterOperationsV2CommandOutput, + KafkaClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListClusterOperationsV2CommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns information about a cluster operation.
+ */ +export interface ClusterOperationV2Summary { + /** + *ARN of the cluster.
+ */ + ClusterArn?: string; + + /** + *Type of the backend cluster.
+ */ + ClusterType?: ClusterType | string; + + /** + *The time at which operation was started.
+ */ + StartTime?: Date; + + /** + *The time at which the operation finished.
+ */ + EndTime?: Date; + + /** + *ARN of the cluster operation.
+ */ + OperationArn?: string; + + /** + *State of the cluster operation.
+ */ + OperationState?: string; + + /** + *Type of the cluster operation.
+ */ + OperationType?: string; +} + /** * @public *Contains source Apache Kafka versions and compatible target Apache Kafka versions.
@@ -1743,6 +1784,125 @@ export interface BatchDisassociateScramSecretResponse { UnprocessedScramSecrets?: UnprocessedScramSecret[]; } +/** + * @public + *Returns information about a provisioned cluster operation.
+ */ +export interface ClusterOperationV2Provisioned { + /** + *Steps completed during the operation.
+ */ + OperationSteps?: ClusterOperationStep[]; + + /** + *Information about cluster attributes before a cluster is updated.
+ */ + SourceClusterInfo?: MutableClusterInfo; + + /** + *Information about cluster attributes after a cluster is updated.
+ */ + TargetClusterInfo?: MutableClusterInfo; + + /** + *Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
+ */ + VpcConnectionInfo?: VpcConnectionInfo; +} + +/** + * @public + * Description of the VPC connection. + */ +export interface VpcConnectionInfoServerless { + /** + *The time when Amazon MSK creates the VPC Connnection.
+ */ + CreationTime?: Date; + + /** + *The owner of the VPC Connection.
+ */ + Owner?: string; + + /** + *Description of the requester that calls the API operation.
+ */ + UserIdentity?: UserIdentity; + + /** + *The Amazon Resource Name (ARN) of the VPC connection.
+ */ + VpcConnectionArn?: string; +} + +/** + * @public + *Returns information about a serverless cluster operation.
+ */ +export interface ClusterOperationV2Serverless { + /** + *Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
+ */ + VpcConnectionInfo?: VpcConnectionInfoServerless; +} + +/** + * @public + *Returns information about a cluster operation.
+ */ +export interface ClusterOperationV2 { + /** + *ARN of the cluster.
+ */ + ClusterArn?: string; + + /** + *Type of the backend cluster.
+ */ + ClusterType?: ClusterType | string; + + /** + *The time at which operation was started.
+ */ + StartTime?: Date; + + /** + *The time at which the operation finished.
+ */ + EndTime?: Date; + + /** + *If cluster operation failed from an error, it describes the error.
+ */ + ErrorInfo?: ErrorInfo; + + /** + *ARN of the cluster operation.
+ */ + OperationArn?: string; + + /** + *State of the cluster operation.
+ */ + OperationState?: string; + + /** + *Type of the cluster operation.
+ */ + OperationType?: string; + + /** + *Properties of a provisioned cluster.
+ */ + Provisioned?: ClusterOperationV2Provisioned; + + /** + *Properties of a serverless cluster.
+ */ + Serverless?: ClusterOperationV2Serverless; +} + /** * @public *Returns information about an error.
@@ -2248,6 +2408,26 @@ export interface DescribeClusterOperationResponse { ClusterOperationInfo?: ClusterOperationInfo; } +/** + * @public + */ +export interface DescribeClusterOperationV2Request { + /** + * ARN of the cluster operation to describe. + */ + ClusterOperationArn: string | undefined; +} + +/** + * @public + */ +export interface DescribeClusterOperationV2Response { + /** + *Cluster operation information
+ */ + ClusterOperationInfo?: ClusterOperationV2; +} + /** * @public */ @@ -2607,6 +2787,41 @@ export interface ListClusterOperationsResponse { NextToken?: string; } +/** + * @public + */ +export interface ListClusterOperationsV2Request { + /** + * The arn of the cluster whose operations are being requested. + */ + ClusterArn: string | undefined; + + /** + * The maxResults of the query. + */ + MaxResults?: number; + + /** + * The nextToken of the query. + */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListClusterOperationsV2Response { + /** + *An array of cluster operation information objects.
+ */ + ClusterOperationInfoList?: ClusterOperationV2Summary[]; + + /** + *If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.
+ */ + NextToken?: string; +} + /** * @public */ diff --git a/clients/client-kafka/src/pagination/ListClusterOperationsV2Paginator.ts b/clients/client-kafka/src/pagination/ListClusterOperationsV2Paginator.ts new file mode 100644 index 000000000000..9fe9ec997b7e --- /dev/null +++ b/clients/client-kafka/src/pagination/ListClusterOperationsV2Paginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + ListClusterOperationsV2Command, + ListClusterOperationsV2CommandInput, + ListClusterOperationsV2CommandOutput, +} from "../commands/ListClusterOperationsV2Command"; +import { KafkaClient } from "../KafkaClient"; +import { KafkaPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: KafkaClient, + input: ListClusterOperationsV2CommandInput, + ...args: any +): PromiseState information about the operation step.
" } }, + "com.amazonaws.kafka#ClusterOperationV2": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "ARN of the cluster.
", + "smithy.api#jsonName": "clusterArn" + } + }, + "ClusterType": { + "target": "com.amazonaws.kafka#ClusterType", + "traits": { + "smithy.api#documentation": "Type of the backend cluster.
", + "smithy.api#jsonName": "clusterType" + } + }, + "StartTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The time at which operation was started.
", + "smithy.api#jsonName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The time at which the operation finished.
", + "smithy.api#jsonName": "endTime" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.kafka#ErrorInfo", + "traits": { + "smithy.api#documentation": "If cluster operation failed from an error, it describes the error.
", + "smithy.api#jsonName": "errorInfo" + } + }, + "OperationArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "ARN of the cluster operation.
", + "smithy.api#jsonName": "operationArn" + } + }, + "OperationState": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "State of the cluster operation.
", + "smithy.api#jsonName": "operationState" + } + }, + "OperationType": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "Type of the cluster operation.
", + "smithy.api#jsonName": "operationType" + } + }, + "Provisioned": { + "target": "com.amazonaws.kafka#ClusterOperationV2Provisioned", + "traits": { + "smithy.api#documentation": "Properties of a provisioned cluster.
", + "smithy.api#jsonName": "provisioned" + } + }, + "Serverless": { + "target": "com.amazonaws.kafka#ClusterOperationV2Serverless", + "traits": { + "smithy.api#documentation": "Properties of a serverless cluster.
", + "smithy.api#jsonName": "serverless" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns information about a cluster operation.
" + } + }, + "com.amazonaws.kafka#ClusterOperationV2Provisioned": { + "type": "structure", + "members": { + "OperationSteps": { + "target": "com.amazonaws.kafka#__listOfClusterOperationStep", + "traits": { + "smithy.api#documentation": "Steps completed during the operation.
", + "smithy.api#jsonName": "operationSteps" + } + }, + "SourceClusterInfo": { + "target": "com.amazonaws.kafka#MutableClusterInfo", + "traits": { + "smithy.api#documentation": "Information about cluster attributes before a cluster is updated.
", + "smithy.api#jsonName": "sourceClusterInfo" + } + }, + "TargetClusterInfo": { + "target": "com.amazonaws.kafka#MutableClusterInfo", + "traits": { + "smithy.api#documentation": "Information about cluster attributes after a cluster is updated.
", + "smithy.api#jsonName": "targetClusterInfo" + } + }, + "VpcConnectionInfo": { + "target": "com.amazonaws.kafka#VpcConnectionInfo", + "traits": { + "smithy.api#documentation": "Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
", + "smithy.api#jsonName": "vpcConnectionInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns information about a provisioned cluster operation.
" + } + }, + "com.amazonaws.kafka#ClusterOperationV2Serverless": { + "type": "structure", + "members": { + "VpcConnectionInfo": { + "target": "com.amazonaws.kafka#VpcConnectionInfoServerless", + "traits": { + "smithy.api#documentation": "Description of the VPC connection for CreateVpcConnection and DeleteVpcConnection operations.
", + "smithy.api#jsonName": "vpcConnectionInfo" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns information about a serverless cluster operation.
" + } + }, + "com.amazonaws.kafka#ClusterOperationV2Summary": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "ARN of the cluster.
", + "smithy.api#jsonName": "clusterArn" + } + }, + "ClusterType": { + "target": "com.amazonaws.kafka#ClusterType", + "traits": { + "smithy.api#documentation": "Type of the backend cluster.
", + "smithy.api#jsonName": "clusterType" + } + }, + "StartTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The time at which operation was started.
", + "smithy.api#jsonName": "startTime" + } + }, + "EndTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The time at which the operation finished.
", + "smithy.api#jsonName": "endTime" + } + }, + "OperationArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "ARN of the cluster operation.
", + "smithy.api#jsonName": "operationArn" + } + }, + "OperationState": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "State of the cluster operation.
", + "smithy.api#jsonName": "operationState" + } + }, + "OperationType": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "Type of the cluster operation.
", + "smithy.api#jsonName": "operationType" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns information about a cluster operation.
" + } + }, "com.amazonaws.kafka#ClusterState": { "type": "enum", "members": { @@ -2112,6 +2298,77 @@ "smithy.api#output": {} } }, + "com.amazonaws.kafka#DescribeClusterOperationV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#DescribeClusterOperationV2Request" + }, + "output": { + "target": "com.amazonaws.kafka#DescribeClusterOperationV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#TooManyRequestsException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a description of the cluster operation specified by the ARN.
", + "smithy.api#http": { + "method": "GET", + "uri": "/api/v2/operations/{ClusterOperationArn}", + "code": 200 + } + } + }, + "com.amazonaws.kafka#DescribeClusterOperationV2Request": { + "type": "structure", + "members": { + "ClusterOperationArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "ARN of the cluster operation to describe.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kafka#DescribeClusterOperationV2Response": { + "type": "structure", + "members": { + "ClusterOperationInfo": { + "target": "com.amazonaws.kafka#ClusterOperationV2", + "traits": { + "smithy.api#documentation": "Cluster operation information
", + "smithy.api#jsonName": "clusterOperationInfo" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.kafka#DescribeClusterRequest": { "type": "structure", "members": { @@ -3102,6 +3359,9 @@ { "target": "com.amazonaws.kafka#DescribeClusterOperation" }, + { + "target": "com.amazonaws.kafka#DescribeClusterOperationV2" + }, { "target": "com.amazonaws.kafka#DescribeClusterV2" }, @@ -3129,6 +3389,9 @@ { "target": "com.amazonaws.kafka#ListClusterOperations" }, + { + "target": "com.amazonaws.kafka#ListClusterOperationsV2" + }, { "target": "com.amazonaws.kafka#ListClusters" }, @@ -4421,6 +4684,104 @@ "smithy.api#output": {} } }, + "com.amazonaws.kafka#ListClusterOperationsV2": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#ListClusterOperationsV2Request" + }, + "output": { + "target": "com.amazonaws.kafka#ListClusterOperationsV2Response" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#TooManyRequestsException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all the operations that have been performed on the specified MSK cluster.
", + "smithy.api#http": { + "method": "GET", + "uri": "/api/v2/clusters/{ClusterArn}/operations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ClusterOperationInfoList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.kafka#ListClusterOperationsV2Request": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The arn of the cluster whose operations are being requested.", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.kafka#MaxResults", + "traits": { + "smithy.api#documentation": "The maxResults of the query.", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The nextToken of the query.", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.kafka#ListClusterOperationsV2Response": { + "type": "structure", + "members": { + "ClusterOperationInfoList": { + "target": "com.amazonaws.kafka#__listOfClusterOperationV2Summary", + "traits": { + "smithy.api#documentation": "An array of cluster operation information objects.
", + "smithy.api#jsonName": "clusterOperationInfoList" + } + }, + "NextToken": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "If the response of ListClusterOperationsV2 is truncated, it returns a NextToken in the response. This NextToken should be sent in the subsequent request to ListClusterOperationsV2.
", + "smithy.api#jsonName": "nextToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.kafka#ListClusters": { "type": "operation", "input": { @@ -7466,6 +7827,42 @@ "smithy.api#documentation": "Description of the VPC connection.
" } }, + "com.amazonaws.kafka#VpcConnectionInfoServerless": { + "type": "structure", + "members": { + "CreationTime": { + "target": "com.amazonaws.kafka#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The time when Amazon MSK creates the VPC Connnection.
", + "smithy.api#jsonName": "creationTime" + } + }, + "Owner": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The owner of the VPC Connection.
", + "smithy.api#jsonName": "owner" + } + }, + "UserIdentity": { + "target": "com.amazonaws.kafka#UserIdentity", + "traits": { + "smithy.api#documentation": "Description of the requester that calls the API operation.
", + "smithy.api#jsonName": "userIdentity" + } + }, + "VpcConnectionArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the VPC connection.
", + "smithy.api#jsonName": "vpcConnectionArn" + } + } + }, + "traits": { + "smithy.api#documentation": "Description of the VPC connection." + } + }, "com.amazonaws.kafka#VpcConnectionState": { "type": "enum", "members": { @@ -7735,6 +8132,12 @@ "target": "com.amazonaws.kafka#ClusterOperationStep" } }, + "com.amazonaws.kafka#__listOfClusterOperationV2Summary": { + "type": "list", + "member": { + "target": "com.amazonaws.kafka#ClusterOperationV2Summary" + } + }, "com.amazonaws.kafka#__listOfCompatibleKafkaVersion": { "type": "list", "member": {