1{ 2 "smithy": "1.0", 3 "metadata": { 4 "suppressions": [ 5 { 6 "id": "HttpMethodSemantics", 7 "namespace": "*" 8 }, 9 { 10 "id": "HttpResponseCodeSemantics", 11 "namespace": "*" 12 }, 13 { 14 "id": "PaginatedTrait", 15 "namespace": "*" 16 }, 17 { 18 "id": "HttpHeaderTrait", 19 "namespace": "*" 20 }, 21 { 22 "id": "HttpUriConflict", 23 "namespace": "*" 24 }, 25 { 26 "id": "Service", 27 "namespace": "*" 28 } 29 ] 30 }, 31 "shapes": { 32 "com.amazonaws.kafka#BadRequestException": { 33 "type": "structure", 34 "members": { 35 "InvalidParameter": { 36 "target": "com.amazonaws.kafka#__string", 37 "traits": { 38 "smithy.api#documentation": "<p>The parameter that caused the error.</p>", 39 "smithy.api#jsonName": "invalidParameter" 40 } 41 }, 42 "Message": { 43 "target": "com.amazonaws.kafka#__string", 44 "traits": { 45 "smithy.api#documentation": "<p>The description of the error.</p>", 46 "smithy.api#jsonName": "message" 47 } 48 } 49 }, 50 "traits": { 51 "smithy.api#documentation": "<p>Returns information about an error.</p>", 52 "smithy.api#error": "client", 53 "smithy.api#httpError": 400 54 } 55 }, 56 "com.amazonaws.kafka#BatchAssociateScramSecret": { 57 "type": "operation", 58 "input": { 59 "target": "com.amazonaws.kafka#BatchAssociateScramSecretRequest" 60 }, 61 "output": { 62 "target": "com.amazonaws.kafka#BatchAssociateScramSecretResponse" 63 }, 64 "errors": [ 65 { 66 "target": "com.amazonaws.kafka#BadRequestException" 67 }, 68 { 69 "target": "com.amazonaws.kafka#ForbiddenException" 70 }, 71 { 72 "target": "com.amazonaws.kafka#InternalServerErrorException" 73 }, 74 { 75 "target": "com.amazonaws.kafka#NotFoundException" 76 }, 77 { 78 "target": "com.amazonaws.kafka#ServiceUnavailableException" 79 }, 80 { 81 "target": "com.amazonaws.kafka#TooManyRequestsException" 82 }, 83 { 84 "target": "com.amazonaws.kafka#UnauthorizedException" 85 } 86 ], 87 "traits": { 88 "smithy.api#documentation": "<p>Associates one or more Scram Secrets with an Amazon MSK cluster.</p>", 89 "smithy.api#http": { 90 "method": "POST", 91 "uri": "/v1/clusters/{ClusterArn}/scram-secrets", 92 "code": 200 93 } 94 } 95 }, 96 "com.amazonaws.kafka#BatchAssociateScramSecretRequest": { 97 "type": "structure", 98 "members": { 99 "ClusterArn": { 100 "target": "com.amazonaws.kafka#__string", 101 "traits": { 102 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>", 103 "smithy.api#httpLabel": {}, 104 "smithy.api#required": {} 105 } 106 }, 107 "SecretArnList": { 108 "target": "com.amazonaws.kafka#__listOf__string", 109 "traits": { 110 "smithy.api#documentation": "<p>List of AWS Secrets Manager secret ARNs.</p>", 111 "smithy.api#jsonName": "secretArnList", 112 "smithy.api#required": {} 113 } 114 } 115 }, 116 "traits": { 117 "smithy.api#documentation": "<p>Associates sasl scram secrets to cluster.</p>" 118 } 119 }, 120 "com.amazonaws.kafka#BatchAssociateScramSecretResponse": { 121 "type": "structure", 122 "members": { 123 "ClusterArn": { 124 "target": "com.amazonaws.kafka#__string", 125 "traits": { 126 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 127 "smithy.api#jsonName": "clusterArn" 128 } 129 }, 130 "UnprocessedScramSecrets": { 131 "target": "com.amazonaws.kafka#__listOfUnprocessedScramSecret", 132 "traits": { 133 "smithy.api#documentation": "<p>List of errors when associating secrets to cluster.</p>", 134 "smithy.api#jsonName": "unprocessedScramSecrets" 135 } 136 } 137 } 138 }, 139 "com.amazonaws.kafka#BatchDisassociateScramSecret": { 140 "type": "operation", 141 "input": { 142 "target": "com.amazonaws.kafka#BatchDisassociateScramSecretRequest" 143 }, 144 "output": { 145 "target": "com.amazonaws.kafka#BatchDisassociateScramSecretResponse" 146 }, 147 "errors": [ 148 { 149 "target": "com.amazonaws.kafka#BadRequestException" 150 }, 151 { 152 "target": "com.amazonaws.kafka#ForbiddenException" 153 }, 154 { 155 "target": "com.amazonaws.kafka#InternalServerErrorException" 156 }, 157 { 158 "target": "com.amazonaws.kafka#NotFoundException" 159 }, 160 { 161 "target": "com.amazonaws.kafka#ServiceUnavailableException" 162 }, 163 { 164 "target": "com.amazonaws.kafka#TooManyRequestsException" 165 }, 166 { 167 "target": "com.amazonaws.kafka#UnauthorizedException" 168 } 169 ], 170 "traits": { 171 "smithy.api#documentation": "<p>Disassociates one or more Scram Secrets from an Amazon MSK cluster.</p>", 172 "smithy.api#http": { 173 "method": "PATCH", 174 "uri": "/v1/clusters/{ClusterArn}/scram-secrets", 175 "code": 200 176 } 177 } 178 }, 179 "com.amazonaws.kafka#BatchDisassociateScramSecretRequest": { 180 "type": "structure", 181 "members": { 182 "ClusterArn": { 183 "target": "com.amazonaws.kafka#__string", 184 "traits": { 185 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>", 186 "smithy.api#httpLabel": {}, 187 "smithy.api#required": {} 188 } 189 }, 190 "SecretArnList": { 191 "target": "com.amazonaws.kafka#__listOf__string", 192 "traits": { 193 "smithy.api#documentation": "<p>List of AWS Secrets Manager secret ARNs.</p>", 194 "smithy.api#jsonName": "secretArnList", 195 "smithy.api#required": {} 196 } 197 } 198 }, 199 "traits": { 200 "smithy.api#documentation": "<p>Disassociates sasl scram secrets to cluster.</p>" 201 } 202 }, 203 "com.amazonaws.kafka#BatchDisassociateScramSecretResponse": { 204 "type": "structure", 205 "members": { 206 "ClusterArn": { 207 "target": "com.amazonaws.kafka#__string", 208 "traits": { 209 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 210 "smithy.api#jsonName": "clusterArn" 211 } 212 }, 213 "UnprocessedScramSecrets": { 214 "target": "com.amazonaws.kafka#__listOfUnprocessedScramSecret", 215 "traits": { 216 "smithy.api#documentation": "<p>List of errors when disassociating secrets to cluster.</p>", 217 "smithy.api#jsonName": "unprocessedScramSecrets" 218 } 219 } 220 } 221 }, 222 "com.amazonaws.kafka#BrokerAZDistribution": { 223 "type": "string", 224 "traits": { 225 "smithy.api#documentation": "<p>The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.</p>\n <p>Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.</p>", 226 "smithy.api#enum": [ 227 { 228 "value": "DEFAULT", 229 "name": "DEFAULT" 230 } 231 ] 232 } 233 }, 234 "com.amazonaws.kafka#BrokerEBSVolumeInfo": { 235 "type": "structure", 236 "members": { 237 "KafkaBrokerNodeId": { 238 "target": "com.amazonaws.kafka#__string", 239 "traits": { 240 "smithy.api#documentation": "<p>The ID of the broker to update.</p>", 241 "smithy.api#jsonName": "kafkaBrokerNodeId", 242 "smithy.api#required": {} 243 } 244 }, 245 "VolumeSizeGB": { 246 "target": "com.amazonaws.kafka#__integer", 247 "traits": { 248 "smithy.api#documentation": "<p>Size of the EBS volume to update.</p>", 249 "smithy.api#jsonName": "volumeSizeGB", 250 "smithy.api#required": {} 251 } 252 } 253 }, 254 "traits": { 255 "smithy.api#documentation": "<p>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.</p>" 256 } 257 }, 258 "com.amazonaws.kafka#BrokerLogs": { 259 "type": "structure", 260 "members": { 261 "CloudWatchLogs": { 262 "target": "com.amazonaws.kafka#CloudWatchLogs", 263 "traits": { 264 "smithy.api#jsonName": "cloudWatchLogs" 265 } 266 }, 267 "Firehose": { 268 "target": "com.amazonaws.kafka#Firehose", 269 "traits": { 270 "smithy.api#jsonName": "firehose" 271 } 272 }, 273 "S3": { 274 "target": "com.amazonaws.kafka#S3", 275 "traits": { 276 "smithy.api#jsonName": "s3" 277 } 278 } 279 } 280 }, 281 "com.amazonaws.kafka#BrokerNodeGroupInfo": { 282 "type": "structure", 283 "members": { 284 "BrokerAZDistribution": { 285 "target": "com.amazonaws.kafka#BrokerAZDistribution", 286 "traits": { 287 "smithy.api#documentation": "<p>The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.</p>\n <p>Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.</p>", 288 "smithy.api#jsonName": "brokerAZDistribution" 289 } 290 }, 291 "ClientSubnets": { 292 "target": "com.amazonaws.kafka#__listOf__string", 293 "traits": { 294 "smithy.api#documentation": "<p>The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.</p>", 295 "smithy.api#jsonName": "clientSubnets", 296 "smithy.api#required": {} 297 } 298 }, 299 "InstanceType": { 300 "target": "com.amazonaws.kafka#__stringMin5Max32", 301 "traits": { 302 "smithy.api#documentation": "<p>The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.</p>", 303 "smithy.api#jsonName": "instanceType", 304 "smithy.api#required": {} 305 } 306 }, 307 "SecurityGroups": { 308 "target": "com.amazonaws.kafka#__listOf__string", 309 "traits": { 310 "smithy.api#documentation": "<p>The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.</p>", 311 "smithy.api#jsonName": "securityGroups" 312 } 313 }, 314 "StorageInfo": { 315 "target": "com.amazonaws.kafka#StorageInfo", 316 "traits": { 317 "smithy.api#documentation": "<p>Contains information about storage volumes attached to MSK broker nodes.</p>", 318 "smithy.api#jsonName": "storageInfo" 319 } 320 } 321 }, 322 "traits": { 323 "smithy.api#documentation": "<p>Describes the setup to be used for Kafka broker nodes in the cluster.</p>" 324 } 325 }, 326 "com.amazonaws.kafka#BrokerNodeInfo": { 327 "type": "structure", 328 "members": { 329 "AttachedENIId": { 330 "target": "com.amazonaws.kafka#__string", 331 "traits": { 332 "smithy.api#documentation": "<p>The attached elastic network interface of the broker.</p>", 333 "smithy.api#jsonName": "attachedENIId" 334 } 335 }, 336 "BrokerId": { 337 "target": "com.amazonaws.kafka#__double", 338 "traits": { 339 "smithy.api#documentation": "<p>The ID of the broker.</p>", 340 "smithy.api#jsonName": "brokerId" 341 } 342 }, 343 "ClientSubnet": { 344 "target": "com.amazonaws.kafka#__string", 345 "traits": { 346 "smithy.api#documentation": "<p>The client subnet to which this broker node belongs.</p>", 347 "smithy.api#jsonName": "clientSubnet" 348 } 349 }, 350 "ClientVpcIpAddress": { 351 "target": "com.amazonaws.kafka#__string", 352 "traits": { 353 "smithy.api#documentation": "<p>The virtual private cloud (VPC) of the client.</p>", 354 "smithy.api#jsonName": "clientVpcIpAddress" 355 } 356 }, 357 "CurrentBrokerSoftwareInfo": { 358 "target": "com.amazonaws.kafka#BrokerSoftwareInfo", 359 "traits": { 360 "smithy.api#documentation": "<p>Information about the version of software currently deployed on the Kafka brokers in the cluster.</p>", 361 "smithy.api#jsonName": "currentBrokerSoftwareInfo" 362 } 363 }, 364 "Endpoints": { 365 "target": "com.amazonaws.kafka#__listOf__string", 366 "traits": { 367 "smithy.api#documentation": "<p>Endpoints for accessing the broker.</p>", 368 "smithy.api#jsonName": "endpoints" 369 } 370 } 371 }, 372 "traits": { 373 "smithy.api#documentation": "<p>BrokerNodeInfo</p>" 374 } 375 }, 376 "com.amazonaws.kafka#BrokerSoftwareInfo": { 377 "type": "structure", 378 "members": { 379 "ConfigurationArn": { 380 "target": "com.amazonaws.kafka#__string", 381 "traits": { 382 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.</p>", 383 "smithy.api#jsonName": "configurationArn" 384 } 385 }, 386 "ConfigurationRevision": { 387 "target": "com.amazonaws.kafka#__long", 388 "traits": { 389 "smithy.api#documentation": "<p>The revision of the configuration to use. This field isn't visible in this preview release.</p>", 390 "smithy.api#jsonName": "configurationRevision" 391 } 392 }, 393 "KafkaVersion": { 394 "target": "com.amazonaws.kafka#__string", 395 "traits": { 396 "smithy.api#documentation": "<p>The version of Apache Kafka.</p>", 397 "smithy.api#jsonName": "kafkaVersion" 398 } 399 } 400 }, 401 "traits": { 402 "smithy.api#documentation": "<p>Information about the current software installed on the cluster.</p>" 403 } 404 }, 405 "com.amazonaws.kafka#ClientAuthentication": { 406 "type": "structure", 407 "members": { 408 "Sasl": { 409 "target": "com.amazonaws.kafka#Sasl", 410 "traits": { 411 "smithy.api#documentation": "<p>Details for ClientAuthentication using SASL.</p>", 412 "smithy.api#jsonName": "sasl" 413 } 414 }, 415 "Tls": { 416 "target": "com.amazonaws.kafka#Tls", 417 "traits": { 418 "smithy.api#documentation": "<p>Details for ClientAuthentication using TLS.</p>", 419 "smithy.api#jsonName": "tls" 420 } 421 } 422 }, 423 "traits": { 424 "smithy.api#documentation": "<p>Includes all client authentication information.</p>" 425 } 426 }, 427 "com.amazonaws.kafka#ClientBroker": { 428 "type": "string", 429 "traits": { 430 "smithy.api#documentation": "<p>Client-broker encryption in transit setting.</p>", 431 "smithy.api#enum": [ 432 { 433 "value": "TLS", 434 "name": "TLS" 435 }, 436 { 437 "value": "TLS_PLAINTEXT", 438 "name": "TLS_PLAINTEXT" 439 }, 440 { 441 "value": "PLAINTEXT", 442 "name": "PLAINTEXT" 443 } 444 ] 445 } 446 }, 447 "com.amazonaws.kafka#CloudWatchLogs": { 448 "type": "structure", 449 "members": { 450 "Enabled": { 451 "target": "com.amazonaws.kafka#__boolean", 452 "traits": { 453 "smithy.api#jsonName": "enabled", 454 "smithy.api#required": {} 455 } 456 }, 457 "LogGroup": { 458 "target": "com.amazonaws.kafka#__string", 459 "traits": { 460 "smithy.api#jsonName": "logGroup" 461 } 462 } 463 } 464 }, 465 "com.amazonaws.kafka#ClusterInfo": { 466 "type": "structure", 467 "members": { 468 "ActiveOperationArn": { 469 "target": "com.amazonaws.kafka#__string", 470 "traits": { 471 "smithy.api#documentation": "<p>Arn of active cluster operation.</p>", 472 "smithy.api#jsonName": "activeOperationArn" 473 } 474 }, 475 "BrokerNodeGroupInfo": { 476 "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", 477 "traits": { 478 "smithy.api#documentation": "<p>Information about the broker nodes.</p>", 479 "smithy.api#jsonName": "brokerNodeGroupInfo" 480 } 481 }, 482 "ClientAuthentication": { 483 "target": "com.amazonaws.kafka#ClientAuthentication", 484 "traits": { 485 "smithy.api#documentation": "<p>Includes all client authentication information.</p>", 486 "smithy.api#jsonName": "clientAuthentication" 487 } 488 }, 489 "ClusterArn": { 490 "target": "com.amazonaws.kafka#__string", 491 "traits": { 492 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 493 "smithy.api#jsonName": "clusterArn" 494 } 495 }, 496 "ClusterName": { 497 "target": "com.amazonaws.kafka#__string", 498 "traits": { 499 "smithy.api#documentation": "<p>The name of the cluster.</p>", 500 "smithy.api#jsonName": "clusterName" 501 } 502 }, 503 "CreationTime": { 504 "target": "com.amazonaws.kafka#__timestampIso8601", 505 "traits": { 506 "smithy.api#documentation": "<p>The time when the cluster was created.</p>", 507 "smithy.api#jsonName": "creationTime" 508 } 509 }, 510 "CurrentBrokerSoftwareInfo": { 511 "target": "com.amazonaws.kafka#BrokerSoftwareInfo", 512 "traits": { 513 "smithy.api#documentation": "<p>Information about the version of software currently deployed on the Kafka brokers in the cluster.</p>", 514 "smithy.api#jsonName": "currentBrokerSoftwareInfo" 515 } 516 }, 517 "CurrentVersion": { 518 "target": "com.amazonaws.kafka#__string", 519 "traits": { 520 "smithy.api#documentation": "<p>The current version of the MSK cluster.</p>", 521 "smithy.api#jsonName": "currentVersion" 522 } 523 }, 524 "EncryptionInfo": { 525 "target": "com.amazonaws.kafka#EncryptionInfo", 526 "traits": { 527 "smithy.api#documentation": "<p>Includes all encryption-related information.</p>", 528 "smithy.api#jsonName": "encryptionInfo" 529 } 530 }, 531 "EnhancedMonitoring": { 532 "target": "com.amazonaws.kafka#EnhancedMonitoring", 533 "traits": { 534 "smithy.api#documentation": "<p>Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see <a href=\"https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html\">Monitoring</a>.</p>", 535 "smithy.api#jsonName": "enhancedMonitoring" 536 } 537 }, 538 "OpenMonitoring": { 539 "target": "com.amazonaws.kafka#OpenMonitoring", 540 "traits": { 541 "smithy.api#documentation": "<p>Settings for open monitoring using Prometheus.</p>", 542 "smithy.api#jsonName": "openMonitoring" 543 } 544 }, 545 "LoggingInfo": { 546 "target": "com.amazonaws.kafka#LoggingInfo", 547 "traits": { 548 "smithy.api#jsonName": "loggingInfo" 549 } 550 }, 551 "NumberOfBrokerNodes": { 552 "target": "com.amazonaws.kafka#__integer", 553 "traits": { 554 "smithy.api#documentation": "<p>The number of broker nodes in the cluster.</p>", 555 "smithy.api#jsonName": "numberOfBrokerNodes" 556 } 557 }, 558 "State": { 559 "target": "com.amazonaws.kafka#ClusterState", 560 "traits": { 561 "smithy.api#documentation": "<p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>", 562 "smithy.api#jsonName": "state" 563 } 564 }, 565 "StateInfo": { 566 "target": "com.amazonaws.kafka#StateInfo", 567 "traits": { 568 "smithy.api#jsonName": "stateInfo" 569 } 570 }, 571 "Tags": { 572 "target": "com.amazonaws.kafka#__mapOf__string", 573 "traits": { 574 "smithy.api#documentation": "<p>Tags attached to the cluster.</p>", 575 "smithy.api#jsonName": "tags" 576 } 577 }, 578 "ZookeeperConnectString": { 579 "target": "com.amazonaws.kafka#__string", 580 "traits": { 581 "smithy.api#documentation": "<p>The connection string to use to connect to the Apache ZooKeeper cluster.</p>", 582 "smithy.api#jsonName": "zookeeperConnectString" 583 } 584 }, 585 "ZookeeperConnectStringTls": { 586 "target": "com.amazonaws.kafka#__string", 587 "traits": { 588 "smithy.api#documentation": "<p>The connection string to use to connect to zookeeper cluster on Tls port.</p>", 589 "smithy.api#jsonName": "zookeeperConnectStringTls" 590 } 591 } 592 }, 593 "traits": { 594 "smithy.api#documentation": "<p>Returns information about a cluster.</p>" 595 } 596 }, 597 "com.amazonaws.kafka#ClusterOperationInfo": { 598 "type": "structure", 599 "members": { 600 "ClientRequestId": { 601 "target": "com.amazonaws.kafka#__string", 602 "traits": { 603 "smithy.api#documentation": "<p>The ID of the API request that triggered this operation.</p>", 604 "smithy.api#jsonName": "clientRequestId" 605 } 606 }, 607 "ClusterArn": { 608 "target": "com.amazonaws.kafka#__string", 609 "traits": { 610 "smithy.api#documentation": "<p>ARN of the cluster.</p>", 611 "smithy.api#jsonName": "clusterArn" 612 } 613 }, 614 "CreationTime": { 615 "target": "com.amazonaws.kafka#__timestampIso8601", 616 "traits": { 617 "smithy.api#documentation": "<p>The time that the operation was created.</p>", 618 "smithy.api#jsonName": "creationTime" 619 } 620 }, 621 "EndTime": { 622 "target": "com.amazonaws.kafka#__timestampIso8601", 623 "traits": { 624 "smithy.api#documentation": "<p>The time at which the operation finished.</p>", 625 "smithy.api#jsonName": "endTime" 626 } 627 }, 628 "ErrorInfo": { 629 "target": "com.amazonaws.kafka#ErrorInfo", 630 "traits": { 631 "smithy.api#documentation": "<p>Describes the error if the operation fails.</p>", 632 "smithy.api#jsonName": "errorInfo" 633 } 634 }, 635 "OperationArn": { 636 "target": "com.amazonaws.kafka#__string", 637 "traits": { 638 "smithy.api#documentation": "<p>ARN of the cluster operation.</p>", 639 "smithy.api#jsonName": "operationArn" 640 } 641 }, 642 "OperationState": { 643 "target": "com.amazonaws.kafka#__string", 644 "traits": { 645 "smithy.api#documentation": "<p>State of the cluster operation.</p>", 646 "smithy.api#jsonName": "operationState" 647 } 648 }, 649 "OperationSteps": { 650 "target": "com.amazonaws.kafka#__listOfClusterOperationStep", 651 "traits": { 652 "smithy.api#documentation": "<p>Steps completed during the operation.</p>", 653 "smithy.api#jsonName": "operationSteps" 654 } 655 }, 656 "OperationType": { 657 "target": "com.amazonaws.kafka#__string", 658 "traits": { 659 "smithy.api#documentation": "<p>Type of the cluster operation.</p>", 660 "smithy.api#jsonName": "operationType" 661 } 662 }, 663 "SourceClusterInfo": { 664 "target": "com.amazonaws.kafka#MutableClusterInfo", 665 "traits": { 666 "smithy.api#documentation": "<p>Information about cluster attributes before a cluster is updated.</p>", 667 "smithy.api#jsonName": "sourceClusterInfo" 668 } 669 }, 670 "TargetClusterInfo": { 671 "target": "com.amazonaws.kafka#MutableClusterInfo", 672 "traits": { 673 "smithy.api#documentation": "<p>Information about cluster attributes after a cluster is updated.</p>", 674 "smithy.api#jsonName": "targetClusterInfo" 675 } 676 } 677 }, 678 "traits": { 679 "smithy.api#documentation": "<p>Returns information about a cluster operation.</p>" 680 } 681 }, 682 "com.amazonaws.kafka#ClusterOperationStep": { 683 "type": "structure", 684 "members": { 685 "StepInfo": { 686 "target": "com.amazonaws.kafka#ClusterOperationStepInfo", 687 "traits": { 688 "smithy.api#documentation": "<p>Information about the step and its status.</p>", 689 "smithy.api#jsonName": "stepInfo" 690 } 691 }, 692 "StepName": { 693 "target": "com.amazonaws.kafka#__string", 694 "traits": { 695 "smithy.api#documentation": "<p>The name of the step.</p>", 696 "smithy.api#jsonName": "stepName" 697 } 698 } 699 }, 700 "traits": { 701 "smithy.api#documentation": "<p>Step taken during a cluster operation.</p>" 702 } 703 }, 704 "com.amazonaws.kafka#ClusterOperationStepInfo": { 705 "type": "structure", 706 "members": { 707 "StepStatus": { 708 "target": "com.amazonaws.kafka#__string", 709 "traits": { 710 "smithy.api#documentation": "<p>The steps current status.</p>", 711 "smithy.api#jsonName": "stepStatus" 712 } 713 } 714 }, 715 "traits": { 716 "smithy.api#documentation": "<p>State information about the operation step.</p>" 717 } 718 }, 719 "com.amazonaws.kafka#ClusterState": { 720 "type": "string", 721 "traits": { 722 "smithy.api#documentation": "<p>The state of a Kafka cluster.</p>", 723 "smithy.api#enum": [ 724 { 725 "value": "ACTIVE", 726 "name": "ACTIVE" 727 }, 728 { 729 "value": "CREATING", 730 "name": "CREATING" 731 }, 732 { 733 "value": "DELETING", 734 "name": "DELETING" 735 }, 736 { 737 "value": "FAILED", 738 "name": "FAILED" 739 }, 740 { 741 "value": "HEALING", 742 "name": "HEALING" 743 }, 744 { 745 "value": "MAINTENANCE", 746 "name": "MAINTENANCE" 747 }, 748 { 749 "value": "REBOOTING_BROKER", 750 "name": "REBOOTING_BROKER" 751 }, 752 { 753 "value": "UPDATING", 754 "name": "UPDATING" 755 } 756 ] 757 } 758 }, 759 "com.amazonaws.kafka#CompatibleKafkaVersion": { 760 "type": "structure", 761 "members": { 762 "SourceVersion": { 763 "target": "com.amazonaws.kafka#__string", 764 "traits": { 765 "smithy.api#documentation": "<p>A Kafka version.</p>", 766 "smithy.api#jsonName": "sourceVersion" 767 } 768 }, 769 "TargetVersions": { 770 "target": "com.amazonaws.kafka#__listOf__string", 771 "traits": { 772 "smithy.api#documentation": "<p>A list of Kafka versions.</p>", 773 "smithy.api#jsonName": "targetVersions" 774 } 775 } 776 }, 777 "traits": { 778 "smithy.api#documentation": "<p>Contains source Kafka versions and compatible target Kafka versions.</p>" 779 } 780 }, 781 "com.amazonaws.kafka#Configuration": { 782 "type": "structure", 783 "members": { 784 "Arn": { 785 "target": "com.amazonaws.kafka#__string", 786 "traits": { 787 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the configuration.</p>", 788 "smithy.api#jsonName": "arn", 789 "smithy.api#required": {} 790 } 791 }, 792 "CreationTime": { 793 "target": "com.amazonaws.kafka#__timestampIso8601", 794 "traits": { 795 "smithy.api#documentation": "<p>The time when the configuration was created.</p>", 796 "smithy.api#jsonName": "creationTime", 797 "smithy.api#required": {} 798 } 799 }, 800 "Description": { 801 "target": "com.amazonaws.kafka#__string", 802 "traits": { 803 "smithy.api#documentation": "<p>The description of the configuration.</p>", 804 "smithy.api#jsonName": "description", 805 "smithy.api#required": {} 806 } 807 }, 808 "KafkaVersions": { 809 "target": "com.amazonaws.kafka#__listOf__string", 810 "traits": { 811 "smithy.api#documentation": "<p>An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.</p>", 812 "smithy.api#jsonName": "kafkaVersions", 813 "smithy.api#required": {} 814 } 815 }, 816 "LatestRevision": { 817 "target": "com.amazonaws.kafka#ConfigurationRevision", 818 "traits": { 819 "smithy.api#documentation": "<p>Latest revision of the configuration.</p>", 820 "smithy.api#jsonName": "latestRevision", 821 "smithy.api#required": {} 822 } 823 }, 824 "Name": { 825 "target": "com.amazonaws.kafka#__string", 826 "traits": { 827 "smithy.api#documentation": "<p>The name of the configuration.</p>", 828 "smithy.api#jsonName": "name", 829 "smithy.api#required": {} 830 } 831 }, 832 "State": { 833 "target": "com.amazonaws.kafka#ConfigurationState", 834 "traits": { 835 "smithy.api#documentation": "<p>The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. </p>", 836 "smithy.api#jsonName": "state", 837 "smithy.api#required": {} 838 } 839 } 840 }, 841 "traits": { 842 "smithy.api#documentation": "<p>Represents an MSK Configuration.</p>" 843 } 844 }, 845 "com.amazonaws.kafka#ConfigurationInfo": { 846 "type": "structure", 847 "members": { 848 "Arn": { 849 "target": "com.amazonaws.kafka#__string", 850 "traits": { 851 "smithy.api#documentation": "<p>ARN of the configuration to use.</p>", 852 "smithy.api#jsonName": "arn", 853 "smithy.api#required": {} 854 } 855 }, 856 "Revision": { 857 "target": "com.amazonaws.kafka#__long", 858 "traits": { 859 "smithy.api#documentation": "<p>The revision of the configuration to use.</p>", 860 "smithy.api#jsonName": "revision", 861 "smithy.api#required": {} 862 } 863 } 864 }, 865 "traits": { 866 "smithy.api#documentation": "<p>Specifies the configuration to use for the brokers.</p>" 867 } 868 }, 869 "com.amazonaws.kafka#ConfigurationRevision": { 870 "type": "structure", 871 "members": { 872 "CreationTime": { 873 "target": "com.amazonaws.kafka#__timestampIso8601", 874 "traits": { 875 "smithy.api#documentation": "<p>The time when the configuration revision was created.</p>", 876 "smithy.api#jsonName": "creationTime", 877 "smithy.api#required": {} 878 } 879 }, 880 "Description": { 881 "target": "com.amazonaws.kafka#__string", 882 "traits": { 883 "smithy.api#documentation": "<p>The description of the configuration revision.</p>", 884 "smithy.api#jsonName": "description" 885 } 886 }, 887 "Revision": { 888 "target": "com.amazonaws.kafka#__long", 889 "traits": { 890 "smithy.api#documentation": "<p>The revision number.</p>", 891 "smithy.api#jsonName": "revision", 892 "smithy.api#required": {} 893 } 894 } 895 }, 896 "traits": { 897 "smithy.api#documentation": "<p>Describes a configuration revision.</p>" 898 } 899 }, 900 "com.amazonaws.kafka#ConfigurationState": { 901 "type": "string", 902 "traits": { 903 "smithy.api#documentation": "<p>The state of a configuration.</p>", 904 "smithy.api#enum": [ 905 { 906 "value": "ACTIVE", 907 "name": "ACTIVE" 908 }, 909 { 910 "value": "DELETING", 911 "name": "DELETING" 912 }, 913 { 914 "value": "DELETE_FAILED", 915 "name": "DELETE_FAILED" 916 } 917 ] 918 } 919 }, 920 "com.amazonaws.kafka#ConflictException": { 921 "type": "structure", 922 "members": { 923 "InvalidParameter": { 924 "target": "com.amazonaws.kafka#__string", 925 "traits": { 926 "smithy.api#documentation": "<p>The parameter that caused the error.</p>", 927 "smithy.api#jsonName": "invalidParameter" 928 } 929 }, 930 "Message": { 931 "target": "com.amazonaws.kafka#__string", 932 "traits": { 933 "smithy.api#documentation": "<p>The description of the error.</p>", 934 "smithy.api#jsonName": "message" 935 } 936 } 937 }, 938 "traits": { 939 "smithy.api#documentation": "<p>Returns information about an error.</p>", 940 "smithy.api#error": "client", 941 "smithy.api#httpError": 409 942 } 943 }, 944 "com.amazonaws.kafka#CreateCluster": { 945 "type": "operation", 946 "input": { 947 "target": "com.amazonaws.kafka#CreateClusterRequest" 948 }, 949 "output": { 950 "target": "com.amazonaws.kafka#CreateClusterResponse" 951 }, 952 "errors": [ 953 { 954 "target": "com.amazonaws.kafka#BadRequestException" 955 }, 956 { 957 "target": "com.amazonaws.kafka#ConflictException" 958 }, 959 { 960 "target": "com.amazonaws.kafka#ForbiddenException" 961 }, 962 { 963 "target": "com.amazonaws.kafka#InternalServerErrorException" 964 }, 965 { 966 "target": "com.amazonaws.kafka#ServiceUnavailableException" 967 }, 968 { 969 "target": "com.amazonaws.kafka#TooManyRequestsException" 970 }, 971 { 972 "target": "com.amazonaws.kafka#UnauthorizedException" 973 } 974 ], 975 "traits": { 976 "smithy.api#documentation": "<p>Creates a new MSK cluster.</p>", 977 "smithy.api#http": { 978 "method": "POST", 979 "uri": "/v1/clusters", 980 "code": 200 981 } 982 } 983 }, 984 "com.amazonaws.kafka#CreateClusterRequest": { 985 "type": "structure", 986 "members": { 987 "BrokerNodeGroupInfo": { 988 "target": "com.amazonaws.kafka#BrokerNodeGroupInfo", 989 "traits": { 990 "smithy.api#documentation": "<p>Information about the broker nodes in the cluster.</p>", 991 "smithy.api#jsonName": "brokerNodeGroupInfo", 992 "smithy.api#required": {} 993 } 994 }, 995 "ClientAuthentication": { 996 "target": "com.amazonaws.kafka#ClientAuthentication", 997 "traits": { 998 "smithy.api#documentation": "<p>Includes all client authentication related information.</p>", 999 "smithy.api#jsonName": "clientAuthentication" 1000 } 1001 }, 1002 "ClusterName": { 1003 "target": "com.amazonaws.kafka#__stringMin1Max64", 1004 "traits": { 1005 "smithy.api#documentation": "<p>The name of the cluster.</p>", 1006 "smithy.api#jsonName": "clusterName", 1007 "smithy.api#required": {} 1008 } 1009 }, 1010 "ConfigurationInfo": { 1011 "target": "com.amazonaws.kafka#ConfigurationInfo", 1012 "traits": { 1013 "smithy.api#documentation": "<p>Represents the configuration that you want MSK to use for the brokers in a cluster.</p>", 1014 "smithy.api#jsonName": "configurationInfo" 1015 } 1016 }, 1017 "EncryptionInfo": { 1018 "target": "com.amazonaws.kafka#EncryptionInfo", 1019 "traits": { 1020 "smithy.api#documentation": "<p>Includes all encryption-related information.</p>", 1021 "smithy.api#jsonName": "encryptionInfo" 1022 } 1023 }, 1024 "EnhancedMonitoring": { 1025 "target": "com.amazonaws.kafka#EnhancedMonitoring", 1026 "traits": { 1027 "smithy.api#documentation": "<p>Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.</p>", 1028 "smithy.api#jsonName": "enhancedMonitoring" 1029 } 1030 }, 1031 "OpenMonitoring": { 1032 "target": "com.amazonaws.kafka#OpenMonitoringInfo", 1033 "traits": { 1034 "smithy.api#documentation": "<p>The settings for open monitoring.</p>", 1035 "smithy.api#jsonName": "openMonitoring" 1036 } 1037 }, 1038 "KafkaVersion": { 1039 "target": "com.amazonaws.kafka#__stringMin1Max128", 1040 "traits": { 1041 "smithy.api#documentation": "<p>The version of Apache Kafka.</p>", 1042 "smithy.api#jsonName": "kafkaVersion", 1043 "smithy.api#required": {} 1044 } 1045 }, 1046 "LoggingInfo": { 1047 "target": "com.amazonaws.kafka#LoggingInfo", 1048 "traits": { 1049 "smithy.api#jsonName": "loggingInfo" 1050 } 1051 }, 1052 "NumberOfBrokerNodes": { 1053 "target": "com.amazonaws.kafka#__integerMin1Max15", 1054 "traits": { 1055 "smithy.api#documentation": "<p>The number of broker nodes in the cluster.</p>", 1056 "smithy.api#jsonName": "numberOfBrokerNodes", 1057 "smithy.api#required": {} 1058 } 1059 }, 1060 "Tags": { 1061 "target": "com.amazonaws.kafka#__mapOf__string", 1062 "traits": { 1063 "smithy.api#documentation": "<p>Create tags when creating the cluster.</p>", 1064 "smithy.api#jsonName": "tags" 1065 } 1066 } 1067 } 1068 }, 1069 "com.amazonaws.kafka#CreateClusterResponse": { 1070 "type": "structure", 1071 "members": { 1072 "ClusterArn": { 1073 "target": "com.amazonaws.kafka#__string", 1074 "traits": { 1075 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 1076 "smithy.api#jsonName": "clusterArn" 1077 } 1078 }, 1079 "ClusterName": { 1080 "target": "com.amazonaws.kafka#__string", 1081 "traits": { 1082 "smithy.api#documentation": "<p>The name of the MSK cluster.</p>", 1083 "smithy.api#jsonName": "clusterName" 1084 } 1085 }, 1086 "State": { 1087 "target": "com.amazonaws.kafka#ClusterState", 1088 "traits": { 1089 "smithy.api#documentation": "<p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>", 1090 "smithy.api#jsonName": "state" 1091 } 1092 } 1093 } 1094 }, 1095 "com.amazonaws.kafka#CreateConfiguration": { 1096 "type": "operation", 1097 "input": { 1098 "target": "com.amazonaws.kafka#CreateConfigurationRequest" 1099 }, 1100 "output": { 1101 "target": "com.amazonaws.kafka#CreateConfigurationResponse" 1102 }, 1103 "errors": [ 1104 { 1105 "target": "com.amazonaws.kafka#BadRequestException" 1106 }, 1107 { 1108 "target": "com.amazonaws.kafka#ConflictException" 1109 }, 1110 { 1111 "target": "com.amazonaws.kafka#ForbiddenException" 1112 }, 1113 { 1114 "target": "com.amazonaws.kafka#InternalServerErrorException" 1115 }, 1116 { 1117 "target": "com.amazonaws.kafka#ServiceUnavailableException" 1118 }, 1119 { 1120 "target": "com.amazonaws.kafka#TooManyRequestsException" 1121 }, 1122 { 1123 "target": "com.amazonaws.kafka#UnauthorizedException" 1124 } 1125 ], 1126 "traits": { 1127 "smithy.api#documentation": "<p>Creates a new MSK configuration.</p>", 1128 "smithy.api#http": { 1129 "method": "POST", 1130 "uri": "/v1/configurations", 1131 "code": 200 1132 } 1133 } 1134 }, 1135 "com.amazonaws.kafka#CreateConfigurationRequest": { 1136 "type": "structure", 1137 "members": { 1138 "Description": { 1139 "target": "com.amazonaws.kafka#__string", 1140 "traits": { 1141 "smithy.api#documentation": "<p>The description of the configuration.</p>", 1142 "smithy.api#jsonName": "description" 1143 } 1144 }, 1145 "KafkaVersions": { 1146 "target": "com.amazonaws.kafka#__listOf__string", 1147 "traits": { 1148 "smithy.api#documentation": "<p>The versions of Apache Kafka with which you can use this MSK configuration.</p>", 1149 "smithy.api#jsonName": "kafkaVersions" 1150 } 1151 }, 1152 "Name": { 1153 "target": "com.amazonaws.kafka#__string", 1154 "traits": { 1155 "smithy.api#documentation": "<p>The name of the configuration.</p>", 1156 "smithy.api#jsonName": "name", 1157 "smithy.api#required": {} 1158 } 1159 }, 1160 "ServerProperties": { 1161 "target": "com.amazonaws.kafka#__blob", 1162 "traits": { 1163 "smithy.api#documentation": "<p>Contents of the <filename>server.properties</filename> file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of <filename>server.properties</filename> can be in plaintext.</p>", 1164 "smithy.api#jsonName": "serverProperties", 1165 "smithy.api#required": {} 1166 } 1167 } 1168 } 1169 }, 1170 "com.amazonaws.kafka#CreateConfigurationResponse": { 1171 "type": "structure", 1172 "members": { 1173 "Arn": { 1174 "target": "com.amazonaws.kafka#__string", 1175 "traits": { 1176 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the configuration.</p>", 1177 "smithy.api#jsonName": "arn" 1178 } 1179 }, 1180 "CreationTime": { 1181 "target": "com.amazonaws.kafka#__timestampIso8601", 1182 "traits": { 1183 "smithy.api#documentation": "<p>The time when the configuration was created.</p>", 1184 "smithy.api#jsonName": "creationTime" 1185 } 1186 }, 1187 "LatestRevision": { 1188 "target": "com.amazonaws.kafka#ConfigurationRevision", 1189 "traits": { 1190 "smithy.api#documentation": "<p>Latest revision of the configuration.</p>", 1191 "smithy.api#jsonName": "latestRevision" 1192 } 1193 }, 1194 "Name": { 1195 "target": "com.amazonaws.kafka#__string", 1196 "traits": { 1197 "smithy.api#documentation": "<p>The name of the configuration.</p>", 1198 "smithy.api#jsonName": "name" 1199 } 1200 }, 1201 "State": { 1202 "target": "com.amazonaws.kafka#ConfigurationState", 1203 "traits": { 1204 "smithy.api#documentation": "<p>The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. </p>", 1205 "smithy.api#jsonName": "state" 1206 } 1207 } 1208 } 1209 }, 1210 "com.amazonaws.kafka#DeleteCluster": { 1211 "type": "operation", 1212 "input": { 1213 "target": "com.amazonaws.kafka#DeleteClusterRequest" 1214 }, 1215 "output": { 1216 "target": "com.amazonaws.kafka#DeleteClusterResponse" 1217 }, 1218 "errors": [ 1219 { 1220 "target": "com.amazonaws.kafka#BadRequestException" 1221 }, 1222 { 1223 "target": "com.amazonaws.kafka#ForbiddenException" 1224 }, 1225 { 1226 "target": "com.amazonaws.kafka#InternalServerErrorException" 1227 }, 1228 { 1229 "target": "com.amazonaws.kafka#NotFoundException" 1230 } 1231 ], 1232 "traits": { 1233 "smithy.api#documentation": "<p>Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.</p>", 1234 "smithy.api#http": { 1235 "method": "DELETE", 1236 "uri": "/v1/clusters/{ClusterArn}", 1237 "code": 200 1238 } 1239 } 1240 }, 1241 "com.amazonaws.kafka#DeleteClusterRequest": { 1242 "type": "structure", 1243 "members": { 1244 "ClusterArn": { 1245 "target": "com.amazonaws.kafka#__string", 1246 "traits": { 1247 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 1248 "smithy.api#httpLabel": {}, 1249 "smithy.api#required": {} 1250 } 1251 }, 1252 "CurrentVersion": { 1253 "target": "com.amazonaws.kafka#__string", 1254 "traits": { 1255 "smithy.api#documentation": "<p>The current version of the MSK cluster.</p>", 1256 "smithy.api#httpQuery": "currentVersion" 1257 } 1258 } 1259 } 1260 }, 1261 "com.amazonaws.kafka#DeleteClusterResponse": { 1262 "type": "structure", 1263 "members": { 1264 "ClusterArn": { 1265 "target": "com.amazonaws.kafka#__string", 1266 "traits": { 1267 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 1268 "smithy.api#jsonName": "clusterArn" 1269 } 1270 }, 1271 "State": { 1272 "target": "com.amazonaws.kafka#ClusterState", 1273 "traits": { 1274 "smithy.api#documentation": "<p>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</p>", 1275 "smithy.api#jsonName": "state" 1276 } 1277 } 1278 } 1279 }, 1280 "com.amazonaws.kafka#DeleteConfiguration": { 1281 "type": "operation", 1282 "input": { 1283 "target": "com.amazonaws.kafka#DeleteConfigurationRequest" 1284 }, 1285 "output": { 1286 "target": "com.amazonaws.kafka#DeleteConfigurationResponse" 1287 }, 1288 "errors": [ 1289 { 1290 "target": "com.amazonaws.kafka#BadRequestException" 1291 }, 1292 { 1293 "target": "com.amazonaws.kafka#ForbiddenException" 1294 }, 1295 { 1296 "target": "com.amazonaws.kafka#InternalServerErrorException" 1297 }, 1298 { 1299 "target": "com.amazonaws.kafka#NotFoundException" 1300 } 1301 ], 1302 "traits": { 1303 "smithy.api#documentation": "<p>Deletes an MSK Configuration.</p>", 1304 "smithy.api#http": { 1305 "method": "DELETE", 1306 "uri": "/v1/configurations/{Arn}", 1307 "code": 200 1308 } 1309 } 1310 }, 1311 "com.amazonaws.kafka#DeleteConfigurationRequest": { 1312 "type": "structure", 1313 "members": { 1314 "Arn": { 1315 "target": "com.amazonaws.kafka#__string", 1316 "traits": { 1317 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.</p>", 1318 "smithy.api#httpLabel": {}, 1319 "smithy.api#required": {} 1320 } 1321 } 1322 } 1323 }, 1324 "com.amazonaws.kafka#DeleteConfigurationResponse": { 1325 "type": "structure", 1326 "members": { 1327 "Arn": { 1328 "target": "com.amazonaws.kafka#__string", 1329 "traits": { 1330 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration.</p>", 1331 "smithy.api#jsonName": "arn" 1332 } 1333 }, 1334 "State": { 1335 "target": "com.amazonaws.kafka#ConfigurationState", 1336 "traits": { 1337 "smithy.api#documentation": "<p>The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. </p>", 1338 "smithy.api#jsonName": "state" 1339 } 1340 } 1341 } 1342 }, 1343 "com.amazonaws.kafka#DescribeCluster": { 1344 "type": "operation", 1345 "input": { 1346 "target": "com.amazonaws.kafka#DescribeClusterRequest" 1347 }, 1348 "output": { 1349 "target": "com.amazonaws.kafka#DescribeClusterResponse" 1350 }, 1351 "errors": [ 1352 { 1353 "target": "com.amazonaws.kafka#BadRequestException" 1354 }, 1355 { 1356 "target": "com.amazonaws.kafka#ForbiddenException" 1357 }, 1358 { 1359 "target": "com.amazonaws.kafka#InternalServerErrorException" 1360 }, 1361 { 1362 "target": "com.amazonaws.kafka#NotFoundException" 1363 }, 1364 { 1365 "target": "com.amazonaws.kafka#UnauthorizedException" 1366 } 1367 ], 1368 "traits": { 1369 "smithy.api#documentation": "<p>Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.</p>", 1370 "smithy.api#http": { 1371 "method": "GET", 1372 "uri": "/v1/clusters/{ClusterArn}", 1373 "code": 200 1374 } 1375 } 1376 }, 1377 "com.amazonaws.kafka#DescribeClusterOperation": { 1378 "type": "operation", 1379 "input": { 1380 "target": "com.amazonaws.kafka#DescribeClusterOperationRequest" 1381 }, 1382 "output": { 1383 "target": "com.amazonaws.kafka#DescribeClusterOperationResponse" 1384 }, 1385 "errors": [ 1386 { 1387 "target": "com.amazonaws.kafka#BadRequestException" 1388 }, 1389 { 1390 "target": "com.amazonaws.kafka#ForbiddenException" 1391 }, 1392 { 1393 "target": "com.amazonaws.kafka#InternalServerErrorException" 1394 }, 1395 { 1396 "target": "com.amazonaws.kafka#NotFoundException" 1397 }, 1398 { 1399 "target": "com.amazonaws.kafka#UnauthorizedException" 1400 } 1401 ], 1402 "traits": { 1403 "smithy.api#documentation": "<p>Returns a description of the cluster operation specified by the ARN.</p>", 1404 "smithy.api#http": { 1405 "method": "GET", 1406 "uri": "/v1/operations/{ClusterOperationArn}", 1407 "code": 200 1408 } 1409 } 1410 }, 1411 "com.amazonaws.kafka#DescribeClusterOperationRequest": { 1412 "type": "structure", 1413 "members": { 1414 "ClusterOperationArn": { 1415 "target": "com.amazonaws.kafka#__string", 1416 "traits": { 1417 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.</p>", 1418 "smithy.api#httpLabel": {}, 1419 "smithy.api#required": {} 1420 } 1421 } 1422 } 1423 }, 1424 "com.amazonaws.kafka#DescribeClusterOperationResponse": { 1425 "type": "structure", 1426 "members": { 1427 "ClusterOperationInfo": { 1428 "target": "com.amazonaws.kafka#ClusterOperationInfo", 1429 "traits": { 1430 "smithy.api#documentation": "<p>Cluster operation information</p>", 1431 "smithy.api#jsonName": "clusterOperationInfo" 1432 } 1433 } 1434 } 1435 }, 1436 "com.amazonaws.kafka#DescribeClusterRequest": { 1437 "type": "structure", 1438 "members": { 1439 "ClusterArn": { 1440 "target": "com.amazonaws.kafka#__string", 1441 "traits": { 1442 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 1443 "smithy.api#httpLabel": {}, 1444 "smithy.api#required": {} 1445 } 1446 } 1447 } 1448 }, 1449 "com.amazonaws.kafka#DescribeClusterResponse": { 1450 "type": "structure", 1451 "members": { 1452 "ClusterInfo": { 1453 "target": "com.amazonaws.kafka#ClusterInfo", 1454 "traits": { 1455 "smithy.api#documentation": "<p>The cluster information.</p>", 1456 "smithy.api#jsonName": "clusterInfo" 1457 } 1458 } 1459 } 1460 }, 1461 "com.amazonaws.kafka#DescribeConfiguration": { 1462 "type": "operation", 1463 "input": { 1464 "target": "com.amazonaws.kafka#DescribeConfigurationRequest" 1465 }, 1466 "output": { 1467 "target": "com.amazonaws.kafka#DescribeConfigurationResponse" 1468 }, 1469 "errors": [ 1470 { 1471 "target": "com.amazonaws.kafka#BadRequestException" 1472 }, 1473 { 1474 "target": "com.amazonaws.kafka#ForbiddenException" 1475 }, 1476 { 1477 "target": "com.amazonaws.kafka#InternalServerErrorException" 1478 }, 1479 { 1480 "target": "com.amazonaws.kafka#NotFoundException" 1481 }, 1482 { 1483 "target": "com.amazonaws.kafka#ServiceUnavailableException" 1484 }, 1485 { 1486 "target": "com.amazonaws.kafka#UnauthorizedException" 1487 } 1488 ], 1489 "traits": { 1490 "smithy.api#documentation": "<p>Returns a description of this MSK configuration.</p>", 1491 "smithy.api#http": { 1492 "method": "GET", 1493 "uri": "/v1/configurations/{Arn}", 1494 "code": 200 1495 } 1496 } 1497 }, 1498 "com.amazonaws.kafka#DescribeConfigurationRequest": { 1499 "type": "structure", 1500 "members": { 1501 "Arn": { 1502 "target": "com.amazonaws.kafka#__string", 1503 "traits": { 1504 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</p>", 1505 "smithy.api#httpLabel": {}, 1506 "smithy.api#required": {} 1507 } 1508 } 1509 } 1510 }, 1511 "com.amazonaws.kafka#DescribeConfigurationResponse": { 1512 "type": "structure", 1513 "members": { 1514 "Arn": { 1515 "target": "com.amazonaws.kafka#__string", 1516 "traits": { 1517 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the configuration.</p>", 1518 "smithy.api#jsonName": "arn" 1519 } 1520 }, 1521 "CreationTime": { 1522 "target": "com.amazonaws.kafka#__timestampIso8601", 1523 "traits": { 1524 "smithy.api#documentation": "<p>The time when the configuration was created.</p>", 1525 "smithy.api#jsonName": "creationTime" 1526 } 1527 }, 1528 "Description": { 1529 "target": "com.amazonaws.kafka#__string", 1530 "traits": { 1531 "smithy.api#documentation": "<p>The description of the configuration.</p>", 1532 "smithy.api#jsonName": "description" 1533 } 1534 }, 1535 "KafkaVersions": { 1536 "target": "com.amazonaws.kafka#__listOf__string", 1537 "traits": { 1538 "smithy.api#documentation": "<p>The versions of Apache Kafka with which you can use this MSK configuration.</p>", 1539 "smithy.api#jsonName": "kafkaVersions" 1540 } 1541 }, 1542 "LatestRevision": { 1543 "target": "com.amazonaws.kafka#ConfigurationRevision", 1544 "traits": { 1545 "smithy.api#documentation": "<p>Latest revision of the configuration.</p>", 1546 "smithy.api#jsonName": "latestRevision" 1547 } 1548 }, 1549 "Name": { 1550 "target": "com.amazonaws.kafka#__string", 1551 "traits": { 1552 "smithy.api#documentation": "<p>The name of the configuration.</p>", 1553 "smithy.api#jsonName": "name" 1554 } 1555 }, 1556 "State": { 1557 "target": "com.amazonaws.kafka#ConfigurationState", 1558 "traits": { 1559 "smithy.api#documentation": "<p>The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED. </p>", 1560 "smithy.api#jsonName": "state" 1561 } 1562 } 1563 } 1564 }, 1565 "com.amazonaws.kafka#DescribeConfigurationRevision": { 1566 "type": "operation", 1567 "input": { 1568 "target": "com.amazonaws.kafka#DescribeConfigurationRevisionRequest" 1569 }, 1570 "output": { 1571 "target": "com.amazonaws.kafka#DescribeConfigurationRevisionResponse" 1572 }, 1573 "errors": [ 1574 { 1575 "target": "com.amazonaws.kafka#BadRequestException" 1576 }, 1577 { 1578 "target": "com.amazonaws.kafka#ForbiddenException" 1579 }, 1580 { 1581 "target": "com.amazonaws.kafka#InternalServerErrorException" 1582 }, 1583 { 1584 "target": "com.amazonaws.kafka#NotFoundException" 1585 }, 1586 { 1587 "target": "com.amazonaws.kafka#ServiceUnavailableException" 1588 }, 1589 { 1590 "target": "com.amazonaws.kafka#UnauthorizedException" 1591 } 1592 ], 1593 "traits": { 1594 "smithy.api#documentation": "<p>Returns a description of this revision of the configuration.</p>", 1595 "smithy.api#http": { 1596 "method": "GET", 1597 "uri": "/v1/configurations/{Arn}/revisions/{Revision}", 1598 "code": 200 1599 } 1600 } 1601 }, 1602 "com.amazonaws.kafka#DescribeConfigurationRevisionRequest": { 1603 "type": "structure", 1604 "members": { 1605 "Arn": { 1606 "target": "com.amazonaws.kafka#__string", 1607 "traits": { 1608 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</p>", 1609 "smithy.api#httpLabel": {}, 1610 "smithy.api#required": {} 1611 } 1612 }, 1613 "Revision": { 1614 "target": "com.amazonaws.kafka#__long", 1615 "traits": { 1616 "smithy.api#documentation": "<p>A string that uniquely identifies a revision of an MSK configuration.</p>", 1617 "smithy.api#httpLabel": {}, 1618 "smithy.api#required": {} 1619 } 1620 } 1621 } 1622 }, 1623 "com.amazonaws.kafka#DescribeConfigurationRevisionResponse": { 1624 "type": "structure", 1625 "members": { 1626 "Arn": { 1627 "target": "com.amazonaws.kafka#__string", 1628 "traits": { 1629 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the configuration.</p>", 1630 "smithy.api#jsonName": "arn" 1631 } 1632 }, 1633 "CreationTime": { 1634 "target": "com.amazonaws.kafka#__timestampIso8601", 1635 "traits": { 1636 "smithy.api#documentation": "<p>The time when the configuration was created.</p>", 1637 "smithy.api#jsonName": "creationTime" 1638 } 1639 }, 1640 "Description": { 1641 "target": "com.amazonaws.kafka#__string", 1642 "traits": { 1643 "smithy.api#documentation": "<p>The description of the configuration.</p>", 1644 "smithy.api#jsonName": "description" 1645 } 1646 }, 1647 "Revision": { 1648 "target": "com.amazonaws.kafka#__long", 1649 "traits": { 1650 "smithy.api#documentation": "<p>The revision number.</p>", 1651 "smithy.api#jsonName": "revision" 1652 } 1653 }, 1654 "ServerProperties": { 1655 "target": "com.amazonaws.kafka#__blob", 1656 "traits": { 1657 "smithy.api#documentation": "<p>Contents of the <filename>server.properties</filename> file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of <filename>server.properties</filename> can be in plaintext.</p>", 1658 "smithy.api#jsonName": "serverProperties" 1659 } 1660 } 1661 } 1662 }, 1663 "com.amazonaws.kafka#EBSStorageInfo": { 1664 "type": "structure", 1665 "members": { 1666 "VolumeSize": { 1667 "target": "com.amazonaws.kafka#__integerMin1Max16384", 1668 "traits": { 1669 "smithy.api#documentation": "<p>The size in GiB of the EBS volume for the data drive on each broker node.</p>", 1670 "smithy.api#jsonName": "volumeSize" 1671 } 1672 } 1673 }, 1674 "traits": { 1675 "smithy.api#documentation": "<p>Contains information about the EBS storage volumes attached to Kafka broker nodes.</p>" 1676 } 1677 }, 1678 "com.amazonaws.kafka#EncryptionAtRest": { 1679 "type": "structure", 1680 "members": { 1681 "DataVolumeKMSKeyId": { 1682 "target": "com.amazonaws.kafka#__string", 1683 "traits": { 1684 "smithy.api#documentation": "<p>The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.</p>", 1685 "smithy.api#jsonName": "dataVolumeKMSKeyId", 1686 "smithy.api#required": {} 1687 } 1688 } 1689 }, 1690 "traits": { 1691 "smithy.api#documentation": "<p>The data-volume encryption details.</p>" 1692 } 1693 }, 1694 "com.amazonaws.kafka#EncryptionInTransit": { 1695 "type": "structure", 1696 "members": { 1697 "ClientBroker": { 1698 "target": "com.amazonaws.kafka#ClientBroker", 1699 "traits": { 1700 "smithy.api#documentation": "<p>Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.</p>\n <p>\n TLS means that client-broker communication is enabled with TLS only.</p>\n <p>\n TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.</p>\n <p>\n PLAINTEXT means that client-broker communication is enabled in plaintext only.</p>\n <p>The default value is TLS_PLAINTEXT.</p>", 1701 "smithy.api#jsonName": "clientBroker" 1702 } 1703 }, 1704 "InCluster": { 1705 "target": "com.amazonaws.kafka#__boolean", 1706 "traits": { 1707 "smithy.api#documentation": "<p>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.</p>\n <p>The default value is true.</p>", 1708 "smithy.api#jsonName": "inCluster" 1709 } 1710 } 1711 }, 1712 "traits": { 1713 "smithy.api#documentation": "<p>The settings for encrypting data in transit.</p>" 1714 } 1715 }, 1716 "com.amazonaws.kafka#EncryptionInfo": { 1717 "type": "structure", 1718 "members": { 1719 "EncryptionAtRest": { 1720 "target": "com.amazonaws.kafka#EncryptionAtRest", 1721 "traits": { 1722 "smithy.api#documentation": "<p>The data-volume encryption details.</p>", 1723 "smithy.api#jsonName": "encryptionAtRest" 1724 } 1725 }, 1726 "EncryptionInTransit": { 1727 "target": "com.amazonaws.kafka#EncryptionInTransit", 1728 "traits": { 1729 "smithy.api#documentation": "<p>The details for encryption in transit.</p>", 1730 "smithy.api#jsonName": "encryptionInTransit" 1731 } 1732 } 1733 }, 1734 "traits": { 1735 "smithy.api#documentation": "<p>Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.</p>" 1736 } 1737 }, 1738 "com.amazonaws.kafka#EnhancedMonitoring": { 1739 "type": "string", 1740 "traits": { 1741 "smithy.api#documentation": "<p>Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see <a href=\"https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html\">Monitoring</a>.</p>", 1742 "smithy.api#enum": [ 1743 { 1744 "value": "DEFAULT", 1745 "name": "DEFAULT" 1746 }, 1747 { 1748 "value": "PER_BROKER", 1749 "name": "PER_BROKER" 1750 }, 1751 { 1752 "value": "PER_TOPIC_PER_BROKER", 1753 "name": "PER_TOPIC_PER_BROKER" 1754 }, 1755 { 1756 "value": "PER_TOPIC_PER_PARTITION", 1757 "name": "PER_TOPIC_PER_PARTITION" 1758 } 1759 ] 1760 } 1761 }, 1762 "com.amazonaws.kafka#ErrorInfo": { 1763 "type": "structure", 1764 "members": { 1765 "ErrorCode": { 1766 "target": "com.amazonaws.kafka#__string", 1767 "traits": { 1768 "smithy.api#documentation": "<p>A number describing the error programmatically.</p>", 1769 "smithy.api#jsonName": "errorCode" 1770 } 1771 }, 1772 "ErrorString": { 1773 "target": "com.amazonaws.kafka#__string", 1774 "traits": { 1775 "smithy.api#documentation": "<p>An optional field to provide more details about the error.</p>", 1776 "smithy.api#jsonName": "errorString" 1777 } 1778 } 1779 }, 1780 "traits": { 1781 "smithy.api#documentation": "<p>Returns information about an error state of the cluster.</p>" 1782 } 1783 }, 1784 "com.amazonaws.kafka#Firehose": { 1785 "type": "structure", 1786 "members": { 1787 "DeliveryStream": { 1788 "target": "com.amazonaws.kafka#__string", 1789 "traits": { 1790 "smithy.api#jsonName": "deliveryStream" 1791 } 1792 }, 1793 "Enabled": { 1794 "target": "com.amazonaws.kafka#__boolean", 1795 "traits": { 1796 "smithy.api#jsonName": "enabled", 1797 "smithy.api#required": {} 1798 } 1799 } 1800 } 1801 }, 1802 "com.amazonaws.kafka#ForbiddenException": { 1803 "type": "structure", 1804 "members": { 1805 "InvalidParameter": { 1806 "target": "com.amazonaws.kafka#__string", 1807 "traits": { 1808 "smithy.api#documentation": "<p>The parameter that caused the error.</p>", 1809 "smithy.api#jsonName": "invalidParameter" 1810 } 1811 }, 1812 "Message": { 1813 "target": "com.amazonaws.kafka#__string", 1814 "traits": { 1815 "smithy.api#documentation": "<p>The description of the error.</p>", 1816 "smithy.api#jsonName": "message" 1817 } 1818 } 1819 }, 1820 "traits": { 1821 "smithy.api#documentation": "<p>Returns information about an error.</p>", 1822 "smithy.api#error": "client", 1823 "smithy.api#httpError": 403 1824 } 1825 }, 1826 "com.amazonaws.kafka#GetBootstrapBrokers": { 1827 "type": "operation", 1828 "input": { 1829 "target": "com.amazonaws.kafka#GetBootstrapBrokersRequest" 1830 }, 1831 "output": { 1832 "target": "com.amazonaws.kafka#GetBootstrapBrokersResponse" 1833 }, 1834 "errors": [ 1835 { 1836 "target": "com.amazonaws.kafka#BadRequestException" 1837 }, 1838 { 1839 "target": "com.amazonaws.kafka#ConflictException" 1840 }, 1841 { 1842 "target": "com.amazonaws.kafka#ForbiddenException" 1843 }, 1844 { 1845 "target": "com.amazonaws.kafka#InternalServerErrorException" 1846 }, 1847 { 1848 "target": "com.amazonaws.kafka#UnauthorizedException" 1849 } 1850 ], 1851 "traits": { 1852 "smithy.api#documentation": "<p>A list of brokers that a client application can use to bootstrap.</p>", 1853 "smithy.api#http": { 1854 "method": "GET", 1855 "uri": "/v1/clusters/{ClusterArn}/bootstrap-brokers", 1856 "code": 200 1857 } 1858 } 1859 }, 1860 "com.amazonaws.kafka#GetBootstrapBrokersRequest": { 1861 "type": "structure", 1862 "members": { 1863 "ClusterArn": { 1864 "target": "com.amazonaws.kafka#__string", 1865 "traits": { 1866 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 1867 "smithy.api#httpLabel": {}, 1868 "smithy.api#required": {} 1869 } 1870 } 1871 } 1872 }, 1873 "com.amazonaws.kafka#GetBootstrapBrokersResponse": { 1874 "type": "structure", 1875 "members": { 1876 "BootstrapBrokerString": { 1877 "target": "com.amazonaws.kafka#__string", 1878 "traits": { 1879 "smithy.api#documentation": "<p>A string containing one or more hostname:port pairs.</p>", 1880 "smithy.api#jsonName": "bootstrapBrokerString" 1881 } 1882 }, 1883 "BootstrapBrokerStringTls": { 1884 "target": "com.amazonaws.kafka#__string", 1885 "traits": { 1886 "smithy.api#documentation": "<p>A string containing one or more DNS names (or IP) and TLS port pairs.</p>", 1887 "smithy.api#jsonName": "bootstrapBrokerStringTls" 1888 } 1889 }, 1890 "BootstrapBrokerStringSaslScram": { 1891 "target": "com.amazonaws.kafka#__string", 1892 "traits": { 1893 "smithy.api#documentation": "<p>A string containing one or more DNS names (or IP) and Sasl Scram port pairs.</p>", 1894 "smithy.api#jsonName": "bootstrapBrokerStringSaslScram" 1895 } 1896 } 1897 } 1898 }, 1899 "com.amazonaws.kafka#GetCompatibleKafkaVersions": { 1900 "type": "operation", 1901 "input": { 1902 "target": "com.amazonaws.kafka#GetCompatibleKafkaVersionsRequest" 1903 }, 1904 "output": { 1905 "target": "com.amazonaws.kafka#GetCompatibleKafkaVersionsResponse" 1906 }, 1907 "errors": [ 1908 { 1909 "target": "com.amazonaws.kafka#BadRequestException" 1910 }, 1911 { 1912 "target": "com.amazonaws.kafka#ForbiddenException" 1913 }, 1914 { 1915 "target": "com.amazonaws.kafka#InternalServerErrorException" 1916 }, 1917 { 1918 "target": "com.amazonaws.kafka#NotFoundException" 1919 }, 1920 { 1921 "target": "com.amazonaws.kafka#ServiceUnavailableException" 1922 }, 1923 { 1924 "target": "com.amazonaws.kafka#TooManyRequestsException" 1925 }, 1926 { 1927 "target": "com.amazonaws.kafka#UnauthorizedException" 1928 } 1929 ], 1930 "traits": { 1931 "smithy.api#documentation": "<p>Gets the Apache Kafka versions to which you can update the MSK cluster.</p>", 1932 "smithy.api#http": { 1933 "method": "GET", 1934 "uri": "/v1/compatible-kafka-versions", 1935 "code": 200 1936 } 1937 } 1938 }, 1939 "com.amazonaws.kafka#GetCompatibleKafkaVersionsRequest": { 1940 "type": "structure", 1941 "members": { 1942 "ClusterArn": { 1943 "target": "com.amazonaws.kafka#__string", 1944 "traits": { 1945 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster check.</p>", 1946 "smithy.api#httpQuery": "clusterArn" 1947 } 1948 } 1949 } 1950 }, 1951 "com.amazonaws.kafka#GetCompatibleKafkaVersionsResponse": { 1952 "type": "structure", 1953 "members": { 1954 "CompatibleKafkaVersions": { 1955 "target": "com.amazonaws.kafka#__listOfCompatibleKafkaVersion", 1956 "traits": { 1957 "smithy.api#documentation": "<p>A list of CompatibleKafkaVersion objects.</p>", 1958 "smithy.api#jsonName": "compatibleKafkaVersions" 1959 } 1960 } 1961 } 1962 }, 1963 "com.amazonaws.kafka#InternalServerErrorException": { 1964 "type": "structure", 1965 "members": { 1966 "InvalidParameter": { 1967 "target": "com.amazonaws.kafka#__string", 1968 "traits": { 1969 "smithy.api#documentation": "<p>The parameter that caused the error.</p>", 1970 "smithy.api#jsonName": "invalidParameter" 1971 } 1972 }, 1973 "Message": { 1974 "target": "com.amazonaws.kafka#__string", 1975 "traits": { 1976 "smithy.api#documentation": "<p>The description of the error.</p>", 1977 "smithy.api#jsonName": "message" 1978 } 1979 } 1980 }, 1981 "traits": { 1982 "smithy.api#documentation": "<p>Returns information about an error.</p>", 1983 "smithy.api#error": "server", 1984 "smithy.api#httpError": 500 1985 } 1986 }, 1987 "com.amazonaws.kafka#JmxExporter": { 1988 "type": "structure", 1989 "members": { 1990 "EnabledInBroker": { 1991 "target": "com.amazonaws.kafka#__boolean", 1992 "traits": { 1993 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>", 1994 "smithy.api#jsonName": "enabledInBroker", 1995 "smithy.api#required": {} 1996 } 1997 } 1998 }, 1999 "traits": { 2000 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>" 2001 } 2002 }, 2003 "com.amazonaws.kafka#JmxExporterInfo": { 2004 "type": "structure", 2005 "members": { 2006 "EnabledInBroker": { 2007 "target": "com.amazonaws.kafka#__boolean", 2008 "traits": { 2009 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>", 2010 "smithy.api#jsonName": "enabledInBroker", 2011 "smithy.api#required": {} 2012 } 2013 } 2014 }, 2015 "traits": { 2016 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>" 2017 } 2018 }, 2019 "com.amazonaws.kafka#Kafka": { 2020 "type": "service", 2021 "version": "2018-11-14", 2022 "operations": [ 2023 { 2024 "target": "com.amazonaws.kafka#BatchAssociateScramSecret" 2025 }, 2026 { 2027 "target": "com.amazonaws.kafka#BatchDisassociateScramSecret" 2028 }, 2029 { 2030 "target": "com.amazonaws.kafka#CreateCluster" 2031 }, 2032 { 2033 "target": "com.amazonaws.kafka#CreateConfiguration" 2034 }, 2035 { 2036 "target": "com.amazonaws.kafka#DeleteCluster" 2037 }, 2038 { 2039 "target": "com.amazonaws.kafka#DeleteConfiguration" 2040 }, 2041 { 2042 "target": "com.amazonaws.kafka#DescribeCluster" 2043 }, 2044 { 2045 "target": "com.amazonaws.kafka#DescribeClusterOperation" 2046 }, 2047 { 2048 "target": "com.amazonaws.kafka#DescribeConfiguration" 2049 }, 2050 { 2051 "target": "com.amazonaws.kafka#DescribeConfigurationRevision" 2052 }, 2053 { 2054 "target": "com.amazonaws.kafka#GetBootstrapBrokers" 2055 }, 2056 { 2057 "target": "com.amazonaws.kafka#GetCompatibleKafkaVersions" 2058 }, 2059 { 2060 "target": "com.amazonaws.kafka#ListClusterOperations" 2061 }, 2062 { 2063 "target": "com.amazonaws.kafka#ListClusters" 2064 }, 2065 { 2066 "target": "com.amazonaws.kafka#ListConfigurationRevisions" 2067 }, 2068 { 2069 "target": "com.amazonaws.kafka#ListConfigurations" 2070 }, 2071 { 2072 "target": "com.amazonaws.kafka#ListKafkaVersions" 2073 }, 2074 { 2075 "target": "com.amazonaws.kafka#ListNodes" 2076 }, 2077 { 2078 "target": "com.amazonaws.kafka#ListScramSecrets" 2079 }, 2080 { 2081 "target": "com.amazonaws.kafka#ListTagsForResource" 2082 }, 2083 { 2084 "target": "com.amazonaws.kafka#RebootBroker" 2085 }, 2086 { 2087 "target": "com.amazonaws.kafka#TagResource" 2088 }, 2089 { 2090 "target": "com.amazonaws.kafka#UntagResource" 2091 }, 2092 { 2093 "target": "com.amazonaws.kafka#UpdateBrokerCount" 2094 }, 2095 { 2096 "target": "com.amazonaws.kafka#UpdateBrokerStorage" 2097 }, 2098 { 2099 "target": "com.amazonaws.kafka#UpdateBrokerType" 2100 }, 2101 { 2102 "target": "com.amazonaws.kafka#UpdateClusterConfiguration" 2103 }, 2104 { 2105 "target": "com.amazonaws.kafka#UpdateClusterKafkaVersion" 2106 }, 2107 { 2108 "target": "com.amazonaws.kafka#UpdateConfiguration" 2109 }, 2110 { 2111 "target": "com.amazonaws.kafka#UpdateMonitoring" 2112 } 2113 ], 2114 "traits": { 2115 "aws.api#service": { 2116 "sdkId": "Kafka", 2117 "arnNamespace": "kafka", 2118 "cloudFormationName": "MSK", 2119 "cloudTrailEventSource": "kafka.amazonaws.com", 2120 "endpointPrefix": "kafka" 2121 }, 2122 "aws.auth#sigv4": { 2123 "name": "kafka" 2124 }, 2125 "aws.protocols#restJson1": {}, 2126 "smithy.api#documentation": "<p>The operations for managing an Amazon MSK cluster.</p>", 2127 "smithy.api#title": "Managed Streaming for Kafka" 2128 } 2129 }, 2130 "com.amazonaws.kafka#KafkaVersion": { 2131 "type": "structure", 2132 "members": { 2133 "Version": { 2134 "target": "com.amazonaws.kafka#__string", 2135 "traits": { 2136 "smithy.api#jsonName": "version" 2137 } 2138 }, 2139 "Status": { 2140 "target": "com.amazonaws.kafka#KafkaVersionStatus", 2141 "traits": { 2142 "smithy.api#jsonName": "status" 2143 } 2144 } 2145 } 2146 }, 2147 "com.amazonaws.kafka#KafkaVersionStatus": { 2148 "type": "string", 2149 "traits": { 2150 "smithy.api#enum": [ 2151 { 2152 "value": "ACTIVE", 2153 "name": "ACTIVE" 2154 }, 2155 { 2156 "value": "DEPRECATED", 2157 "name": "DEPRECATED" 2158 } 2159 ] 2160 } 2161 }, 2162 "com.amazonaws.kafka#ListClusterOperations": { 2163 "type": "operation", 2164 "input": { 2165 "target": "com.amazonaws.kafka#ListClusterOperationsRequest" 2166 }, 2167 "output": { 2168 "target": "com.amazonaws.kafka#ListClusterOperationsResponse" 2169 }, 2170 "errors": [ 2171 { 2172 "target": "com.amazonaws.kafka#BadRequestException" 2173 }, 2174 { 2175 "target": "com.amazonaws.kafka#ForbiddenException" 2176 }, 2177 { 2178 "target": "com.amazonaws.kafka#InternalServerErrorException" 2179 }, 2180 { 2181 "target": "com.amazonaws.kafka#UnauthorizedException" 2182 } 2183 ], 2184 "traits": { 2185 "smithy.api#documentation": "<p>Returns a list of all the operations that have been performed on the specified MSK cluster.</p>", 2186 "smithy.api#http": { 2187 "method": "GET", 2188 "uri": "/v1/clusters/{ClusterArn}/operations", 2189 "code": 200 2190 }, 2191 "smithy.api#paginated": { 2192 "inputToken": "NextToken", 2193 "outputToken": "NextToken", 2194 "items": "ClusterOperationInfoList", 2195 "pageSize": "MaxResults" 2196 } 2197 } 2198 }, 2199 "com.amazonaws.kafka#ListClusterOperationsRequest": { 2200 "type": "structure", 2201 "members": { 2202 "ClusterArn": { 2203 "target": "com.amazonaws.kafka#__string", 2204 "traits": { 2205 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 2206 "smithy.api#httpLabel": {}, 2207 "smithy.api#required": {} 2208 } 2209 }, 2210 "MaxResults": { 2211 "target": "com.amazonaws.kafka#MaxResults", 2212 "traits": { 2213 "smithy.api#documentation": "<p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>", 2214 "smithy.api#httpQuery": "maxResults" 2215 } 2216 }, 2217 "NextToken": { 2218 "target": "com.amazonaws.kafka#__string", 2219 "traits": { 2220 "smithy.api#documentation": "<p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.</p>", 2221 "smithy.api#httpQuery": "nextToken" 2222 } 2223 } 2224 } 2225 }, 2226 "com.amazonaws.kafka#ListClusterOperationsResponse": { 2227 "type": "structure", 2228 "members": { 2229 "ClusterOperationInfoList": { 2230 "target": "com.amazonaws.kafka#__listOfClusterOperationInfo", 2231 "traits": { 2232 "smithy.api#documentation": "<p>An array of cluster operation information objects.</p>", 2233 "smithy.api#jsonName": "clusterOperationInfoList" 2234 } 2235 }, 2236 "NextToken": { 2237 "target": "com.amazonaws.kafka#__string", 2238 "traits": { 2239 "smithy.api#documentation": "<p>If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.</p>", 2240 "smithy.api#jsonName": "nextToken" 2241 } 2242 } 2243 } 2244 }, 2245 "com.amazonaws.kafka#ListClusters": { 2246 "type": "operation", 2247 "input": { 2248 "target": "com.amazonaws.kafka#ListClustersRequest" 2249 }, 2250 "output": { 2251 "target": "com.amazonaws.kafka#ListClustersResponse" 2252 }, 2253 "errors": [ 2254 { 2255 "target": "com.amazonaws.kafka#BadRequestException" 2256 }, 2257 { 2258 "target": "com.amazonaws.kafka#ForbiddenException" 2259 }, 2260 { 2261 "target": "com.amazonaws.kafka#InternalServerErrorException" 2262 }, 2263 { 2264 "target": "com.amazonaws.kafka#UnauthorizedException" 2265 } 2266 ], 2267 "traits": { 2268 "smithy.api#documentation": "<p>Returns a list of all the MSK clusters in the current Region.</p>", 2269 "smithy.api#http": { 2270 "method": "GET", 2271 "uri": "/v1/clusters", 2272 "code": 200 2273 }, 2274 "smithy.api#paginated": { 2275 "inputToken": "NextToken", 2276 "outputToken": "NextToken", 2277 "items": "ClusterInfoList", 2278 "pageSize": "MaxResults" 2279 } 2280 } 2281 }, 2282 "com.amazonaws.kafka#ListClustersRequest": { 2283 "type": "structure", 2284 "members": { 2285 "ClusterNameFilter": { 2286 "target": "com.amazonaws.kafka#__string", 2287 "traits": { 2288 "smithy.api#documentation": "<p>Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.</p>", 2289 "smithy.api#httpQuery": "clusterNameFilter" 2290 } 2291 }, 2292 "MaxResults": { 2293 "target": "com.amazonaws.kafka#MaxResults", 2294 "traits": { 2295 "smithy.api#documentation": "<p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>", 2296 "smithy.api#httpQuery": "maxResults" 2297 } 2298 }, 2299 "NextToken": { 2300 "target": "com.amazonaws.kafka#__string", 2301 "traits": { 2302 "smithy.api#documentation": "<p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.</p>", 2303 "smithy.api#httpQuery": "nextToken" 2304 } 2305 } 2306 } 2307 }, 2308 "com.amazonaws.kafka#ListClustersResponse": { 2309 "type": "structure", 2310 "members": { 2311 "ClusterInfoList": { 2312 "target": "com.amazonaws.kafka#__listOfClusterInfo", 2313 "traits": { 2314 "smithy.api#documentation": "<p>Information on each of the MSK clusters in the response.</p>", 2315 "smithy.api#jsonName": "clusterInfoList" 2316 } 2317 }, 2318 "NextToken": { 2319 "target": "com.amazonaws.kafka#__string", 2320 "traits": { 2321 "smithy.api#documentation": "<p>The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. \n To get another batch of clusters, provide this token in your next request.</p>", 2322 "smithy.api#jsonName": "nextToken" 2323 } 2324 } 2325 } 2326 }, 2327 "com.amazonaws.kafka#ListConfigurationRevisions": { 2328 "type": "operation", 2329 "input": { 2330 "target": "com.amazonaws.kafka#ListConfigurationRevisionsRequest" 2331 }, 2332 "output": { 2333 "target": "com.amazonaws.kafka#ListConfigurationRevisionsResponse" 2334 }, 2335 "errors": [ 2336 { 2337 "target": "com.amazonaws.kafka#BadRequestException" 2338 }, 2339 { 2340 "target": "com.amazonaws.kafka#ForbiddenException" 2341 }, 2342 { 2343 "target": "com.amazonaws.kafka#InternalServerErrorException" 2344 }, 2345 { 2346 "target": "com.amazonaws.kafka#NotFoundException" 2347 }, 2348 { 2349 "target": "com.amazonaws.kafka#ServiceUnavailableException" 2350 }, 2351 { 2352 "target": "com.amazonaws.kafka#UnauthorizedException" 2353 } 2354 ], 2355 "traits": { 2356 "smithy.api#documentation": "<p>Returns a list of all the MSK configurations in this Region.</p>", 2357 "smithy.api#http": { 2358 "method": "GET", 2359 "uri": "/v1/configurations/{Arn}/revisions", 2360 "code": 200 2361 }, 2362 "smithy.api#paginated": { 2363 "inputToken": "NextToken", 2364 "outputToken": "NextToken", 2365 "items": "Revisions", 2366 "pageSize": "MaxResults" 2367 } 2368 } 2369 }, 2370 "com.amazonaws.kafka#ListConfigurationRevisionsRequest": { 2371 "type": "structure", 2372 "members": { 2373 "Arn": { 2374 "target": "com.amazonaws.kafka#__string", 2375 "traits": { 2376 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.</p>", 2377 "smithy.api#httpLabel": {}, 2378 "smithy.api#required": {} 2379 } 2380 }, 2381 "MaxResults": { 2382 "target": "com.amazonaws.kafka#MaxResults", 2383 "traits": { 2384 "smithy.api#documentation": "<p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>", 2385 "smithy.api#httpQuery": "maxResults" 2386 } 2387 }, 2388 "NextToken": { 2389 "target": "com.amazonaws.kafka#__string", 2390 "traits": { 2391 "smithy.api#documentation": "<p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.</p>", 2392 "smithy.api#httpQuery": "nextToken" 2393 } 2394 } 2395 } 2396 }, 2397 "com.amazonaws.kafka#ListConfigurationRevisionsResponse": { 2398 "type": "structure", 2399 "members": { 2400 "NextToken": { 2401 "target": "com.amazonaws.kafka#__string", 2402 "traits": { 2403 "smithy.api#documentation": "<p>Paginated results marker.</p>", 2404 "smithy.api#jsonName": "nextToken" 2405 } 2406 }, 2407 "Revisions": { 2408 "target": "com.amazonaws.kafka#__listOfConfigurationRevision", 2409 "traits": { 2410 "smithy.api#documentation": "<p>List of ConfigurationRevision objects.</p>", 2411 "smithy.api#jsonName": "revisions" 2412 } 2413 } 2414 } 2415 }, 2416 "com.amazonaws.kafka#ListConfigurations": { 2417 "type": "operation", 2418 "input": { 2419 "target": "com.amazonaws.kafka#ListConfigurationsRequest" 2420 }, 2421 "output": { 2422 "target": "com.amazonaws.kafka#ListConfigurationsResponse" 2423 }, 2424 "errors": [ 2425 { 2426 "target": "com.amazonaws.kafka#BadRequestException" 2427 }, 2428 { 2429 "target": "com.amazonaws.kafka#ForbiddenException" 2430 }, 2431 { 2432 "target": "com.amazonaws.kafka#InternalServerErrorException" 2433 }, 2434 { 2435 "target": "com.amazonaws.kafka#ServiceUnavailableException" 2436 }, 2437 { 2438 "target": "com.amazonaws.kafka#UnauthorizedException" 2439 } 2440 ], 2441 "traits": { 2442 "smithy.api#documentation": "<p>Returns a list of all the MSK configurations in this Region.</p>", 2443 "smithy.api#http": { 2444 "method": "GET", 2445 "uri": "/v1/configurations", 2446 "code": 200 2447 }, 2448 "smithy.api#paginated": { 2449 "inputToken": "NextToken", 2450 "outputToken": "NextToken", 2451 "items": "Configurations", 2452 "pageSize": "MaxResults" 2453 } 2454 } 2455 }, 2456 "com.amazonaws.kafka#ListConfigurationsRequest": { 2457 "type": "structure", 2458 "members": { 2459 "MaxResults": { 2460 "target": "com.amazonaws.kafka#MaxResults", 2461 "traits": { 2462 "smithy.api#documentation": "<p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>", 2463 "smithy.api#httpQuery": "maxResults" 2464 } 2465 }, 2466 "NextToken": { 2467 "target": "com.amazonaws.kafka#__string", 2468 "traits": { 2469 "smithy.api#documentation": "<p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.</p>", 2470 "smithy.api#httpQuery": "nextToken" 2471 } 2472 } 2473 } 2474 }, 2475 "com.amazonaws.kafka#ListConfigurationsResponse": { 2476 "type": "structure", 2477 "members": { 2478 "Configurations": { 2479 "target": "com.amazonaws.kafka#__listOfConfiguration", 2480 "traits": { 2481 "smithy.api#documentation": "<p>An array of MSK configurations.</p>", 2482 "smithy.api#jsonName": "configurations" 2483 } 2484 }, 2485 "NextToken": { 2486 "target": "com.amazonaws.kafka#__string", 2487 "traits": { 2488 "smithy.api#documentation": "<p>The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. \n To get another batch of configurations, provide this token in your next request.</p>", 2489 "smithy.api#jsonName": "nextToken" 2490 } 2491 } 2492 } 2493 }, 2494 "com.amazonaws.kafka#ListKafkaVersions": { 2495 "type": "operation", 2496 "input": { 2497 "target": "com.amazonaws.kafka#ListKafkaVersionsRequest" 2498 }, 2499 "output": { 2500 "target": "com.amazonaws.kafka#ListKafkaVersionsResponse" 2501 }, 2502 "errors": [ 2503 { 2504 "target": "com.amazonaws.kafka#BadRequestException" 2505 }, 2506 { 2507 "target": "com.amazonaws.kafka#ForbiddenException" 2508 }, 2509 { 2510 "target": "com.amazonaws.kafka#InternalServerErrorException" 2511 }, 2512 { 2513 "target": "com.amazonaws.kafka#UnauthorizedException" 2514 } 2515 ], 2516 "traits": { 2517 "smithy.api#documentation": "<p>Returns a list of Kafka versions.</p>", 2518 "smithy.api#http": { 2519 "method": "GET", 2520 "uri": "/v1/kafka-versions", 2521 "code": 200 2522 }, 2523 "smithy.api#paginated": { 2524 "inputToken": "NextToken", 2525 "outputToken": "NextToken", 2526 "items": "KafkaVersions", 2527 "pageSize": "MaxResults" 2528 } 2529 } 2530 }, 2531 "com.amazonaws.kafka#ListKafkaVersionsRequest": { 2532 "type": "structure", 2533 "members": { 2534 "MaxResults": { 2535 "target": "com.amazonaws.kafka#MaxResults", 2536 "traits": { 2537 "smithy.api#documentation": "<p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>", 2538 "smithy.api#httpQuery": "maxResults" 2539 } 2540 }, 2541 "NextToken": { 2542 "target": "com.amazonaws.kafka#__string", 2543 "traits": { 2544 "smithy.api#documentation": "<p>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.</p>", 2545 "smithy.api#httpQuery": "nextToken" 2546 } 2547 } 2548 } 2549 }, 2550 "com.amazonaws.kafka#ListKafkaVersionsResponse": { 2551 "type": "structure", 2552 "members": { 2553 "KafkaVersions": { 2554 "target": "com.amazonaws.kafka#__listOfKafkaVersion", 2555 "traits": { 2556 "smithy.api#jsonName": "kafkaVersions" 2557 } 2558 }, 2559 "NextToken": { 2560 "target": "com.amazonaws.kafka#__string", 2561 "traits": { 2562 "smithy.api#jsonName": "nextToken" 2563 } 2564 } 2565 } 2566 }, 2567 "com.amazonaws.kafka#ListNodes": { 2568 "type": "operation", 2569 "input": { 2570 "target": "com.amazonaws.kafka#ListNodesRequest" 2571 }, 2572 "output": { 2573 "target": "com.amazonaws.kafka#ListNodesResponse" 2574 }, 2575 "errors": [ 2576 { 2577 "target": "com.amazonaws.kafka#BadRequestException" 2578 }, 2579 { 2580 "target": "com.amazonaws.kafka#ForbiddenException" 2581 }, 2582 { 2583 "target": "com.amazonaws.kafka#InternalServerErrorException" 2584 }, 2585 { 2586 "target": "com.amazonaws.kafka#NotFoundException" 2587 } 2588 ], 2589 "traits": { 2590 "smithy.api#documentation": "<p>Returns a list of the broker nodes in the cluster.</p>", 2591 "smithy.api#http": { 2592 "method": "GET", 2593 "uri": "/v1/clusters/{ClusterArn}/nodes", 2594 "code": 200 2595 }, 2596 "smithy.api#paginated": { 2597 "inputToken": "NextToken", 2598 "outputToken": "NextToken", 2599 "items": "NodeInfoList", 2600 "pageSize": "MaxResults" 2601 } 2602 } 2603 }, 2604 "com.amazonaws.kafka#ListNodesRequest": { 2605 "type": "structure", 2606 "members": { 2607 "ClusterArn": { 2608 "target": "com.amazonaws.kafka#__string", 2609 "traits": { 2610 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 2611 "smithy.api#httpLabel": {}, 2612 "smithy.api#required": {} 2613 } 2614 }, 2615 "MaxResults": { 2616 "target": "com.amazonaws.kafka#MaxResults", 2617 "traits": { 2618 "smithy.api#documentation": "<p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>", 2619 "smithy.api#httpQuery": "maxResults" 2620 } 2621 }, 2622 "NextToken": { 2623 "target": "com.amazonaws.kafka#__string", 2624 "traits": { 2625 "smithy.api#documentation": "<p>The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.</p>", 2626 "smithy.api#httpQuery": "nextToken" 2627 } 2628 } 2629 } 2630 }, 2631 "com.amazonaws.kafka#ListNodesResponse": { 2632 "type": "structure", 2633 "members": { 2634 "NextToken": { 2635 "target": "com.amazonaws.kafka#__string", 2636 "traits": { 2637 "smithy.api#documentation": "<p>The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. \n To get another batch of nodes, provide this token in your next request.</p>", 2638 "smithy.api#jsonName": "nextToken" 2639 } 2640 }, 2641 "NodeInfoList": { 2642 "target": "com.amazonaws.kafka#__listOfNodeInfo", 2643 "traits": { 2644 "smithy.api#documentation": "<p>List containing a NodeInfo object.</p>", 2645 "smithy.api#jsonName": "nodeInfoList" 2646 } 2647 } 2648 } 2649 }, 2650 "com.amazonaws.kafka#ListScramSecrets": { 2651 "type": "operation", 2652 "input": { 2653 "target": "com.amazonaws.kafka#ListScramSecretsRequest" 2654 }, 2655 "output": { 2656 "target": "com.amazonaws.kafka#ListScramSecretsResponse" 2657 }, 2658 "errors": [ 2659 { 2660 "target": "com.amazonaws.kafka#BadRequestException" 2661 }, 2662 { 2663 "target": "com.amazonaws.kafka#ForbiddenException" 2664 }, 2665 { 2666 "target": "com.amazonaws.kafka#InternalServerErrorException" 2667 }, 2668 { 2669 "target": "com.amazonaws.kafka#NotFoundException" 2670 }, 2671 { 2672 "target": "com.amazonaws.kafka#ServiceUnavailableException" 2673 }, 2674 { 2675 "target": "com.amazonaws.kafka#TooManyRequestsException" 2676 }, 2677 { 2678 "target": "com.amazonaws.kafka#UnauthorizedException" 2679 } 2680 ], 2681 "traits": { 2682 "smithy.api#documentation": "<p>Returns a list of the Scram Secrets associated with an Amazon MSK cluster.</p>", 2683 "smithy.api#http": { 2684 "method": "GET", 2685 "uri": "/v1/clusters/{ClusterArn}/scram-secrets", 2686 "code": 200 2687 }, 2688 "smithy.api#paginated": { 2689 "inputToken": "NextToken", 2690 "outputToken": "NextToken", 2691 "items": "SecretArnList", 2692 "pageSize": "MaxResults" 2693 } 2694 } 2695 }, 2696 "com.amazonaws.kafka#ListScramSecretsRequest": { 2697 "type": "structure", 2698 "members": { 2699 "ClusterArn": { 2700 "target": "com.amazonaws.kafka#__string", 2701 "traits": { 2702 "smithy.api#documentation": "<p>The arn of the cluster.</p>", 2703 "smithy.api#httpLabel": {}, 2704 "smithy.api#required": {} 2705 } 2706 }, 2707 "MaxResults": { 2708 "target": "com.amazonaws.kafka#MaxResults", 2709 "traits": { 2710 "smithy.api#documentation": "<p>The maxResults of the query.</p>", 2711 "smithy.api#httpQuery": "maxResults" 2712 } 2713 }, 2714 "NextToken": { 2715 "target": "com.amazonaws.kafka#__string", 2716 "traits": { 2717 "smithy.api#documentation": "<p>The nextToken of the query.</p>", 2718 "smithy.api#httpQuery": "nextToken" 2719 } 2720 } 2721 } 2722 }, 2723 "com.amazonaws.kafka#ListScramSecretsResponse": { 2724 "type": "structure", 2725 "members": { 2726 "NextToken": { 2727 "target": "com.amazonaws.kafka#__string", 2728 "traits": { 2729 "smithy.api#documentation": "<p>Paginated results marker.</p>", 2730 "smithy.api#jsonName": "nextToken" 2731 } 2732 }, 2733 "SecretArnList": { 2734 "target": "com.amazonaws.kafka#__listOf__string", 2735 "traits": { 2736 "smithy.api#documentation": "<p>The list of scram secrets associated with the cluster.</p>", 2737 "smithy.api#jsonName": "secretArnList" 2738 } 2739 } 2740 } 2741 }, 2742 "com.amazonaws.kafka#ListTagsForResource": { 2743 "type": "operation", 2744 "input": { 2745 "target": "com.amazonaws.kafka#ListTagsForResourceRequest" 2746 }, 2747 "output": { 2748 "target": "com.amazonaws.kafka#ListTagsForResourceResponse" 2749 }, 2750 "errors": [ 2751 { 2752 "target": "com.amazonaws.kafka#BadRequestException" 2753 }, 2754 { 2755 "target": "com.amazonaws.kafka#InternalServerErrorException" 2756 }, 2757 { 2758 "target": "com.amazonaws.kafka#NotFoundException" 2759 } 2760 ], 2761 "traits": { 2762 "smithy.api#documentation": "<p>Returns a list of the tags associated with the specified resource.</p>", 2763 "smithy.api#http": { 2764 "method": "GET", 2765 "uri": "/v1/tags/{ResourceArn}", 2766 "code": 200 2767 } 2768 } 2769 }, 2770 "com.amazonaws.kafka#ListTagsForResourceRequest": { 2771 "type": "structure", 2772 "members": { 2773 "ResourceArn": { 2774 "target": "com.amazonaws.kafka#__string", 2775 "traits": { 2776 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</p>", 2777 "smithy.api#httpLabel": {}, 2778 "smithy.api#required": {} 2779 } 2780 } 2781 } 2782 }, 2783 "com.amazonaws.kafka#ListTagsForResourceResponse": { 2784 "type": "structure", 2785 "members": { 2786 "Tags": { 2787 "target": "com.amazonaws.kafka#__mapOf__string", 2788 "traits": { 2789 "smithy.api#documentation": "<p>The key-value pair for the resource tag.</p>", 2790 "smithy.api#jsonName": "tags" 2791 } 2792 } 2793 } 2794 }, 2795 "com.amazonaws.kafka#LoggingInfo": { 2796 "type": "structure", 2797 "members": { 2798 "BrokerLogs": { 2799 "target": "com.amazonaws.kafka#BrokerLogs", 2800 "traits": { 2801 "smithy.api#jsonName": "brokerLogs", 2802 "smithy.api#required": {} 2803 } 2804 } 2805 } 2806 }, 2807 "com.amazonaws.kafka#MaxResults": { 2808 "type": "integer", 2809 "traits": { 2810 "smithy.api#range": { 2811 "min": 1, 2812 "max": 100 2813 } 2814 } 2815 }, 2816 "com.amazonaws.kafka#MutableClusterInfo": { 2817 "type": "structure", 2818 "members": { 2819 "BrokerEBSVolumeInfo": { 2820 "target": "com.amazonaws.kafka#__listOfBrokerEBSVolumeInfo", 2821 "traits": { 2822 "smithy.api#documentation": "<p>Specifies the size of the EBS volume and the ID of the associated broker.</p>", 2823 "smithy.api#jsonName": "brokerEBSVolumeInfo" 2824 } 2825 }, 2826 "ConfigurationInfo": { 2827 "target": "com.amazonaws.kafka#ConfigurationInfo", 2828 "traits": { 2829 "smithy.api#documentation": "<p>Information about the changes in the configuration of the brokers.</p>", 2830 "smithy.api#jsonName": "configurationInfo" 2831 } 2832 }, 2833 "NumberOfBrokerNodes": { 2834 "target": "com.amazonaws.kafka#__integer", 2835 "traits": { 2836 "smithy.api#documentation": "<p>The number of broker nodes in the cluster.</p>", 2837 "smithy.api#jsonName": "numberOfBrokerNodes" 2838 } 2839 }, 2840 "EnhancedMonitoring": { 2841 "target": "com.amazonaws.kafka#EnhancedMonitoring", 2842 "traits": { 2843 "smithy.api#documentation": "<p>Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.</p>", 2844 "smithy.api#jsonName": "enhancedMonitoring" 2845 } 2846 }, 2847 "OpenMonitoring": { 2848 "target": "com.amazonaws.kafka#OpenMonitoring", 2849 "traits": { 2850 "smithy.api#documentation": "<p>The settings for open monitoring.</p>", 2851 "smithy.api#jsonName": "openMonitoring" 2852 } 2853 }, 2854 "KafkaVersion": { 2855 "target": "com.amazonaws.kafka#__string", 2856 "traits": { 2857 "smithy.api#documentation": "<p>The Kafka version.</p>", 2858 "smithy.api#jsonName": "kafkaVersion" 2859 } 2860 }, 2861 "LoggingInfo": { 2862 "target": "com.amazonaws.kafka#LoggingInfo", 2863 "traits": { 2864 "smithy.api#jsonName": "loggingInfo" 2865 } 2866 }, 2867 "InstanceType": { 2868 "target": "com.amazonaws.kafka#__stringMin5Max32", 2869 "traits": { 2870 "smithy.api#documentation": "<p>Information about the Amazon MSK broker type.</p>", 2871 "smithy.api#jsonName": "instanceType" 2872 } 2873 } 2874 }, 2875 "traits": { 2876 "smithy.api#documentation": "<p>Information about cluster attributes that can be updated via update APIs.</p>" 2877 } 2878 }, 2879 "com.amazonaws.kafka#NodeExporter": { 2880 "type": "structure", 2881 "members": { 2882 "EnabledInBroker": { 2883 "target": "com.amazonaws.kafka#__boolean", 2884 "traits": { 2885 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the Node Exporter.</p>", 2886 "smithy.api#jsonName": "enabledInBroker", 2887 "smithy.api#required": {} 2888 } 2889 } 2890 }, 2891 "traits": { 2892 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the Node Exporter.</p>" 2893 } 2894 }, 2895 "com.amazonaws.kafka#NodeExporterInfo": { 2896 "type": "structure", 2897 "members": { 2898 "EnabledInBroker": { 2899 "target": "com.amazonaws.kafka#__boolean", 2900 "traits": { 2901 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the Node Exporter.</p>", 2902 "smithy.api#jsonName": "enabledInBroker", 2903 "smithy.api#required": {} 2904 } 2905 } 2906 }, 2907 "traits": { 2908 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the Node Exporter.</p>" 2909 } 2910 }, 2911 "com.amazonaws.kafka#NodeInfo": { 2912 "type": "structure", 2913 "members": { 2914 "AddedToClusterTime": { 2915 "target": "com.amazonaws.kafka#__string", 2916 "traits": { 2917 "smithy.api#documentation": "<p>The start time.</p>", 2918 "smithy.api#jsonName": "addedToClusterTime" 2919 } 2920 }, 2921 "BrokerNodeInfo": { 2922 "target": "com.amazonaws.kafka#BrokerNodeInfo", 2923 "traits": { 2924 "smithy.api#documentation": "<p>The broker node info.</p>", 2925 "smithy.api#jsonName": "brokerNodeInfo" 2926 } 2927 }, 2928 "InstanceType": { 2929 "target": "com.amazonaws.kafka#__string", 2930 "traits": { 2931 "smithy.api#documentation": "<p>The instance type.</p>", 2932 "smithy.api#jsonName": "instanceType" 2933 } 2934 }, 2935 "NodeARN": { 2936 "target": "com.amazonaws.kafka#__string", 2937 "traits": { 2938 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the node.</p>", 2939 "smithy.api#jsonName": "nodeARN" 2940 } 2941 }, 2942 "NodeType": { 2943 "target": "com.amazonaws.kafka#NodeType", 2944 "traits": { 2945 "smithy.api#documentation": "<p>The node type.</p>", 2946 "smithy.api#jsonName": "nodeType" 2947 } 2948 }, 2949 "ZookeeperNodeInfo": { 2950 "target": "com.amazonaws.kafka#ZookeeperNodeInfo", 2951 "traits": { 2952 "smithy.api#documentation": "<p>The ZookeeperNodeInfo.</p>", 2953 "smithy.api#jsonName": "zookeeperNodeInfo" 2954 } 2955 } 2956 }, 2957 "traits": { 2958 "smithy.api#documentation": "<p>The node information object.</p>" 2959 } 2960 }, 2961 "com.amazonaws.kafka#NodeType": { 2962 "type": "string", 2963 "traits": { 2964 "smithy.api#documentation": "<p>The broker or Zookeeper node.</p>", 2965 "smithy.api#enum": [ 2966 { 2967 "value": "BROKER", 2968 "name": "BROKER" 2969 } 2970 ] 2971 } 2972 }, 2973 "com.amazonaws.kafka#NotFoundException": { 2974 "type": "structure", 2975 "members": { 2976 "InvalidParameter": { 2977 "target": "com.amazonaws.kafka#__string", 2978 "traits": { 2979 "smithy.api#documentation": "<p>The parameter that caused the error.</p>", 2980 "smithy.api#jsonName": "invalidParameter" 2981 } 2982 }, 2983 "Message": { 2984 "target": "com.amazonaws.kafka#__string", 2985 "traits": { 2986 "smithy.api#documentation": "<p>The description of the error.</p>", 2987 "smithy.api#jsonName": "message" 2988 } 2989 } 2990 }, 2991 "traits": { 2992 "smithy.api#documentation": "<p>Returns information about an error.</p>", 2993 "smithy.api#error": "client", 2994 "smithy.api#httpError": 404 2995 } 2996 }, 2997 "com.amazonaws.kafka#OpenMonitoring": { 2998 "type": "structure", 2999 "members": { 3000 "Prometheus": { 3001 "target": "com.amazonaws.kafka#Prometheus", 3002 "traits": { 3003 "smithy.api#documentation": "<p>Prometheus settings.</p>", 3004 "smithy.api#jsonName": "prometheus", 3005 "smithy.api#required": {} 3006 } 3007 } 3008 }, 3009 "traits": { 3010 "smithy.api#documentation": "<p>JMX and Node monitoring for the MSK cluster.</p>" 3011 } 3012 }, 3013 "com.amazonaws.kafka#OpenMonitoringInfo": { 3014 "type": "structure", 3015 "members": { 3016 "Prometheus": { 3017 "target": "com.amazonaws.kafka#PrometheusInfo", 3018 "traits": { 3019 "smithy.api#documentation": "<p>Prometheus settings.</p>", 3020 "smithy.api#jsonName": "prometheus", 3021 "smithy.api#required": {} 3022 } 3023 } 3024 }, 3025 "traits": { 3026 "smithy.api#documentation": "<p>JMX and Node monitoring for the MSK cluster.</p>" 3027 } 3028 }, 3029 "com.amazonaws.kafka#Prometheus": { 3030 "type": "structure", 3031 "members": { 3032 "JmxExporter": { 3033 "target": "com.amazonaws.kafka#JmxExporter", 3034 "traits": { 3035 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>", 3036 "smithy.api#jsonName": "jmxExporter" 3037 } 3038 }, 3039 "NodeExporter": { 3040 "target": "com.amazonaws.kafka#NodeExporter", 3041 "traits": { 3042 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the Node Exporter.</p>", 3043 "smithy.api#jsonName": "nodeExporter" 3044 } 3045 } 3046 }, 3047 "traits": { 3048 "smithy.api#documentation": "<p>Prometheus settings.</p>" 3049 } 3050 }, 3051 "com.amazonaws.kafka#PrometheusInfo": { 3052 "type": "structure", 3053 "members": { 3054 "JmxExporter": { 3055 "target": "com.amazonaws.kafka#JmxExporterInfo", 3056 "traits": { 3057 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the JMX Exporter.</p>", 3058 "smithy.api#jsonName": "jmxExporter" 3059 } 3060 }, 3061 "NodeExporter": { 3062 "target": "com.amazonaws.kafka#NodeExporterInfo", 3063 "traits": { 3064 "smithy.api#documentation": "<p>Indicates whether you want to enable or disable the Node Exporter.</p>", 3065 "smithy.api#jsonName": "nodeExporter" 3066 } 3067 } 3068 }, 3069 "traits": { 3070 "smithy.api#documentation": "<p>Prometheus settings.</p>" 3071 } 3072 }, 3073 "com.amazonaws.kafka#RebootBroker": { 3074 "type": "operation", 3075 "input": { 3076 "target": "com.amazonaws.kafka#RebootBrokerRequest" 3077 }, 3078 "output": { 3079 "target": "com.amazonaws.kafka#RebootBrokerResponse" 3080 }, 3081 "errors": [ 3082 { 3083 "target": "com.amazonaws.kafka#BadRequestException" 3084 }, 3085 { 3086 "target": "com.amazonaws.kafka#ForbiddenException" 3087 }, 3088 { 3089 "target": "com.amazonaws.kafka#InternalServerErrorException" 3090 }, 3091 { 3092 "target": "com.amazonaws.kafka#NotFoundException" 3093 }, 3094 { 3095 "target": "com.amazonaws.kafka#ServiceUnavailableException" 3096 }, 3097 { 3098 "target": "com.amazonaws.kafka#TooManyRequestsException" 3099 }, 3100 { 3101 "target": "com.amazonaws.kafka#UnauthorizedException" 3102 } 3103 ], 3104 "traits": { 3105 "smithy.api#documentation": "Reboots brokers.", 3106 "smithy.api#http": { 3107 "method": "PUT", 3108 "uri": "/v1/clusters/{ClusterArn}/reboot-broker", 3109 "code": 200 3110 } 3111 } 3112 }, 3113 "com.amazonaws.kafka#RebootBrokerRequest": { 3114 "type": "structure", 3115 "members": { 3116 "BrokerIds": { 3117 "target": "com.amazonaws.kafka#__listOf__string", 3118 "traits": { 3119 "smithy.api#documentation": "<p>The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.</p>", 3120 "smithy.api#jsonName": "brokerIds", 3121 "smithy.api#required": {} 3122 } 3123 }, 3124 "ClusterArn": { 3125 "target": "com.amazonaws.kafka#__string", 3126 "traits": { 3127 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>", 3128 "smithy.api#httpLabel": {}, 3129 "smithy.api#required": {} 3130 } 3131 } 3132 }, 3133 "traits": { 3134 "smithy.api#documentation": "Reboots a node." 3135 } 3136 }, 3137 "com.amazonaws.kafka#RebootBrokerResponse": { 3138 "type": "structure", 3139 "members": { 3140 "ClusterArn": { 3141 "target": "com.amazonaws.kafka#__string", 3142 "traits": { 3143 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 3144 "smithy.api#jsonName": "clusterArn" 3145 } 3146 }, 3147 "ClusterOperationArn": { 3148 "target": "com.amazonaws.kafka#__string", 3149 "traits": { 3150 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>", 3151 "smithy.api#jsonName": "clusterOperationArn" 3152 } 3153 } 3154 } 3155 }, 3156 "com.amazonaws.kafka#S3": { 3157 "type": "structure", 3158 "members": { 3159 "Bucket": { 3160 "target": "com.amazonaws.kafka#__string", 3161 "traits": { 3162 "smithy.api#jsonName": "bucket" 3163 } 3164 }, 3165 "Enabled": { 3166 "target": "com.amazonaws.kafka#__boolean", 3167 "traits": { 3168 "smithy.api#jsonName": "enabled", 3169 "smithy.api#required": {} 3170 } 3171 }, 3172 "Prefix": { 3173 "target": "com.amazonaws.kafka#__string", 3174 "traits": { 3175 "smithy.api#jsonName": "prefix" 3176 } 3177 } 3178 } 3179 }, 3180 "com.amazonaws.kafka#Sasl": { 3181 "type": "structure", 3182 "members": { 3183 "Scram": { 3184 "target": "com.amazonaws.kafka#Scram", 3185 "traits": { 3186 "smithy.api#documentation": "<p>Details for SASL/SCRAM client authentication.</p>", 3187 "smithy.api#jsonName": "scram" 3188 } 3189 } 3190 }, 3191 "traits": { 3192 "smithy.api#documentation": "<p>Details for client authentication using SASL.</p>" 3193 } 3194 }, 3195 "com.amazonaws.kafka#Scram": { 3196 "type": "structure", 3197 "members": { 3198 "Enabled": { 3199 "target": "com.amazonaws.kafka#__boolean", 3200 "traits": { 3201 "smithy.api#documentation": "<p>SASL/SCRAM authentication is enabled or not.</p>", 3202 "smithy.api#jsonName": "enabled" 3203 } 3204 } 3205 }, 3206 "traits": { 3207 "smithy.api#documentation": "<p>Details for SASL/SCRAM client authentication.</p>" 3208 } 3209 }, 3210 "com.amazonaws.kafka#ServiceUnavailableException": { 3211 "type": "structure", 3212 "members": { 3213 "InvalidParameter": { 3214 "target": "com.amazonaws.kafka#__string", 3215 "traits": { 3216 "smithy.api#documentation": "<p>The parameter that caused the error.</p>", 3217 "smithy.api#jsonName": "invalidParameter" 3218 } 3219 }, 3220 "Message": { 3221 "target": "com.amazonaws.kafka#__string", 3222 "traits": { 3223 "smithy.api#documentation": "<p>The description of the error.</p>", 3224 "smithy.api#jsonName": "message" 3225 } 3226 } 3227 }, 3228 "traits": { 3229 "smithy.api#documentation": "<p>Returns information about an error.</p>", 3230 "smithy.api#error": "server", 3231 "smithy.api#httpError": 503 3232 } 3233 }, 3234 "com.amazonaws.kafka#StateInfo": { 3235 "type": "structure", 3236 "members": { 3237 "Code": { 3238 "target": "com.amazonaws.kafka#__string", 3239 "traits": { 3240 "smithy.api#jsonName": "code" 3241 } 3242 }, 3243 "Message": { 3244 "target": "com.amazonaws.kafka#__string", 3245 "traits": { 3246 "smithy.api#jsonName": "message" 3247 } 3248 } 3249 } 3250 }, 3251 "com.amazonaws.kafka#StorageInfo": { 3252 "type": "structure", 3253 "members": { 3254 "EbsStorageInfo": { 3255 "target": "com.amazonaws.kafka#EBSStorageInfo", 3256 "traits": { 3257 "smithy.api#documentation": "<p>EBS volume information.</p>", 3258 "smithy.api#jsonName": "ebsStorageInfo" 3259 } 3260 } 3261 }, 3262 "traits": { 3263 "smithy.api#documentation": "<p>Contains information about storage volumes attached to MSK broker nodes.</p>" 3264 } 3265 }, 3266 "com.amazonaws.kafka#TagResource": { 3267 "type": "operation", 3268 "input": { 3269 "target": "com.amazonaws.kafka#TagResourceRequest" 3270 }, 3271 "errors": [ 3272 { 3273 "target": "com.amazonaws.kafka#BadRequestException" 3274 }, 3275 { 3276 "target": "com.amazonaws.kafka#InternalServerErrorException" 3277 }, 3278 { 3279 "target": "com.amazonaws.kafka#NotFoundException" 3280 } 3281 ], 3282 "traits": { 3283 "smithy.api#documentation": "<p>Adds tags to the specified MSK resource.</p>", 3284 "smithy.api#http": { 3285 "method": "POST", 3286 "uri": "/v1/tags/{ResourceArn}", 3287 "code": 204 3288 } 3289 } 3290 }, 3291 "com.amazonaws.kafka#TagResourceRequest": { 3292 "type": "structure", 3293 "members": { 3294 "ResourceArn": { 3295 "target": "com.amazonaws.kafka#__string", 3296 "traits": { 3297 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</p>", 3298 "smithy.api#httpLabel": {}, 3299 "smithy.api#required": {} 3300 } 3301 }, 3302 "Tags": { 3303 "target": "com.amazonaws.kafka#__mapOf__string", 3304 "traits": { 3305 "smithy.api#documentation": "<p>The key-value pair for the resource tag.</p>", 3306 "smithy.api#jsonName": "tags", 3307 "smithy.api#required": {} 3308 } 3309 } 3310 } 3311 }, 3312 "com.amazonaws.kafka#Tls": { 3313 "type": "structure", 3314 "members": { 3315 "CertificateAuthorityArnList": { 3316 "target": "com.amazonaws.kafka#__listOf__string", 3317 "traits": { 3318 "smithy.api#documentation": "<p>List of ACM Certificate Authority ARNs.</p>", 3319 "smithy.api#jsonName": "certificateAuthorityArnList" 3320 } 3321 } 3322 }, 3323 "traits": { 3324 "smithy.api#documentation": "<p>Details for client authentication using TLS.</p>" 3325 } 3326 }, 3327 "com.amazonaws.kafka#TooManyRequestsException": { 3328 "type": "structure", 3329 "members": { 3330 "InvalidParameter": { 3331 "target": "com.amazonaws.kafka#__string", 3332 "traits": { 3333 "smithy.api#documentation": "<p>The parameter that caused the error.</p>", 3334 "smithy.api#jsonName": "invalidParameter" 3335 } 3336 }, 3337 "Message": { 3338 "target": "com.amazonaws.kafka#__string", 3339 "traits": { 3340 "smithy.api#documentation": "<p>The description of the error.</p>", 3341 "smithy.api#jsonName": "message" 3342 } 3343 } 3344 }, 3345 "traits": { 3346 "smithy.api#documentation": "<p>Returns information about an error.</p>", 3347 "smithy.api#error": "client", 3348 "smithy.api#httpError": 429 3349 } 3350 }, 3351 "com.amazonaws.kafka#UnauthorizedException": { 3352 "type": "structure", 3353 "members": { 3354 "InvalidParameter": { 3355 "target": "com.amazonaws.kafka#__string", 3356 "traits": { 3357 "smithy.api#documentation": "<p>The parameter that caused the error.</p>", 3358 "smithy.api#jsonName": "invalidParameter" 3359 } 3360 }, 3361 "Message": { 3362 "target": "com.amazonaws.kafka#__string", 3363 "traits": { 3364 "smithy.api#documentation": "<p>The description of the error.</p>", 3365 "smithy.api#jsonName": "message" 3366 } 3367 } 3368 }, 3369 "traits": { 3370 "smithy.api#documentation": "<p>Returns information about an error.</p>", 3371 "smithy.api#error": "client", 3372 "smithy.api#httpError": 401 3373 } 3374 }, 3375 "com.amazonaws.kafka#UnprocessedScramSecret": { 3376 "type": "structure", 3377 "members": { 3378 "ErrorCode": { 3379 "target": "com.amazonaws.kafka#__string", 3380 "traits": { 3381 "smithy.api#documentation": "<p>Error code for associate/disassociate failure.</p>", 3382 "smithy.api#jsonName": "errorCode" 3383 } 3384 }, 3385 "ErrorMessage": { 3386 "target": "com.amazonaws.kafka#__string", 3387 "traits": { 3388 "smithy.api#documentation": "<p>Error message for associate/disassociate failure.</p>", 3389 "smithy.api#jsonName": "errorMessage" 3390 } 3391 }, 3392 "SecretArn": { 3393 "target": "com.amazonaws.kafka#__string", 3394 "traits": { 3395 "smithy.api#documentation": "<p>AWS Secrets Manager secret ARN.</p>", 3396 "smithy.api#jsonName": "secretArn" 3397 } 3398 } 3399 }, 3400 "traits": { 3401 "smithy.api#documentation": "<p>Error info for scram secret associate/disassociate failure.</p>" 3402 } 3403 }, 3404 "com.amazonaws.kafka#UntagResource": { 3405 "type": "operation", 3406 "input": { 3407 "target": "com.amazonaws.kafka#UntagResourceRequest" 3408 }, 3409 "errors": [ 3410 { 3411 "target": "com.amazonaws.kafka#BadRequestException" 3412 }, 3413 { 3414 "target": "com.amazonaws.kafka#InternalServerErrorException" 3415 }, 3416 { 3417 "target": "com.amazonaws.kafka#NotFoundException" 3418 } 3419 ], 3420 "traits": { 3421 "smithy.api#documentation": "<p>Removes the tags associated with the keys that are provided in the query.</p>", 3422 "smithy.api#http": { 3423 "method": "DELETE", 3424 "uri": "/v1/tags/{ResourceArn}", 3425 "code": 204 3426 } 3427 } 3428 }, 3429 "com.amazonaws.kafka#UntagResourceRequest": { 3430 "type": "structure", 3431 "members": { 3432 "ResourceArn": { 3433 "target": "com.amazonaws.kafka#__string", 3434 "traits": { 3435 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.</p>", 3436 "smithy.api#httpLabel": {}, 3437 "smithy.api#required": {} 3438 } 3439 }, 3440 "TagKeys": { 3441 "target": "com.amazonaws.kafka#__listOf__string", 3442 "traits": { 3443 "smithy.api#documentation": "<p>Tag keys must be unique for a given cluster. In addition, the following restrictions apply:</p>\n <ul>\n <li>\n <p>Each tag key must be unique. If you add a tag with a key that's already in\n use, your new tag overwrites the existing key-value pair. </p>\n </li>\n <li>\n <p>You can't start a tag key with aws: because this prefix is reserved for use\n by AWS. AWS creates tags that begin with this prefix on your behalf, but\n you can't edit or delete them.</p>\n </li>\n <li>\n <p>Tag keys must be between 1 and 128 Unicode characters in length.</p>\n </li>\n <li>\n <p>Tag keys must consist of the following characters: Unicode letters, digits,\n white space, and the following special characters: _ . / = + -\n @.</p>\n </li>\n </ul>", 3444 "smithy.api#httpQuery": "tagKeys", 3445 "smithy.api#required": {} 3446 } 3447 } 3448 } 3449 }, 3450 "com.amazonaws.kafka#UpdateBrokerCount": { 3451 "type": "operation", 3452 "input": { 3453 "target": "com.amazonaws.kafka#UpdateBrokerCountRequest" 3454 }, 3455 "output": { 3456 "target": "com.amazonaws.kafka#UpdateBrokerCountResponse" 3457 }, 3458 "errors": [ 3459 { 3460 "target": "com.amazonaws.kafka#BadRequestException" 3461 }, 3462 { 3463 "target": "com.amazonaws.kafka#ForbiddenException" 3464 }, 3465 { 3466 "target": "com.amazonaws.kafka#InternalServerErrorException" 3467 }, 3468 { 3469 "target": "com.amazonaws.kafka#ServiceUnavailableException" 3470 }, 3471 { 3472 "target": "com.amazonaws.kafka#UnauthorizedException" 3473 } 3474 ], 3475 "traits": { 3476 "smithy.api#documentation": "<p>Updates the number of broker nodes in the cluster.</p>", 3477 "smithy.api#http": { 3478 "method": "PUT", 3479 "uri": "/v1/clusters/{ClusterArn}/nodes/count", 3480 "code": 200 3481 } 3482 } 3483 }, 3484 "com.amazonaws.kafka#UpdateBrokerCountRequest": { 3485 "type": "structure", 3486 "members": { 3487 "ClusterArn": { 3488 "target": "com.amazonaws.kafka#__string", 3489 "traits": { 3490 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 3491 "smithy.api#httpLabel": {}, 3492 "smithy.api#required": {} 3493 } 3494 }, 3495 "CurrentVersion": { 3496 "target": "com.amazonaws.kafka#__string", 3497 "traits": { 3498 "smithy.api#documentation": "<p>The version of cluster to update from. A successful operation will then generate a new version.</p>", 3499 "smithy.api#jsonName": "currentVersion", 3500 "smithy.api#required": {} 3501 } 3502 }, 3503 "TargetNumberOfBrokerNodes": { 3504 "target": "com.amazonaws.kafka#__integerMin1Max15", 3505 "traits": { 3506 "smithy.api#documentation": "<p>The number of broker nodes that you want the cluster to have after this operation completes successfully.</p>", 3507 "smithy.api#jsonName": "targetNumberOfBrokerNodes", 3508 "smithy.api#required": {} 3509 } 3510 } 3511 } 3512 }, 3513 "com.amazonaws.kafka#UpdateBrokerCountResponse": { 3514 "type": "structure", 3515 "members": { 3516 "ClusterArn": { 3517 "target": "com.amazonaws.kafka#__string", 3518 "traits": { 3519 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 3520 "smithy.api#jsonName": "clusterArn" 3521 } 3522 }, 3523 "ClusterOperationArn": { 3524 "target": "com.amazonaws.kafka#__string", 3525 "traits": { 3526 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>", 3527 "smithy.api#jsonName": "clusterOperationArn" 3528 } 3529 } 3530 } 3531 }, 3532 "com.amazonaws.kafka#UpdateBrokerStorage": { 3533 "type": "operation", 3534 "input": { 3535 "target": "com.amazonaws.kafka#UpdateBrokerStorageRequest" 3536 }, 3537 "output": { 3538 "target": "com.amazonaws.kafka#UpdateBrokerStorageResponse" 3539 }, 3540 "errors": [ 3541 { 3542 "target": "com.amazonaws.kafka#BadRequestException" 3543 }, 3544 { 3545 "target": "com.amazonaws.kafka#ForbiddenException" 3546 }, 3547 { 3548 "target": "com.amazonaws.kafka#InternalServerErrorException" 3549 }, 3550 { 3551 "target": "com.amazonaws.kafka#ServiceUnavailableException" 3552 }, 3553 { 3554 "target": "com.amazonaws.kafka#UnauthorizedException" 3555 } 3556 ], 3557 "traits": { 3558 "smithy.api#documentation": "<p>Updates the EBS storage associated with MSK brokers.</p>", 3559 "smithy.api#http": { 3560 "method": "PUT", 3561 "uri": "/v1/clusters/{ClusterArn}/nodes/storage", 3562 "code": 200 3563 } 3564 } 3565 }, 3566 "com.amazonaws.kafka#UpdateBrokerStorageRequest": { 3567 "type": "structure", 3568 "members": { 3569 "ClusterArn": { 3570 "target": "com.amazonaws.kafka#__string", 3571 "traits": { 3572 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 3573 "smithy.api#httpLabel": {}, 3574 "smithy.api#required": {} 3575 } 3576 }, 3577 "CurrentVersion": { 3578 "target": "com.amazonaws.kafka#__string", 3579 "traits": { 3580 "smithy.api#documentation": "<p>The version of cluster to update from. A successful operation will then generate a new version.</p>", 3581 "smithy.api#jsonName": "currentVersion", 3582 "smithy.api#required": {} 3583 } 3584 }, 3585 "TargetBrokerEBSVolumeInfo": { 3586 "target": "com.amazonaws.kafka#__listOfBrokerEBSVolumeInfo", 3587 "traits": { 3588 "smithy.api#documentation": "<p>Describes the target volume size and the ID of the broker to apply the update to.</p>", 3589 "smithy.api#jsonName": "targetBrokerEBSVolumeInfo", 3590 "smithy.api#required": {} 3591 } 3592 } 3593 } 3594 }, 3595 "com.amazonaws.kafka#UpdateBrokerStorageResponse": { 3596 "type": "structure", 3597 "members": { 3598 "ClusterArn": { 3599 "target": "com.amazonaws.kafka#__string", 3600 "traits": { 3601 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 3602 "smithy.api#jsonName": "clusterArn" 3603 } 3604 }, 3605 "ClusterOperationArn": { 3606 "target": "com.amazonaws.kafka#__string", 3607 "traits": { 3608 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>", 3609 "smithy.api#jsonName": "clusterOperationArn" 3610 } 3611 } 3612 } 3613 }, 3614 "com.amazonaws.kafka#UpdateBrokerType": { 3615 "type": "operation", 3616 "input": { 3617 "target": "com.amazonaws.kafka#UpdateBrokerTypeRequest" 3618 }, 3619 "output": { 3620 "target": "com.amazonaws.kafka#UpdateBrokerTypeResponse" 3621 }, 3622 "errors": [ 3623 { 3624 "target": "com.amazonaws.kafka#BadRequestException" 3625 }, 3626 { 3627 "target": "com.amazonaws.kafka#ForbiddenException" 3628 }, 3629 { 3630 "target": "com.amazonaws.kafka#InternalServerErrorException" 3631 }, 3632 { 3633 "target": "com.amazonaws.kafka#NotFoundException" 3634 }, 3635 { 3636 "target": "com.amazonaws.kafka#ServiceUnavailableException" 3637 }, 3638 { 3639 "target": "com.amazonaws.kafka#TooManyRequestsException" 3640 }, 3641 { 3642 "target": "com.amazonaws.kafka#UnauthorizedException" 3643 } 3644 ], 3645 "traits": { 3646 "smithy.api#documentation": "<p>Updates EC2 instance type.</p>", 3647 "smithy.api#http": { 3648 "method": "PUT", 3649 "uri": "/v1/clusters/{ClusterArn}/nodes/type", 3650 "code": 200 3651 } 3652 } 3653 }, 3654 "com.amazonaws.kafka#UpdateBrokerTypeRequest": { 3655 "type": "structure", 3656 "members": { 3657 "ClusterArn": { 3658 "target": "com.amazonaws.kafka#__string", 3659 "traits": { 3660 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 3661 "smithy.api#httpLabel": {}, 3662 "smithy.api#required": {} 3663 } 3664 }, 3665 "CurrentVersion": { 3666 "target": "com.amazonaws.kafka#__string", 3667 "traits": { 3668 "smithy.api#documentation": "<p>The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.</p>", 3669 "smithy.api#jsonName": "currentVersion", 3670 "smithy.api#required": {} 3671 } 3672 }, 3673 "TargetInstanceType": { 3674 "target": "com.amazonaws.kafka#__string", 3675 "traits": { 3676 "smithy.api#documentation": "<p>The Amazon MSK broker type that you want all of the brokers in this cluster to be.</p>", 3677 "smithy.api#jsonName": "targetInstanceType", 3678 "smithy.api#required": {} 3679 } 3680 } 3681 } 3682 }, 3683 "com.amazonaws.kafka#UpdateBrokerTypeResponse": { 3684 "type": "structure", 3685 "members": { 3686 "ClusterArn": { 3687 "target": "com.amazonaws.kafka#__string", 3688 "traits": { 3689 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 3690 "smithy.api#jsonName": "clusterArn" 3691 } 3692 }, 3693 "ClusterOperationArn": { 3694 "target": "com.amazonaws.kafka#__string", 3695 "traits": { 3696 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>", 3697 "smithy.api#jsonName": "clusterOperationArn" 3698 } 3699 } 3700 } 3701 }, 3702 "com.amazonaws.kafka#UpdateClusterConfiguration": { 3703 "type": "operation", 3704 "input": { 3705 "target": "com.amazonaws.kafka#UpdateClusterConfigurationRequest" 3706 }, 3707 "output": { 3708 "target": "com.amazonaws.kafka#UpdateClusterConfigurationResponse" 3709 }, 3710 "errors": [ 3711 { 3712 "target": "com.amazonaws.kafka#BadRequestException" 3713 }, 3714 { 3715 "target": "com.amazonaws.kafka#ForbiddenException" 3716 }, 3717 { 3718 "target": "com.amazonaws.kafka#InternalServerErrorException" 3719 }, 3720 { 3721 "target": "com.amazonaws.kafka#NotFoundException" 3722 }, 3723 { 3724 "target": "com.amazonaws.kafka#ServiceUnavailableException" 3725 }, 3726 { 3727 "target": "com.amazonaws.kafka#UnauthorizedException" 3728 } 3729 ], 3730 "traits": { 3731 "smithy.api#documentation": "<p>Updates the cluster with the configuration that is specified in the request body.</p>", 3732 "smithy.api#http": { 3733 "method": "PUT", 3734 "uri": "/v1/clusters/{ClusterArn}/configuration", 3735 "code": 200 3736 } 3737 } 3738 }, 3739 "com.amazonaws.kafka#UpdateClusterConfigurationRequest": { 3740 "type": "structure", 3741 "members": { 3742 "ClusterArn": { 3743 "target": "com.amazonaws.kafka#__string", 3744 "traits": { 3745 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 3746 "smithy.api#httpLabel": {}, 3747 "smithy.api#required": {} 3748 } 3749 }, 3750 "ConfigurationInfo": { 3751 "target": "com.amazonaws.kafka#ConfigurationInfo", 3752 "traits": { 3753 "smithy.api#documentation": "<p>Represents the configuration that you want MSK to use for the brokers in a cluster.</p>", 3754 "smithy.api#jsonName": "configurationInfo", 3755 "smithy.api#required": {} 3756 } 3757 }, 3758 "CurrentVersion": { 3759 "target": "com.amazonaws.kafka#__string", 3760 "traits": { 3761 "smithy.api#documentation": "<p>The version of the cluster that needs to be updated.</p>", 3762 "smithy.api#jsonName": "currentVersion", 3763 "smithy.api#required": {} 3764 } 3765 } 3766 } 3767 }, 3768 "com.amazonaws.kafka#UpdateClusterConfigurationResponse": { 3769 "type": "structure", 3770 "members": { 3771 "ClusterArn": { 3772 "target": "com.amazonaws.kafka#__string", 3773 "traits": { 3774 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 3775 "smithy.api#jsonName": "clusterArn" 3776 } 3777 }, 3778 "ClusterOperationArn": { 3779 "target": "com.amazonaws.kafka#__string", 3780 "traits": { 3781 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>", 3782 "smithy.api#jsonName": "clusterOperationArn" 3783 } 3784 } 3785 } 3786 }, 3787 "com.amazonaws.kafka#UpdateClusterKafkaVersion": { 3788 "type": "operation", 3789 "input": { 3790 "target": "com.amazonaws.kafka#UpdateClusterKafkaVersionRequest" 3791 }, 3792 "output": { 3793 "target": "com.amazonaws.kafka#UpdateClusterKafkaVersionResponse" 3794 }, 3795 "errors": [ 3796 { 3797 "target": "com.amazonaws.kafka#BadRequestException" 3798 }, 3799 { 3800 "target": "com.amazonaws.kafka#ForbiddenException" 3801 }, 3802 { 3803 "target": "com.amazonaws.kafka#InternalServerErrorException" 3804 }, 3805 { 3806 "target": "com.amazonaws.kafka#NotFoundException" 3807 }, 3808 { 3809 "target": "com.amazonaws.kafka#ServiceUnavailableException" 3810 }, 3811 { 3812 "target": "com.amazonaws.kafka#TooManyRequestsException" 3813 }, 3814 { 3815 "target": "com.amazonaws.kafka#UnauthorizedException" 3816 } 3817 ], 3818 "traits": { 3819 "smithy.api#documentation": "<p>Updates the Apache Kafka version for the cluster.</p>", 3820 "smithy.api#http": { 3821 "method": "PUT", 3822 "uri": "/v1/clusters/{ClusterArn}/version", 3823 "code": 200 3824 } 3825 } 3826 }, 3827 "com.amazonaws.kafka#UpdateClusterKafkaVersionRequest": { 3828 "type": "structure", 3829 "members": { 3830 "ClusterArn": { 3831 "target": "com.amazonaws.kafka#__string", 3832 "traits": { 3833 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster to be updated.</p>", 3834 "smithy.api#httpLabel": {}, 3835 "smithy.api#required": {} 3836 } 3837 }, 3838 "ConfigurationInfo": { 3839 "target": "com.amazonaws.kafka#ConfigurationInfo", 3840 "traits": { 3841 "smithy.api#documentation": "<p>The custom configuration that should be applied on the new version of cluster.</p>", 3842 "smithy.api#jsonName": "configurationInfo" 3843 } 3844 }, 3845 "CurrentVersion": { 3846 "target": "com.amazonaws.kafka#__string", 3847 "traits": { 3848 "smithy.api#documentation": "<p>Current cluster version.</p>", 3849 "smithy.api#jsonName": "currentVersion", 3850 "smithy.api#required": {} 3851 } 3852 }, 3853 "TargetKafkaVersion": { 3854 "target": "com.amazonaws.kafka#__string", 3855 "traits": { 3856 "smithy.api#documentation": "<p>Target Kafka version.</p>", 3857 "smithy.api#jsonName": "targetKafkaVersion", 3858 "smithy.api#required": {} 3859 } 3860 } 3861 } 3862 }, 3863 "com.amazonaws.kafka#UpdateClusterKafkaVersionResponse": { 3864 "type": "structure", 3865 "members": { 3866 "ClusterArn": { 3867 "target": "com.amazonaws.kafka#__string", 3868 "traits": { 3869 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 3870 "smithy.api#jsonName": "clusterArn" 3871 } 3872 }, 3873 "ClusterOperationArn": { 3874 "target": "com.amazonaws.kafka#__string", 3875 "traits": { 3876 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>", 3877 "smithy.api#jsonName": "clusterOperationArn" 3878 } 3879 } 3880 } 3881 }, 3882 "com.amazonaws.kafka#UpdateConfiguration": { 3883 "type": "operation", 3884 "input": { 3885 "target": "com.amazonaws.kafka#UpdateConfigurationRequest" 3886 }, 3887 "output": { 3888 "target": "com.amazonaws.kafka#UpdateConfigurationResponse" 3889 }, 3890 "errors": [ 3891 { 3892 "target": "com.amazonaws.kafka#BadRequestException" 3893 }, 3894 { 3895 "target": "com.amazonaws.kafka#ForbiddenException" 3896 }, 3897 { 3898 "target": "com.amazonaws.kafka#InternalServerErrorException" 3899 }, 3900 { 3901 "target": "com.amazonaws.kafka#NotFoundException" 3902 }, 3903 { 3904 "target": "com.amazonaws.kafka#ServiceUnavailableException" 3905 }, 3906 { 3907 "target": "com.amazonaws.kafka#UnauthorizedException" 3908 } 3909 ], 3910 "traits": { 3911 "smithy.api#documentation": "<p>Updates an MSK configuration.</p>", 3912 "smithy.api#http": { 3913 "method": "PUT", 3914 "uri": "/v1/configurations/{Arn}", 3915 "code": 200 3916 } 3917 } 3918 }, 3919 "com.amazonaws.kafka#UpdateConfigurationRequest": { 3920 "type": "structure", 3921 "members": { 3922 "Arn": { 3923 "target": "com.amazonaws.kafka#__string", 3924 "traits": { 3925 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the configuration.</p>", 3926 "smithy.api#httpLabel": {}, 3927 "smithy.api#required": {} 3928 } 3929 }, 3930 "Description": { 3931 "target": "com.amazonaws.kafka#__string", 3932 "traits": { 3933 "smithy.api#documentation": "<p>The description of the configuration revision.</p>", 3934 "smithy.api#jsonName": "description" 3935 } 3936 }, 3937 "ServerProperties": { 3938 "target": "com.amazonaws.kafka#__blob", 3939 "traits": { 3940 "smithy.api#documentation": "<p>Contents of the <filename>server.properties</filename> file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of <filename>server.properties</filename> can be in plaintext.</p>", 3941 "smithy.api#jsonName": "serverProperties", 3942 "smithy.api#required": {} 3943 } 3944 } 3945 } 3946 }, 3947 "com.amazonaws.kafka#UpdateConfigurationResponse": { 3948 "type": "structure", 3949 "members": { 3950 "Arn": { 3951 "target": "com.amazonaws.kafka#__string", 3952 "traits": { 3953 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the configuration.</p>", 3954 "smithy.api#jsonName": "arn" 3955 } 3956 }, 3957 "LatestRevision": { 3958 "target": "com.amazonaws.kafka#ConfigurationRevision", 3959 "traits": { 3960 "smithy.api#documentation": "<p>Latest revision of the configuration.</p>", 3961 "smithy.api#jsonName": "latestRevision" 3962 } 3963 } 3964 } 3965 }, 3966 "com.amazonaws.kafka#UpdateMonitoring": { 3967 "type": "operation", 3968 "input": { 3969 "target": "com.amazonaws.kafka#UpdateMonitoringRequest" 3970 }, 3971 "output": { 3972 "target": "com.amazonaws.kafka#UpdateMonitoringResponse" 3973 }, 3974 "errors": [ 3975 { 3976 "target": "com.amazonaws.kafka#BadRequestException" 3977 }, 3978 { 3979 "target": "com.amazonaws.kafka#ForbiddenException" 3980 }, 3981 { 3982 "target": "com.amazonaws.kafka#InternalServerErrorException" 3983 }, 3984 { 3985 "target": "com.amazonaws.kafka#ServiceUnavailableException" 3986 }, 3987 { 3988 "target": "com.amazonaws.kafka#UnauthorizedException" 3989 } 3990 ], 3991 "traits": { 3992 "smithy.api#documentation": "<p>Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.</p>", 3993 "smithy.api#http": { 3994 "method": "PUT", 3995 "uri": "/v1/clusters/{ClusterArn}/monitoring", 3996 "code": 200 3997 } 3998 } 3999 }, 4000 "com.amazonaws.kafka#UpdateMonitoringRequest": { 4001 "type": "structure", 4002 "members": { 4003 "ClusterArn": { 4004 "target": "com.amazonaws.kafka#__string", 4005 "traits": { 4006 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>", 4007 "smithy.api#httpLabel": {}, 4008 "smithy.api#required": {} 4009 } 4010 }, 4011 "CurrentVersion": { 4012 "target": "com.amazonaws.kafka#__string", 4013 "traits": { 4014 "smithy.api#documentation": "<p>The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.</p>", 4015 "smithy.api#jsonName": "currentVersion", 4016 "smithy.api#required": {} 4017 } 4018 }, 4019 "EnhancedMonitoring": { 4020 "target": "com.amazonaws.kafka#EnhancedMonitoring", 4021 "traits": { 4022 "smithy.api#documentation": "<p>Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.</p>", 4023 "smithy.api#jsonName": "enhancedMonitoring" 4024 } 4025 }, 4026 "OpenMonitoring": { 4027 "target": "com.amazonaws.kafka#OpenMonitoringInfo", 4028 "traits": { 4029 "smithy.api#documentation": "<p>The settings for open monitoring.</p>", 4030 "smithy.api#jsonName": "openMonitoring" 4031 } 4032 }, 4033 "LoggingInfo": { 4034 "target": "com.amazonaws.kafka#LoggingInfo", 4035 "traits": { 4036 "smithy.api#jsonName": "loggingInfo" 4037 } 4038 } 4039 }, 4040 "traits": { 4041 "smithy.api#documentation": "Request body for UpdateMonitoring." 4042 } 4043 }, 4044 "com.amazonaws.kafka#UpdateMonitoringResponse": { 4045 "type": "structure", 4046 "members": { 4047 "ClusterArn": { 4048 "target": "com.amazonaws.kafka#__string", 4049 "traits": { 4050 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster.</p>", 4051 "smithy.api#jsonName": "clusterArn" 4052 } 4053 }, 4054 "ClusterOperationArn": { 4055 "target": "com.amazonaws.kafka#__string", 4056 "traits": { 4057 "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the cluster operation.</p>", 4058 "smithy.api#jsonName": "clusterOperationArn" 4059 } 4060 } 4061 } 4062 }, 4063 "com.amazonaws.kafka#ZookeeperNodeInfo": { 4064 "type": "structure", 4065 "members": { 4066 "AttachedENIId": { 4067 "target": "com.amazonaws.kafka#__string", 4068 "traits": { 4069 "smithy.api#documentation": "<p>The attached elastic network interface of the broker.</p>", 4070 "smithy.api#jsonName": "attachedENIId" 4071 } 4072 }, 4073 "ClientVpcIpAddress": { 4074 "target": "com.amazonaws.kafka#__string", 4075 "traits": { 4076 "smithy.api#documentation": "<p>The virtual private cloud (VPC) IP address of the client.</p>", 4077 "smithy.api#jsonName": "clientVpcIpAddress" 4078 } 4079 }, 4080 "Endpoints": { 4081 "target": "com.amazonaws.kafka#__listOf__string", 4082 "traits": { 4083 "smithy.api#documentation": "<p>Endpoints for accessing the ZooKeeper.</p>", 4084 "smithy.api#jsonName": "endpoints" 4085 } 4086 }, 4087 "ZookeeperId": { 4088 "target": "com.amazonaws.kafka#__double", 4089 "traits": { 4090 "smithy.api#documentation": "<p>The role-specific ID for Zookeeper.</p>", 4091 "smithy.api#jsonName": "zookeeperId" 4092 } 4093 }, 4094 "ZookeeperVersion": { 4095 "target": "com.amazonaws.kafka#__string", 4096 "traits": { 4097 "smithy.api#documentation": "<p>The version of Zookeeper.</p>", 4098 "smithy.api#jsonName": "zookeeperVersion" 4099 } 4100 } 4101 }, 4102 "traits": { 4103 "smithy.api#documentation": "<p>Zookeeper node information.</p>" 4104 } 4105 }, 4106 "com.amazonaws.kafka#__blob": { 4107 "type": "blob" 4108 }, 4109 "com.amazonaws.kafka#__boolean": { 4110 "type": "boolean" 4111 }, 4112 "com.amazonaws.kafka#__double": { 4113 "type": "double" 4114 }, 4115 "com.amazonaws.kafka#__integer": { 4116 "type": "integer" 4117 }, 4118 "com.amazonaws.kafka#__integerMin1Max15": { 4119 "type": "integer", 4120 "traits": { 4121 "smithy.api#range": { 4122 "min": 1, 4123 "max": 15 4124 } 4125 } 4126 }, 4127 "com.amazonaws.kafka#__integerMin1Max16384": { 4128 "type": "integer", 4129 "traits": { 4130 "smithy.api#range": { 4131 "min": 1, 4132 "max": 16384 4133 } 4134 } 4135 }, 4136 "com.amazonaws.kafka#__listOfBrokerEBSVolumeInfo": { 4137 "type": "list", 4138 "member": { 4139 "target": "com.amazonaws.kafka#BrokerEBSVolumeInfo" 4140 } 4141 }, 4142 "com.amazonaws.kafka#__listOfClusterInfo": { 4143 "type": "list", 4144 "member": { 4145 "target": "com.amazonaws.kafka#ClusterInfo" 4146 } 4147 }, 4148 "com.amazonaws.kafka#__listOfClusterOperationInfo": { 4149 "type": "list", 4150 "member": { 4151 "target": "com.amazonaws.kafka#ClusterOperationInfo" 4152 } 4153 }, 4154 "com.amazonaws.kafka#__listOfClusterOperationStep": { 4155 "type": "list", 4156 "member": { 4157 "target": "com.amazonaws.kafka#ClusterOperationStep" 4158 } 4159 }, 4160 "com.amazonaws.kafka#__listOfCompatibleKafkaVersion": { 4161 "type": "list", 4162 "member": { 4163 "target": "com.amazonaws.kafka#CompatibleKafkaVersion" 4164 } 4165 }, 4166 "com.amazonaws.kafka#__listOfConfiguration": { 4167 "type": "list", 4168 "member": { 4169 "target": "com.amazonaws.kafka#Configuration" 4170 } 4171 }, 4172 "com.amazonaws.kafka#__listOfConfigurationRevision": { 4173 "type": "list", 4174 "member": { 4175 "target": "com.amazonaws.kafka#ConfigurationRevision" 4176 } 4177 }, 4178 "com.amazonaws.kafka#__listOfKafkaVersion": { 4179 "type": "list", 4180 "member": { 4181 "target": "com.amazonaws.kafka#KafkaVersion" 4182 } 4183 }, 4184 "com.amazonaws.kafka#__listOfNodeInfo": { 4185 "type": "list", 4186 "member": { 4187 "target": "com.amazonaws.kafka#NodeInfo" 4188 } 4189 }, 4190 "com.amazonaws.kafka#__listOfUnprocessedScramSecret": { 4191 "type": "list", 4192 "member": { 4193 "target": "com.amazonaws.kafka#UnprocessedScramSecret" 4194 } 4195 }, 4196 "com.amazonaws.kafka#__listOf__string": { 4197 "type": "list", 4198 "member": { 4199 "target": "com.amazonaws.kafka#__string" 4200 } 4201 }, 4202 "com.amazonaws.kafka#__long": { 4203 "type": "long" 4204 }, 4205 "com.amazonaws.kafka#__mapOf__string": { 4206 "type": "map", 4207 "key": { 4208 "target": "com.amazonaws.kafka#__string" 4209 }, 4210 "value": { 4211 "target": "com.amazonaws.kafka#__string" 4212 } 4213 }, 4214 "com.amazonaws.kafka#__string": { 4215 "type": "string" 4216 }, 4217 "com.amazonaws.kafka#__stringMin1Max128": { 4218 "type": "string", 4219 "traits": { 4220 "smithy.api#length": { 4221 "min": 1, 4222 "max": 128 4223 } 4224 } 4225 }, 4226 "com.amazonaws.kafka#__stringMin1Max64": { 4227 "type": "string", 4228 "traits": { 4229 "smithy.api#length": { 4230 "min": 1, 4231 "max": 64 4232 } 4233 } 4234 }, 4235 "com.amazonaws.kafka#__stringMin5Max32": { 4236 "type": "string", 4237 "traits": { 4238 "smithy.api#length": { 4239 "min": 5, 4240 "max": 32 4241 } 4242 } 4243 }, 4244 "com.amazonaws.kafka#__timestampIso8601": { 4245 "type": "timestamp", 4246 "traits": { 4247 "smithy.api#timestampFormat": "date-time" 4248 } 4249 } 4250 } 4251} 4252