1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2021-04-28", 5 "endpointPrefix":"m2", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"AWSMainframeModernization", 9 "serviceId":"m2", 10 "signatureVersion":"v4", 11 "signingName":"m2", 12 "uid":"m2-2021-04-28" 13 }, 14 "operations":{ 15 "CancelBatchJobExecution":{ 16 "name":"CancelBatchJobExecution", 17 "http":{ 18 "method":"POST", 19 "requestUri":"/applications/{applicationId}/batch-job-executions/{executionId}/cancel", 20 "responseCode":200 21 }, 22 "input":{"shape":"CancelBatchJobExecutionRequest"}, 23 "output":{"shape":"CancelBatchJobExecutionResponse"}, 24 "errors":[ 25 {"shape":"ResourceNotFoundException"}, 26 {"shape":"ThrottlingException"}, 27 {"shape":"AccessDeniedException"}, 28 {"shape":"ConflictException"}, 29 {"shape":"ValidationException"}, 30 {"shape":"InternalServerException"} 31 ], 32 "documentation":"<p>Cancels the running of a specific batch job execution.</p>" 33 }, 34 "CreateApplication":{ 35 "name":"CreateApplication", 36 "http":{ 37 "method":"POST", 38 "requestUri":"/applications", 39 "responseCode":200 40 }, 41 "input":{"shape":"CreateApplicationRequest"}, 42 "output":{"shape":"CreateApplicationResponse"}, 43 "errors":[ 44 {"shape":"ServiceQuotaExceededException"}, 45 {"shape":"ThrottlingException"}, 46 {"shape":"AccessDeniedException"}, 47 {"shape":"ConflictException"}, 48 {"shape":"ValidationException"}, 49 {"shape":"InternalServerException"} 50 ], 51 "documentation":"<p>Creates a new application with given parameters. Requires an existing runtime environment and application definition file.</p>", 52 "idempotent":true 53 }, 54 "CreateDataSetImportTask":{ 55 "name":"CreateDataSetImportTask", 56 "http":{ 57 "method":"POST", 58 "requestUri":"/applications/{applicationId}/dataset-import-task", 59 "responseCode":200 60 }, 61 "input":{"shape":"CreateDataSetImportTaskRequest"}, 62 "output":{"shape":"CreateDataSetImportTaskResponse"}, 63 "errors":[ 64 {"shape":"ResourceNotFoundException"}, 65 {"shape":"ServiceQuotaExceededException"}, 66 {"shape":"ThrottlingException"}, 67 {"shape":"AccessDeniedException"}, 68 {"shape":"ConflictException"}, 69 {"shape":"ValidationException"}, 70 {"shape":"InternalServerException"} 71 ], 72 "documentation":"<p>Starts a data set import task for a specific application.</p>", 73 "idempotent":true 74 }, 75 "CreateDeployment":{ 76 "name":"CreateDeployment", 77 "http":{ 78 "method":"POST", 79 "requestUri":"/applications/{applicationId}/deployments", 80 "responseCode":200 81 }, 82 "input":{"shape":"CreateDeploymentRequest"}, 83 "output":{"shape":"CreateDeploymentResponse"}, 84 "errors":[ 85 {"shape":"ResourceNotFoundException"}, 86 {"shape":"ServiceQuotaExceededException"}, 87 {"shape":"ThrottlingException"}, 88 {"shape":"AccessDeniedException"}, 89 {"shape":"ConflictException"}, 90 {"shape":"ValidationException"}, 91 {"shape":"InternalServerException"} 92 ], 93 "documentation":"<p>Creates and starts a deployment to deploy an application into a runtime environment.</p>", 94 "idempotent":true 95 }, 96 "CreateEnvironment":{ 97 "name":"CreateEnvironment", 98 "http":{ 99 "method":"POST", 100 "requestUri":"/environments", 101 "responseCode":200 102 }, 103 "input":{"shape":"CreateEnvironmentRequest"}, 104 "output":{"shape":"CreateEnvironmentResponse"}, 105 "errors":[ 106 {"shape":"ServiceQuotaExceededException"}, 107 {"shape":"ThrottlingException"}, 108 {"shape":"AccessDeniedException"}, 109 {"shape":"ConflictException"}, 110 {"shape":"ValidationException"}, 111 {"shape":"InternalServerException"} 112 ], 113 "documentation":"<p>Creates a runtime environment for a given runtime engine.</p>", 114 "idempotent":true 115 }, 116 "DeleteApplication":{ 117 "name":"DeleteApplication", 118 "http":{ 119 "method":"DELETE", 120 "requestUri":"/applications/{applicationId}", 121 "responseCode":200 122 }, 123 "input":{"shape":"DeleteApplicationRequest"}, 124 "output":{"shape":"DeleteApplicationResponse"}, 125 "errors":[ 126 {"shape":"ThrottlingException"}, 127 {"shape":"AccessDeniedException"}, 128 {"shape":"ConflictException"}, 129 {"shape":"ValidationException"}, 130 {"shape":"InternalServerException"} 131 ], 132 "documentation":"<p>Deletes a specific application. You cannot delete a running application.</p>", 133 "idempotent":true 134 }, 135 "DeleteApplicationFromEnvironment":{ 136 "name":"DeleteApplicationFromEnvironment", 137 "http":{ 138 "method":"DELETE", 139 "requestUri":"/applications/{applicationId}/environment/{environmentId}", 140 "responseCode":200 141 }, 142 "input":{"shape":"DeleteApplicationFromEnvironmentRequest"}, 143 "output":{"shape":"DeleteApplicationFromEnvironmentResponse"}, 144 "errors":[ 145 {"shape":"ResourceNotFoundException"}, 146 {"shape":"ThrottlingException"}, 147 {"shape":"AccessDeniedException"}, 148 {"shape":"ConflictException"}, 149 {"shape":"ValidationException"}, 150 {"shape":"InternalServerException"} 151 ], 152 "documentation":"<p>Deletes a specific application from the specific runtime environment where it was previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This API removes the association of the application with the runtime environment so you can delete the environment smoothly.</p>" 153 }, 154 "DeleteEnvironment":{ 155 "name":"DeleteEnvironment", 156 "http":{ 157 "method":"DELETE", 158 "requestUri":"/environments/{environmentId}", 159 "responseCode":200 160 }, 161 "input":{"shape":"DeleteEnvironmentRequest"}, 162 "output":{"shape":"DeleteEnvironmentResponse"}, 163 "errors":[ 164 {"shape":"ThrottlingException"}, 165 {"shape":"AccessDeniedException"}, 166 {"shape":"ConflictException"}, 167 {"shape":"ValidationException"}, 168 {"shape":"InternalServerException"} 169 ], 170 "documentation":"<p>Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.</p>", 171 "idempotent":true 172 }, 173 "GetApplication":{ 174 "name":"GetApplication", 175 "http":{ 176 "method":"GET", 177 "requestUri":"/applications/{applicationId}", 178 "responseCode":200 179 }, 180 "input":{"shape":"GetApplicationRequest"}, 181 "output":{"shape":"GetApplicationResponse"}, 182 "errors":[ 183 {"shape":"ResourceNotFoundException"}, 184 {"shape":"ThrottlingException"}, 185 {"shape":"AccessDeniedException"}, 186 {"shape":"ValidationException"}, 187 {"shape":"InternalServerException"} 188 ], 189 "documentation":"<p>Describes the details of a specific application.</p>" 190 }, 191 "GetApplicationVersion":{ 192 "name":"GetApplicationVersion", 193 "http":{ 194 "method":"GET", 195 "requestUri":"/applications/{applicationId}/versions/{applicationVersion}", 196 "responseCode":200 197 }, 198 "input":{"shape":"GetApplicationVersionRequest"}, 199 "output":{"shape":"GetApplicationVersionResponse"}, 200 "errors":[ 201 {"shape":"ResourceNotFoundException"}, 202 {"shape":"ThrottlingException"}, 203 {"shape":"AccessDeniedException"}, 204 {"shape":"ValidationException"}, 205 {"shape":"InternalServerException"} 206 ], 207 "documentation":"<p>Returns details about a specific version of a specific application.</p>" 208 }, 209 "GetBatchJobExecution":{ 210 "name":"GetBatchJobExecution", 211 "http":{ 212 "method":"GET", 213 "requestUri":"/applications/{applicationId}/batch-job-executions/{executionId}", 214 "responseCode":200 215 }, 216 "input":{"shape":"GetBatchJobExecutionRequest"}, 217 "output":{"shape":"GetBatchJobExecutionResponse"}, 218 "errors":[ 219 {"shape":"ResourceNotFoundException"}, 220 {"shape":"ThrottlingException"}, 221 {"shape":"AccessDeniedException"}, 222 {"shape":"ValidationException"}, 223 {"shape":"InternalServerException"} 224 ], 225 "documentation":"<p>Gets the details of a specific batch job execution for a specific application.</p>" 226 }, 227 "GetDataSetDetails":{ 228 "name":"GetDataSetDetails", 229 "http":{ 230 "method":"GET", 231 "requestUri":"/applications/{applicationId}/datasets/{dataSetName}", 232 "responseCode":200 233 }, 234 "input":{"shape":"GetDataSetDetailsRequest"}, 235 "output":{"shape":"GetDataSetDetailsResponse"}, 236 "errors":[ 237 {"shape":"ResourceNotFoundException"}, 238 {"shape":"ExecutionTimeoutException"}, 239 {"shape":"ServiceUnavailableException"}, 240 {"shape":"ThrottlingException"}, 241 {"shape":"AccessDeniedException"}, 242 {"shape":"ConflictException"}, 243 {"shape":"ValidationException"}, 244 {"shape":"InternalServerException"} 245 ], 246 "documentation":"<p>Gets the details of a specific data set.</p>" 247 }, 248 "GetDataSetImportTask":{ 249 "name":"GetDataSetImportTask", 250 "http":{ 251 "method":"GET", 252 "requestUri":"/applications/{applicationId}/dataset-import-tasks/{taskId}", 253 "responseCode":200 254 }, 255 "input":{"shape":"GetDataSetImportTaskRequest"}, 256 "output":{"shape":"GetDataSetImportTaskResponse"}, 257 "errors":[ 258 {"shape":"ResourceNotFoundException"}, 259 {"shape":"ThrottlingException"}, 260 {"shape":"AccessDeniedException"}, 261 {"shape":"ValidationException"}, 262 {"shape":"InternalServerException"} 263 ], 264 "documentation":"<p>Gets the status of a data set import task initiated with the <a>CreateDataSetImportTask</a> operation.</p>" 265 }, 266 "GetDeployment":{ 267 "name":"GetDeployment", 268 "http":{ 269 "method":"GET", 270 "requestUri":"/applications/{applicationId}/deployments/{deploymentId}", 271 "responseCode":200 272 }, 273 "input":{"shape":"GetDeploymentRequest"}, 274 "output":{"shape":"GetDeploymentResponse"}, 275 "errors":[ 276 {"shape":"ResourceNotFoundException"}, 277 {"shape":"ThrottlingException"}, 278 {"shape":"AccessDeniedException"}, 279 {"shape":"ValidationException"}, 280 {"shape":"InternalServerException"} 281 ], 282 "documentation":"<p>Gets details of a specific deployment with a given deployment identifier.</p>" 283 }, 284 "GetEnvironment":{ 285 "name":"GetEnvironment", 286 "http":{ 287 "method":"GET", 288 "requestUri":"/environments/{environmentId}", 289 "responseCode":200 290 }, 291 "input":{"shape":"GetEnvironmentRequest"}, 292 "output":{"shape":"GetEnvironmentResponse"}, 293 "errors":[ 294 {"shape":"ResourceNotFoundException"}, 295 {"shape":"ThrottlingException"}, 296 {"shape":"AccessDeniedException"}, 297 {"shape":"ValidationException"}, 298 {"shape":"InternalServerException"} 299 ], 300 "documentation":"<p>Describes a specific runtime environment.</p>" 301 }, 302 "GetSignedBluinsightsUrl":{ 303 "name":"GetSignedBluinsightsUrl", 304 "http":{ 305 "method":"GET", 306 "requestUri":"/signed-bi-url", 307 "responseCode":200 308 }, 309 "output":{"shape":"GetSignedBluinsightsUrlResponse"}, 310 "errors":[ 311 {"shape":"ThrottlingException"}, 312 {"shape":"AccessDeniedException"}, 313 {"shape":"InternalServerException"} 314 ], 315 "documentation":"<p>Gets a single sign-on URL that can be used to connect to AWS Blu Insights.</p>" 316 }, 317 "ListApplicationVersions":{ 318 "name":"ListApplicationVersions", 319 "http":{ 320 "method":"GET", 321 "requestUri":"/applications/{applicationId}/versions", 322 "responseCode":200 323 }, 324 "input":{"shape":"ListApplicationVersionsRequest"}, 325 "output":{"shape":"ListApplicationVersionsResponse"}, 326 "errors":[ 327 {"shape":"ResourceNotFoundException"}, 328 {"shape":"ThrottlingException"}, 329 {"shape":"AccessDeniedException"}, 330 {"shape":"ValidationException"}, 331 {"shape":"InternalServerException"} 332 ], 333 "documentation":"<p>Returns a list of the application versions for a specific application.</p>" 334 }, 335 "ListApplications":{ 336 "name":"ListApplications", 337 "http":{ 338 "method":"GET", 339 "requestUri":"/applications", 340 "responseCode":200 341 }, 342 "input":{"shape":"ListApplicationsRequest"}, 343 "output":{"shape":"ListApplicationsResponse"}, 344 "errors":[ 345 {"shape":"ThrottlingException"}, 346 {"shape":"AccessDeniedException"}, 347 {"shape":"ValidationException"}, 348 {"shape":"InternalServerException"} 349 ], 350 "documentation":"<p>Lists the applications associated with a specific Amazon Web Services account. You can provide the unique identifier of a specific runtime environment in a query parameter to see all applications associated with that environment.</p>" 351 }, 352 "ListBatchJobDefinitions":{ 353 "name":"ListBatchJobDefinitions", 354 "http":{ 355 "method":"GET", 356 "requestUri":"/applications/{applicationId}/batch-job-definitions", 357 "responseCode":200 358 }, 359 "input":{"shape":"ListBatchJobDefinitionsRequest"}, 360 "output":{"shape":"ListBatchJobDefinitionsResponse"}, 361 "errors":[ 362 {"shape":"ResourceNotFoundException"}, 363 {"shape":"ThrottlingException"}, 364 {"shape":"AccessDeniedException"}, 365 {"shape":"ValidationException"}, 366 {"shape":"InternalServerException"} 367 ], 368 "documentation":"<p>Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.</p>" 369 }, 370 "ListBatchJobExecutions":{ 371 "name":"ListBatchJobExecutions", 372 "http":{ 373 "method":"GET", 374 "requestUri":"/applications/{applicationId}/batch-job-executions", 375 "responseCode":200 376 }, 377 "input":{"shape":"ListBatchJobExecutionsRequest"}, 378 "output":{"shape":"ListBatchJobExecutionsResponse"}, 379 "errors":[ 380 {"shape":"ResourceNotFoundException"}, 381 {"shape":"ThrottlingException"}, 382 {"shape":"AccessDeniedException"}, 383 {"shape":"ValidationException"}, 384 {"shape":"InternalServerException"} 385 ], 386 "documentation":"<p>Lists historical, current, and scheduled batch job executions for a specific application.</p>" 387 }, 388 "ListDataSetImportHistory":{ 389 "name":"ListDataSetImportHistory", 390 "http":{ 391 "method":"GET", 392 "requestUri":"/applications/{applicationId}/dataset-import-tasks", 393 "responseCode":200 394 }, 395 "input":{"shape":"ListDataSetImportHistoryRequest"}, 396 "output":{"shape":"ListDataSetImportHistoryResponse"}, 397 "errors":[ 398 {"shape":"ResourceNotFoundException"}, 399 {"shape":"ThrottlingException"}, 400 {"shape":"AccessDeniedException"}, 401 {"shape":"ValidationException"}, 402 {"shape":"InternalServerException"} 403 ], 404 "documentation":"<p>Lists the data set imports for the specified application.</p>" 405 }, 406 "ListDataSets":{ 407 "name":"ListDataSets", 408 "http":{ 409 "method":"GET", 410 "requestUri":"/applications/{applicationId}/datasets", 411 "responseCode":200 412 }, 413 "input":{"shape":"ListDataSetsRequest"}, 414 "output":{"shape":"ListDataSetsResponse"}, 415 "errors":[ 416 {"shape":"ResourceNotFoundException"}, 417 {"shape":"ExecutionTimeoutException"}, 418 {"shape":"ServiceUnavailableException"}, 419 {"shape":"ThrottlingException"}, 420 {"shape":"AccessDeniedException"}, 421 {"shape":"ConflictException"}, 422 {"shape":"ValidationException"}, 423 {"shape":"InternalServerException"} 424 ], 425 "documentation":"<p>Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are associated with applications deployed on runtime environments. This is known as importing data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using <a href=\"https://docs.aws.amazon.com/m2/latest/APIReference/API_CreateDataSetImportTask.html\">CreateDataSetImportTask</a>.</p>" 426 }, 427 "ListDeployments":{ 428 "name":"ListDeployments", 429 "http":{ 430 "method":"GET", 431 "requestUri":"/applications/{applicationId}/deployments", 432 "responseCode":200 433 }, 434 "input":{"shape":"ListDeploymentsRequest"}, 435 "output":{"shape":"ListDeploymentsResponse"}, 436 "errors":[ 437 {"shape":"ResourceNotFoundException"}, 438 {"shape":"ThrottlingException"}, 439 {"shape":"AccessDeniedException"}, 440 {"shape":"ValidationException"}, 441 {"shape":"InternalServerException"} 442 ], 443 "documentation":"<p>Returns a list of all deployments of a specific application. A deployment is a combination of a specific application and a specific version of that application. Each deployment is mapped to a particular application version.</p>" 444 }, 445 "ListEngineVersions":{ 446 "name":"ListEngineVersions", 447 "http":{ 448 "method":"GET", 449 "requestUri":"/engine-versions", 450 "responseCode":200 451 }, 452 "input":{"shape":"ListEngineVersionsRequest"}, 453 "output":{"shape":"ListEngineVersionsResponse"}, 454 "errors":[ 455 {"shape":"ThrottlingException"}, 456 {"shape":"AccessDeniedException"}, 457 {"shape":"ValidationException"}, 458 {"shape":"InternalServerException"} 459 ], 460 "documentation":"<p>Lists the available engine versions.</p>" 461 }, 462 "ListEnvironments":{ 463 "name":"ListEnvironments", 464 "http":{ 465 "method":"GET", 466 "requestUri":"/environments", 467 "responseCode":200 468 }, 469 "input":{"shape":"ListEnvironmentsRequest"}, 470 "output":{"shape":"ListEnvironmentsResponse"}, 471 "errors":[ 472 {"shape":"ThrottlingException"}, 473 {"shape":"AccessDeniedException"}, 474 {"shape":"ValidationException"}, 475 {"shape":"InternalServerException"} 476 ], 477 "documentation":"<p>Lists the runtime environments.</p>" 478 }, 479 "ListTagsForResource":{ 480 "name":"ListTagsForResource", 481 "http":{ 482 "method":"GET", 483 "requestUri":"/tags/{resourceArn}", 484 "responseCode":200 485 }, 486 "input":{"shape":"ListTagsForResourceRequest"}, 487 "output":{"shape":"ListTagsForResourceResponse"}, 488 "errors":[ 489 {"shape":"ResourceNotFoundException"}, 490 {"shape":"ThrottlingException"}, 491 {"shape":"AccessDeniedException"}, 492 {"shape":"ValidationException"}, 493 {"shape":"InternalServerException"} 494 ], 495 "documentation":"<p>Lists the tags for the specified resource.</p>" 496 }, 497 "StartApplication":{ 498 "name":"StartApplication", 499 "http":{ 500 "method":"POST", 501 "requestUri":"/applications/{applicationId}/start", 502 "responseCode":200 503 }, 504 "input":{"shape":"StartApplicationRequest"}, 505 "output":{"shape":"StartApplicationResponse"}, 506 "errors":[ 507 {"shape":"ResourceNotFoundException"}, 508 {"shape":"ThrottlingException"}, 509 {"shape":"AccessDeniedException"}, 510 {"shape":"ConflictException"}, 511 {"shape":"ValidationException"}, 512 {"shape":"InternalServerException"} 513 ], 514 "documentation":"<p>Starts an application that is currently stopped.</p>" 515 }, 516 "StartBatchJob":{ 517 "name":"StartBatchJob", 518 "http":{ 519 "method":"POST", 520 "requestUri":"/applications/{applicationId}/batch-job", 521 "responseCode":200 522 }, 523 "input":{"shape":"StartBatchJobRequest"}, 524 "output":{"shape":"StartBatchJobResponse"}, 525 "errors":[ 526 {"shape":"ResourceNotFoundException"}, 527 {"shape":"ThrottlingException"}, 528 {"shape":"AccessDeniedException"}, 529 {"shape":"ConflictException"}, 530 {"shape":"ValidationException"}, 531 {"shape":"InternalServerException"} 532 ], 533 "documentation":"<p>Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.</p>" 534 }, 535 "StopApplication":{ 536 "name":"StopApplication", 537 "http":{ 538 "method":"POST", 539 "requestUri":"/applications/{applicationId}/stop", 540 "responseCode":200 541 }, 542 "input":{"shape":"StopApplicationRequest"}, 543 "output":{"shape":"StopApplicationResponse"}, 544 "errors":[ 545 {"shape":"ResourceNotFoundException"}, 546 {"shape":"ThrottlingException"}, 547 {"shape":"AccessDeniedException"}, 548 {"shape":"ConflictException"}, 549 {"shape":"ValidationException"}, 550 {"shape":"InternalServerException"} 551 ], 552 "documentation":"<p>Stops a running application.</p>" 553 }, 554 "TagResource":{ 555 "name":"TagResource", 556 "http":{ 557 "method":"POST", 558 "requestUri":"/tags/{resourceArn}", 559 "responseCode":200 560 }, 561 "input":{"shape":"TagResourceRequest"}, 562 "output":{"shape":"TagResourceResponse"}, 563 "errors":[ 564 {"shape":"ResourceNotFoundException"}, 565 {"shape":"ServiceQuotaExceededException"}, 566 {"shape":"ThrottlingException"}, 567 {"shape":"AccessDeniedException"}, 568 {"shape":"ValidationException"}, 569 {"shape":"InternalServerException"} 570 ], 571 "documentation":"<p>Adds one or more tags to the specified resource.</p>" 572 }, 573 "UntagResource":{ 574 "name":"UntagResource", 575 "http":{ 576 "method":"DELETE", 577 "requestUri":"/tags/{resourceArn}", 578 "responseCode":200 579 }, 580 "input":{"shape":"UntagResourceRequest"}, 581 "output":{"shape":"UntagResourceResponse"}, 582 "errors":[ 583 {"shape":"ResourceNotFoundException"}, 584 {"shape":"ThrottlingException"}, 585 {"shape":"AccessDeniedException"}, 586 {"shape":"ValidationException"}, 587 {"shape":"InternalServerException"} 588 ], 589 "documentation":"<p>Removes one or more tags from the specified resource.</p>" 590 }, 591 "UpdateApplication":{ 592 "name":"UpdateApplication", 593 "http":{ 594 "method":"PATCH", 595 "requestUri":"/applications/{applicationId}", 596 "responseCode":200 597 }, 598 "input":{"shape":"UpdateApplicationRequest"}, 599 "output":{"shape":"UpdateApplicationResponse"}, 600 "errors":[ 601 {"shape":"ResourceNotFoundException"}, 602 {"shape":"ThrottlingException"}, 603 {"shape":"AccessDeniedException"}, 604 {"shape":"ConflictException"}, 605 {"shape":"ValidationException"}, 606 {"shape":"InternalServerException"} 607 ], 608 "documentation":"<p>Updates an application and creates a new version.</p>" 609 }, 610 "UpdateEnvironment":{ 611 "name":"UpdateEnvironment", 612 "http":{ 613 "method":"PATCH", 614 "requestUri":"/environments/{environmentId}", 615 "responseCode":200 616 }, 617 "input":{"shape":"UpdateEnvironmentRequest"}, 618 "output":{"shape":"UpdateEnvironmentResponse"}, 619 "errors":[ 620 {"shape":"ResourceNotFoundException"}, 621 {"shape":"ServiceQuotaExceededException"}, 622 {"shape":"ThrottlingException"}, 623 {"shape":"AccessDeniedException"}, 624 {"shape":"ConflictException"}, 625 {"shape":"ValidationException"}, 626 {"shape":"InternalServerException"} 627 ], 628 "documentation":"<p>Updates the configuration details for a specific runtime environment.</p>" 629 } 630 }, 631 "shapes":{ 632 "AccessDeniedException":{ 633 "type":"structure", 634 "required":["message"], 635 "members":{ 636 "message":{"shape":"String"} 637 }, 638 "documentation":"<p>The account or role doesn't have the right permissions to make the request.</p>", 639 "error":{ 640 "httpStatusCode":403, 641 "senderFault":true 642 }, 643 "exception":true 644 }, 645 "AlternateKey":{ 646 "type":"structure", 647 "required":[ 648 "length", 649 "offset" 650 ], 651 "members":{ 652 "allowDuplicates":{ 653 "shape":"Boolean", 654 "documentation":"<p>Indicates whether the alternate key values are supposed to be unique for the given data set.</p>" 655 }, 656 "length":{ 657 "shape":"Integer", 658 "documentation":"<p>A strictly positive integer value representing the length of the alternate key.</p>" 659 }, 660 "name":{ 661 "shape":"String", 662 "documentation":"<p>The name of the alternate key.</p>" 663 }, 664 "offset":{ 665 "shape":"Integer", 666 "documentation":"<p>A positive integer value representing the offset to mark the start of the alternate key part in the record byte array.</p>" 667 } 668 }, 669 "documentation":"<p>Defines an alternate key. This value is optional. A legacy data set might not have any alternate key defined but if those alternate keys definitions exist, provide them, as some applications will make use of them.</p>" 670 }, 671 "AlternateKeyList":{ 672 "type":"list", 673 "member":{"shape":"AlternateKey"} 674 }, 675 "ApplicationDeploymentLifecycle":{ 676 "type":"string", 677 "enum":[ 678 "Deploying", 679 "Deployed" 680 ] 681 }, 682 "ApplicationLifecycle":{ 683 "type":"string", 684 "enum":[ 685 "Creating", 686 "Created", 687 "Available", 688 "Ready", 689 "Starting", 690 "Running", 691 "Stopping", 692 "Stopped", 693 "Failed", 694 "Deleting", 695 "Deleting From Environment" 696 ] 697 }, 698 "ApplicationSummary":{ 699 "type":"structure", 700 "required":[ 701 "applicationArn", 702 "applicationId", 703 "applicationVersion", 704 "creationTime", 705 "engineType", 706 "name", 707 "status" 708 ], 709 "members":{ 710 "applicationArn":{ 711 "shape":"Arn", 712 "documentation":"<p>The Amazon Resource Name (ARN) of the application.</p>" 713 }, 714 "applicationId":{ 715 "shape":"Identifier", 716 "documentation":"<p>The unique identifier of the application.</p>" 717 }, 718 "applicationVersion":{ 719 "shape":"Version", 720 "documentation":"<p>The version of the application.</p>" 721 }, 722 "creationTime":{ 723 "shape":"Timestamp", 724 "documentation":"<p>The timestamp when the application was created.</p>" 725 }, 726 "deploymentStatus":{ 727 "shape":"ApplicationDeploymentLifecycle", 728 "documentation":"<p>Indicates either an ongoing deployment or if the application has ever deployed successfully.</p>" 729 }, 730 "description":{ 731 "shape":"EntityDescription", 732 "documentation":"<p>The description of the application.</p>" 733 }, 734 "engineType":{ 735 "shape":"EngineType", 736 "documentation":"<p>The type of the target platform for this application.</p>" 737 }, 738 "environmentId":{ 739 "shape":"Identifier", 740 "documentation":"<p>The unique identifier of the runtime environment that hosts this application.</p>" 741 }, 742 "lastStartTime":{ 743 "shape":"Timestamp", 744 "documentation":"<p>The timestamp when you last started the application. Null until the application runs for the first time.</p>" 745 }, 746 "name":{ 747 "shape":"EntityName", 748 "documentation":"<p>The name of the application.</p>" 749 }, 750 "roleArn":{ 751 "shape":"Arn", 752 "documentation":"<p>The Amazon Resource Name (ARN) of the role associated with the application.</p>" 753 }, 754 "status":{ 755 "shape":"ApplicationLifecycle", 756 "documentation":"<p>The status of the application.</p>" 757 }, 758 "versionStatus":{ 759 "shape":"ApplicationVersionLifecycle", 760 "documentation":"<p>Indicates the status of the latest version of the application.</p>" 761 } 762 }, 763 "documentation":"<p>A subset of the possible application attributes. Used in the application list.</p>" 764 }, 765 "ApplicationSummaryList":{ 766 "type":"list", 767 "member":{"shape":"ApplicationSummary"} 768 }, 769 "ApplicationVersionLifecycle":{ 770 "type":"string", 771 "enum":[ 772 "Creating", 773 "Available", 774 "Failed" 775 ] 776 }, 777 "ApplicationVersionSummary":{ 778 "type":"structure", 779 "required":[ 780 "applicationVersion", 781 "creationTime", 782 "status" 783 ], 784 "members":{ 785 "applicationVersion":{ 786 "shape":"Version", 787 "documentation":"<p>The application version.</p>" 788 }, 789 "creationTime":{ 790 "shape":"Timestamp", 791 "documentation":"<p>The timestamp when the application version was created.</p>" 792 }, 793 "status":{ 794 "shape":"ApplicationVersionLifecycle", 795 "documentation":"<p>The status of the application.</p>" 796 }, 797 "statusReason":{ 798 "shape":"String", 799 "documentation":"<p>The reason for the reported status.</p>" 800 } 801 }, 802 "documentation":"<p>Defines an application version summary.</p>" 803 }, 804 "ApplicationVersionSummaryList":{ 805 "type":"list", 806 "member":{"shape":"ApplicationVersionSummary"} 807 }, 808 "Arn":{ 809 "type":"string", 810 "pattern":"^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$" 811 }, 812 "ArnList":{ 813 "type":"list", 814 "member":{"shape":"Arn"}, 815 "min":1 816 }, 817 "BatchJobDefinition":{ 818 "type":"structure", 819 "members":{ 820 "fileBatchJobDefinition":{ 821 "shape":"FileBatchJobDefinition", 822 "documentation":"<p>Specifies a file containing a batch job definition.</p>" 823 }, 824 "scriptBatchJobDefinition":{ 825 "shape":"ScriptBatchJobDefinition", 826 "documentation":"<p>A script containing a batch job definition.</p>" 827 } 828 }, 829 "documentation":"<p>Defines the details of a batch job.</p>", 830 "union":true 831 }, 832 "BatchJobDefinitions":{ 833 "type":"list", 834 "member":{"shape":"BatchJobDefinition"} 835 }, 836 "BatchJobExecutionStatus":{ 837 "type":"string", 838 "enum":[ 839 "Submitting", 840 "Holding", 841 "Dispatching", 842 "Running", 843 "Cancelling", 844 "Cancelled", 845 "Succeeded", 846 "Failed", 847 "Succeeded With Warning" 848 ] 849 }, 850 "BatchJobExecutionSummary":{ 851 "type":"structure", 852 "required":[ 853 "applicationId", 854 "executionId", 855 "startTime", 856 "status" 857 ], 858 "members":{ 859 "applicationId":{ 860 "shape":"Identifier", 861 "documentation":"<p>The unique identifier of the application that hosts this batch job.</p>" 862 }, 863 "batchJobIdentifier":{ 864 "shape":"BatchJobIdentifier", 865 "documentation":"<p>The unique identifier of this batch job.</p>" 866 }, 867 "endTime":{ 868 "shape":"Timestamp", 869 "documentation":"<p>The timestamp when this batch job execution ended.</p>" 870 }, 871 "executionId":{ 872 "shape":"Identifier", 873 "documentation":"<p>The unique identifier of this execution of the batch job.</p>" 874 }, 875 "jobId":{ 876 "shape":"String100", 877 "documentation":"<p>The unique identifier of a particular batch job.</p>" 878 }, 879 "jobName":{ 880 "shape":"String100", 881 "documentation":"<p>The name of a particular batch job.</p>" 882 }, 883 "jobType":{ 884 "shape":"BatchJobType", 885 "documentation":"<p>The type of a particular batch job execution.</p>" 886 }, 887 "returnCode":{ 888 "shape":"String", 889 "documentation":"<p>The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see <a href=\"https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes\">Batch return codes</a> in the <i>IBM WebSphere Application Server</i> documentation.</p>" 890 }, 891 "startTime":{ 892 "shape":"Timestamp", 893 "documentation":"<p>The timestamp when a particular batch job execution started.</p>" 894 }, 895 "status":{ 896 "shape":"BatchJobExecutionStatus", 897 "documentation":"<p>The status of a particular batch job execution.</p>" 898 } 899 }, 900 "documentation":"<p>A subset of the possible batch job attributes. Used in the batch job list.</p>" 901 }, 902 "BatchJobExecutionSummaryList":{ 903 "type":"list", 904 "member":{"shape":"BatchJobExecutionSummary"} 905 }, 906 "BatchJobIdentifier":{ 907 "type":"structure", 908 "members":{ 909 "fileBatchJobIdentifier":{ 910 "shape":"FileBatchJobIdentifier", 911 "documentation":"<p>Specifies a file associated with a specific batch job.</p>" 912 }, 913 "s3BatchJobIdentifier":{ 914 "shape":"S3BatchJobIdentifier", 915 "documentation":"<p>Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.</p>" 916 }, 917 "scriptBatchJobIdentifier":{ 918 "shape":"ScriptBatchJobIdentifier", 919 "documentation":"<p>A batch job identifier in which the batch job to run is identified by the script name.</p>" 920 } 921 }, 922 "documentation":"<p>Identifies a specific batch job.</p>", 923 "union":true 924 }, 925 "BatchJobParametersMap":{ 926 "type":"map", 927 "key":{"shape":"BatchParamKey"}, 928 "value":{"shape":"BatchParamValue"}, 929 "documentation":"<p>Job parameters are optional. Can contain up to 500 entries.</p>", 930 "max":500, 931 "min":0 932 }, 933 "BatchJobType":{ 934 "type":"string", 935 "enum":[ 936 "VSE", 937 "JES2", 938 "JES3" 939 ] 940 }, 941 "BatchParamKey":{ 942 "type":"string", 943 "documentation":"<p>See https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl to get details about limits for both keys and values: 8 for keys (variable names), 44 for values (variable values) In addition, keys will be only alphabetic characters and digits, without any space or special characters (dash, underscore, etc ...)</p> <p>Parameter key: the first character must be alphabetic. Can be of up to 8 alphanumeric characters.</p>", 944 "max":32, 945 "min":1, 946 "pattern":"^[A-Za-z][A-Za-z0-9]{1,7}$" 947 }, 948 "BatchParamValue":{ 949 "type":"string", 950 "documentation":"<p>Parameter value can be of up to 44 alphanumeric characters.</p>", 951 "max":80, 952 "min":0 953 }, 954 "Boolean":{"type":"boolean"}, 955 "CancelBatchJobExecutionRequest":{ 956 "type":"structure", 957 "required":[ 958 "applicationId", 959 "executionId" 960 ], 961 "members":{ 962 "applicationId":{ 963 "shape":"Identifier", 964 "documentation":"<p>The unique identifier of the application.</p>", 965 "location":"uri", 966 "locationName":"applicationId" 967 }, 968 "executionId":{ 969 "shape":"Identifier", 970 "documentation":"<p>The unique identifier of the batch job execution.</p>", 971 "location":"uri", 972 "locationName":"executionId" 973 } 974 } 975 }, 976 "CancelBatchJobExecutionResponse":{ 977 "type":"structure", 978 "members":{ 979 } 980 }, 981 "CapacityValue":{ 982 "type":"integer", 983 "box":true 984 }, 985 "ConflictException":{ 986 "type":"structure", 987 "required":["message"], 988 "members":{ 989 "message":{"shape":"String"}, 990 "resourceId":{ 991 "shape":"String", 992 "documentation":"<p>The ID of the conflicting resource.</p>" 993 }, 994 "resourceType":{ 995 "shape":"String", 996 "documentation":"<p>The type of the conflicting resource.</p>" 997 } 998 }, 999 "documentation":"<p>The parameters provided in the request conflict with existing resources.</p>", 1000 "error":{ 1001 "httpStatusCode":409, 1002 "senderFault":true 1003 }, 1004 "exception":true 1005 }, 1006 "CreateApplicationRequest":{ 1007 "type":"structure", 1008 "required":[ 1009 "definition", 1010 "engineType", 1011 "name" 1012 ], 1013 "members":{ 1014 "clientToken":{ 1015 "shape":"String", 1016 "documentation":"<p>Unique, case-sensitive identifier the service generates to ensure the idempotency of the request to create an application. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires. </p>", 1017 "idempotencyToken":true 1018 }, 1019 "definition":{ 1020 "shape":"Definition", 1021 "documentation":"<p>The application definition for this application. You can specify either inline JSON or an S3 bucket location.</p>" 1022 }, 1023 "description":{ 1024 "shape":"EntityDescription", 1025 "documentation":"<p>The description of the application.</p>" 1026 }, 1027 "engineType":{ 1028 "shape":"EngineType", 1029 "documentation":"<p>The type of the target platform for this application.</p>" 1030 }, 1031 "kmsKeyId":{ 1032 "shape":"String", 1033 "documentation":"<p>The identifier of a customer managed key.</p>" 1034 }, 1035 "name":{ 1036 "shape":"EntityName", 1037 "documentation":"<p>The unique identifier of the application.</p>" 1038 }, 1039 "roleArn":{ 1040 "shape":"Arn", 1041 "documentation":"<p>The Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources that are not part of the application or are in a different Amazon Web Services account.</p>" 1042 }, 1043 "tags":{ 1044 "shape":"TagMap", 1045 "documentation":"<p>A list of tags to apply to the application.</p>" 1046 } 1047 } 1048 }, 1049 "CreateApplicationResponse":{ 1050 "type":"structure", 1051 "required":[ 1052 "applicationArn", 1053 "applicationId", 1054 "applicationVersion" 1055 ], 1056 "members":{ 1057 "applicationArn":{ 1058 "shape":"Arn", 1059 "documentation":"<p>The Amazon Resource Name (ARN) of the application.</p>" 1060 }, 1061 "applicationId":{ 1062 "shape":"Identifier", 1063 "documentation":"<p>The unique application identifier.</p>" 1064 }, 1065 "applicationVersion":{ 1066 "shape":"Version", 1067 "documentation":"<p>The version number of the application.</p>" 1068 } 1069 } 1070 }, 1071 "CreateDataSetImportTaskRequest":{ 1072 "type":"structure", 1073 "required":[ 1074 "applicationId", 1075 "importConfig" 1076 ], 1077 "members":{ 1078 "applicationId":{ 1079 "shape":"Identifier", 1080 "documentation":"<p>The unique identifier of the application for which you want to import data sets.</p>", 1081 "location":"uri", 1082 "locationName":"applicationId" 1083 }, 1084 "clientToken":{ 1085 "shape":"String", 1086 "documentation":"<p> Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set import. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires. </p>", 1087 "idempotencyToken":true 1088 }, 1089 "importConfig":{ 1090 "shape":"DataSetImportConfig", 1091 "documentation":"<p>The data set import task configuration.</p>" 1092 } 1093 } 1094 }, 1095 "CreateDataSetImportTaskResponse":{ 1096 "type":"structure", 1097 "required":["taskId"], 1098 "members":{ 1099 "taskId":{ 1100 "shape":"Identifier", 1101 "documentation":"<p>The task identifier. This operation is asynchronous. Use this identifier with the <a>GetDataSetImportTask</a> operation to obtain the status of this task.</p>" 1102 } 1103 } 1104 }, 1105 "CreateDeploymentRequest":{ 1106 "type":"structure", 1107 "required":[ 1108 "applicationId", 1109 "applicationVersion", 1110 "environmentId" 1111 ], 1112 "members":{ 1113 "applicationId":{ 1114 "shape":"Identifier", 1115 "documentation":"<p>The application identifier.</p>", 1116 "location":"uri", 1117 "locationName":"applicationId" 1118 }, 1119 "applicationVersion":{ 1120 "shape":"Version", 1121 "documentation":"<p>The version of the application to deploy.</p>" 1122 }, 1123 "clientToken":{ 1124 "shape":"String", 1125 "documentation":"<p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a deployment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires. </p>", 1126 "idempotencyToken":true 1127 }, 1128 "environmentId":{ 1129 "shape":"Identifier", 1130 "documentation":"<p>The identifier of the runtime environment where you want to deploy this application.</p>" 1131 } 1132 } 1133 }, 1134 "CreateDeploymentResponse":{ 1135 "type":"structure", 1136 "required":["deploymentId"], 1137 "members":{ 1138 "deploymentId":{ 1139 "shape":"Identifier", 1140 "documentation":"<p>The unique identifier of the deployment.</p>" 1141 } 1142 } 1143 }, 1144 "CreateEnvironmentRequest":{ 1145 "type":"structure", 1146 "required":[ 1147 "engineType", 1148 "instanceType", 1149 "name" 1150 ], 1151 "members":{ 1152 "clientToken":{ 1153 "shape":"String", 1154 "documentation":"<p>Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires. </p>", 1155 "idempotencyToken":true 1156 }, 1157 "description":{ 1158 "shape":"EntityDescription", 1159 "documentation":"<p>The description of the runtime environment.</p>" 1160 }, 1161 "engineType":{ 1162 "shape":"EngineType", 1163 "documentation":"<p>The engine type for the runtime environment.</p>" 1164 }, 1165 "engineVersion":{ 1166 "shape":"EngineVersion", 1167 "documentation":"<p>The version of the engine type for the runtime environment.</p>" 1168 }, 1169 "highAvailabilityConfig":{ 1170 "shape":"HighAvailabilityConfig", 1171 "documentation":"<p>The details of a high availability configuration for this runtime environment.</p>" 1172 }, 1173 "instanceType":{ 1174 "shape":"String20", 1175 "documentation":"<p>The type of instance for the runtime environment.</p>" 1176 }, 1177 "kmsKeyId":{ 1178 "shape":"String", 1179 "documentation":"<p>The identifier of a customer managed key.</p>" 1180 }, 1181 "name":{ 1182 "shape":"EntityName", 1183 "documentation":"<p>The name of the runtime environment. Must be unique within the account.</p>" 1184 }, 1185 "preferredMaintenanceWindow":{ 1186 "shape":"String50", 1187 "documentation":"<p>Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format <code>ddd:hh24:mi-ddd:hh24:mi</code> and must be less than 24 hours. The following two examples are valid maintenance windows: <code>sun:23:45-mon:00:15</code> or <code>sat:01:00-sat:03:00</code>. </p> <p>If you do not provide a value, a random system-generated value will be assigned.</p>" 1188 }, 1189 "publiclyAccessible":{ 1190 "shape":"Boolean", 1191 "documentation":"<p>Specifies whether the runtime environment is publicly accessible.</p>" 1192 }, 1193 "securityGroupIds":{ 1194 "shape":"String50List", 1195 "documentation":"<p>The list of security groups for the VPC associated with this runtime environment.</p>" 1196 }, 1197 "storageConfigurations":{ 1198 "shape":"StorageConfigurationList", 1199 "documentation":"<p>Optional. The storage configurations for this runtime environment.</p>" 1200 }, 1201 "subnetIds":{ 1202 "shape":"String50List", 1203 "documentation":"<p>The list of subnets associated with the VPC for this runtime environment.</p>" 1204 }, 1205 "tags":{ 1206 "shape":"TagMap", 1207 "documentation":"<p>The tags for the runtime environment.</p>" 1208 } 1209 } 1210 }, 1211 "CreateEnvironmentResponse":{ 1212 "type":"structure", 1213 "required":["environmentId"], 1214 "members":{ 1215 "environmentId":{ 1216 "shape":"Identifier", 1217 "documentation":"<p>The unique identifier of the runtime environment.</p>" 1218 } 1219 } 1220 }, 1221 "DataSet":{ 1222 "type":"structure", 1223 "required":[ 1224 "datasetName", 1225 "datasetOrg", 1226 "recordLength" 1227 ], 1228 "members":{ 1229 "datasetName":{ 1230 "shape":"String", 1231 "documentation":"<p>The logical identifier for a specific data set (in mainframe format).</p>" 1232 }, 1233 "datasetOrg":{ 1234 "shape":"DatasetOrgAttributes", 1235 "documentation":"<p>The type of dataset. The only supported value is VSAM.</p>" 1236 }, 1237 "recordLength":{ 1238 "shape":"RecordLength", 1239 "documentation":"<p>The length of a record.</p>" 1240 }, 1241 "relativePath":{ 1242 "shape":"String", 1243 "documentation":"<p>The relative location of the data set in the database or file system. </p>" 1244 }, 1245 "storageType":{ 1246 "shape":"String", 1247 "documentation":"<p>The storage type of the data set: database or file system. For Micro Focus, database corresponds to datastore and file system corresponds to EFS/FSX. For Blu Age, there is no support of file system and database corresponds to Blusam. </p>" 1248 } 1249 }, 1250 "documentation":"<p>Defines a data set.</p>" 1251 }, 1252 "DataSetImportConfig":{ 1253 "type":"structure", 1254 "members":{ 1255 "dataSets":{ 1256 "shape":"DataSetImportList", 1257 "documentation":"<p>The data sets.</p>" 1258 }, 1259 "s3Location":{ 1260 "shape":"String2000", 1261 "documentation":"<p>The Amazon S3 location of the data sets.</p>" 1262 } 1263 }, 1264 "documentation":"<p>Identifies one or more data sets you want to import with the <a>CreateDataSetImportTask</a> operation.</p>", 1265 "union":true 1266 }, 1267 "DataSetImportItem":{ 1268 "type":"structure", 1269 "required":[ 1270 "dataSet", 1271 "externalLocation" 1272 ], 1273 "members":{ 1274 "dataSet":{ 1275 "shape":"DataSet", 1276 "documentation":"<p>The data set.</p>" 1277 }, 1278 "externalLocation":{ 1279 "shape":"ExternalLocation", 1280 "documentation":"<p>The location of the data set.</p>" 1281 } 1282 }, 1283 "documentation":"<p>Identifies a specific data set to import from an external location.</p>" 1284 }, 1285 "DataSetImportList":{ 1286 "type":"list", 1287 "member":{"shape":"DataSetImportItem"}, 1288 "max":100, 1289 "min":1 1290 }, 1291 "DataSetImportSummary":{ 1292 "type":"structure", 1293 "required":[ 1294 "failed", 1295 "inProgress", 1296 "pending", 1297 "succeeded", 1298 "total" 1299 ], 1300 "members":{ 1301 "failed":{ 1302 "shape":"Integer", 1303 "documentation":"<p>The number of data set imports that have failed.</p>" 1304 }, 1305 "inProgress":{ 1306 "shape":"Integer", 1307 "documentation":"<p>The number of data set imports that are in progress.</p>" 1308 }, 1309 "pending":{ 1310 "shape":"Integer", 1311 "documentation":"<p>The number of data set imports that are pending.</p>" 1312 }, 1313 "succeeded":{ 1314 "shape":"Integer", 1315 "documentation":"<p>The number of data set imports that have succeeded.</p>" 1316 }, 1317 "total":{ 1318 "shape":"Integer", 1319 "documentation":"<p>The total number of data set imports.</p>" 1320 } 1321 }, 1322 "documentation":"<p>Represents a summary of data set imports.</p>" 1323 }, 1324 "DataSetImportTask":{ 1325 "type":"structure", 1326 "required":[ 1327 "status", 1328 "summary", 1329 "taskId" 1330 ], 1331 "members":{ 1332 "status":{ 1333 "shape":"DataSetTaskLifecycle", 1334 "documentation":"<p>The status of the data set import task.</p>" 1335 }, 1336 "statusReason":{ 1337 "shape":"String", 1338 "documentation":"<p>If dataset import failed, the failure reason will show here.</p>" 1339 }, 1340 "summary":{ 1341 "shape":"DataSetImportSummary", 1342 "documentation":"<p>A summary of the data set import task.</p>" 1343 }, 1344 "taskId":{ 1345 "shape":"Identifier", 1346 "documentation":"<p>The identifier of the data set import task.</p>" 1347 } 1348 }, 1349 "documentation":"<p>Contains information about a data set import task.</p>" 1350 }, 1351 "DataSetImportTaskList":{ 1352 "type":"list", 1353 "member":{"shape":"DataSetImportTask"} 1354 }, 1355 "DataSetSummary":{ 1356 "type":"structure", 1357 "required":["dataSetName"], 1358 "members":{ 1359 "creationTime":{ 1360 "shape":"Timestamp", 1361 "documentation":"<p>The timestamp when the data set was created.</p>" 1362 }, 1363 "dataSetName":{ 1364 "shape":"String200", 1365 "documentation":"<p>The name of the data set.</p>" 1366 }, 1367 "dataSetOrg":{ 1368 "shape":"String20", 1369 "documentation":"<p>The type of data set. The only supported value is VSAM.</p>" 1370 }, 1371 "format":{ 1372 "shape":"String20", 1373 "documentation":"<p>The format of the data set. </p>" 1374 }, 1375 "lastReferencedTime":{ 1376 "shape":"Timestamp", 1377 "documentation":"<p>The last time the data set was referenced.</p>" 1378 }, 1379 "lastUpdatedTime":{ 1380 "shape":"Timestamp", 1381 "documentation":"<p>The last time the data set was updated.</p>" 1382 } 1383 }, 1384 "documentation":"<p>A subset of the possible data set attributes.</p>" 1385 }, 1386 "DataSetTaskLifecycle":{ 1387 "type":"string", 1388 "enum":[ 1389 "Creating", 1390 "Running", 1391 "Completed", 1392 "Failed" 1393 ] 1394 }, 1395 "DataSetsSummaryList":{ 1396 "type":"list", 1397 "member":{"shape":"DataSetSummary"} 1398 }, 1399 "DatasetDetailOrgAttributes":{ 1400 "type":"structure", 1401 "members":{ 1402 "gdg":{ 1403 "shape":"GdgDetailAttributes", 1404 "documentation":"<p>The generation data group of the data set.</p>" 1405 }, 1406 "po":{ 1407 "shape":"PoDetailAttributes", 1408 "documentation":"<p>The details of a PO type data set.</p>" 1409 }, 1410 "ps":{ 1411 "shape":"PsDetailAttributes", 1412 "documentation":"<p>The details of a PS type data set.</p>" 1413 }, 1414 "vsam":{ 1415 "shape":"VsamDetailAttributes", 1416 "documentation":"<p>The details of a VSAM data set.</p>" 1417 } 1418 }, 1419 "documentation":"<p>Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, storageType and backend (Blu Age or Micro Focus).</p>", 1420 "union":true 1421 }, 1422 "DatasetOrgAttributes":{ 1423 "type":"structure", 1424 "members":{ 1425 "gdg":{ 1426 "shape":"GdgAttributes", 1427 "documentation":"<p>The generation data group of the data set.</p>" 1428 }, 1429 "po":{ 1430 "shape":"PoAttributes", 1431 "documentation":"<p>The details of a PO type data set.</p>" 1432 }, 1433 "ps":{ 1434 "shape":"PsAttributes", 1435 "documentation":"<p>The details of a PS type data set.</p>" 1436 }, 1437 "vsam":{ 1438 "shape":"VsamAttributes", 1439 "documentation":"<p>The details of a VSAM data set.</p>" 1440 } 1441 }, 1442 "documentation":"<p>Additional details about the data set. Different attributes correspond to different data set organizations. The values are populated based on datasetOrg, storageType and backend (Blu Age or Micro Focus).</p>", 1443 "union":true 1444 }, 1445 "Definition":{ 1446 "type":"structure", 1447 "members":{ 1448 "content":{ 1449 "shape":"StringFree65000", 1450 "documentation":"<p>The content of the application definition. This is a JSON object that contains the resource configuration/definitions that identify an application.</p>" 1451 }, 1452 "s3Location":{ 1453 "shape":"String2000", 1454 "documentation":"<p>The S3 bucket that contains the application definition.</p>" 1455 } 1456 }, 1457 "documentation":"<p>The application definition for a particular application. </p>", 1458 "union":true 1459 }, 1460 "DeleteApplicationFromEnvironmentRequest":{ 1461 "type":"structure", 1462 "required":[ 1463 "applicationId", 1464 "environmentId" 1465 ], 1466 "members":{ 1467 "applicationId":{ 1468 "shape":"Identifier", 1469 "documentation":"<p>The unique identifier of the application you want to delete.</p>", 1470 "location":"uri", 1471 "locationName":"applicationId" 1472 }, 1473 "environmentId":{ 1474 "shape":"Identifier", 1475 "documentation":"<p>The unique identifier of the runtime environment where the application was previously deployed.</p>", 1476 "location":"uri", 1477 "locationName":"environmentId" 1478 } 1479 } 1480 }, 1481 "DeleteApplicationFromEnvironmentResponse":{ 1482 "type":"structure", 1483 "members":{ 1484 } 1485 }, 1486 "DeleteApplicationRequest":{ 1487 "type":"structure", 1488 "required":["applicationId"], 1489 "members":{ 1490 "applicationId":{ 1491 "shape":"Identifier", 1492 "documentation":"<p>The unique identifier of the application you want to delete.</p>", 1493 "location":"uri", 1494 "locationName":"applicationId" 1495 } 1496 } 1497 }, 1498 "DeleteApplicationResponse":{ 1499 "type":"structure", 1500 "members":{ 1501 } 1502 }, 1503 "DeleteEnvironmentRequest":{ 1504 "type":"structure", 1505 "required":["environmentId"], 1506 "members":{ 1507 "environmentId":{ 1508 "shape":"Identifier", 1509 "documentation":"<p>The unique identifier of the runtime environment you want to delete.</p>", 1510 "location":"uri", 1511 "locationName":"environmentId" 1512 } 1513 } 1514 }, 1515 "DeleteEnvironmentResponse":{ 1516 "type":"structure", 1517 "members":{ 1518 } 1519 }, 1520 "DeployedVersionSummary":{ 1521 "type":"structure", 1522 "required":[ 1523 "applicationVersion", 1524 "status" 1525 ], 1526 "members":{ 1527 "applicationVersion":{ 1528 "shape":"Version", 1529 "documentation":"<p>The version of the deployed application.</p>" 1530 }, 1531 "status":{ 1532 "shape":"DeploymentLifecycle", 1533 "documentation":"<p>The status of the deployment.</p>" 1534 }, 1535 "statusReason":{ 1536 "shape":"String", 1537 "documentation":"<p>The reason for the reported status.</p>" 1538 } 1539 }, 1540 "documentation":"<p>Contains a summary of a deployed application.</p>" 1541 }, 1542 "DeploymentLifecycle":{ 1543 "type":"string", 1544 "enum":[ 1545 "Deploying", 1546 "Succeeded", 1547 "Failed", 1548 "Updating Deployment" 1549 ] 1550 }, 1551 "DeploymentList":{ 1552 "type":"list", 1553 "member":{"shape":"DeploymentSummary"} 1554 }, 1555 "DeploymentSummary":{ 1556 "type":"structure", 1557 "required":[ 1558 "applicationId", 1559 "applicationVersion", 1560 "creationTime", 1561 "deploymentId", 1562 "environmentId", 1563 "status" 1564 ], 1565 "members":{ 1566 "applicationId":{ 1567 "shape":"Identifier", 1568 "documentation":"<p>The unique identifier of the application.</p>" 1569 }, 1570 "applicationVersion":{ 1571 "shape":"Version", 1572 "documentation":"<p>The version of the application.</p>" 1573 }, 1574 "creationTime":{ 1575 "shape":"Timestamp", 1576 "documentation":"<p>The timestamp when the deployment was created.</p>" 1577 }, 1578 "deploymentId":{ 1579 "shape":"Identifier", 1580 "documentation":"<p>The unique identifier of the deployment.</p>" 1581 }, 1582 "environmentId":{ 1583 "shape":"Identifier", 1584 "documentation":"<p>The unique identifier of the runtime environment.</p>" 1585 }, 1586 "status":{ 1587 "shape":"DeploymentLifecycle", 1588 "documentation":"<p>The current status of the deployment.</p>" 1589 }, 1590 "statusReason":{ 1591 "shape":"String", 1592 "documentation":"<p>The reason for the reported status.</p>" 1593 } 1594 }, 1595 "documentation":"<p>A subset of information about a specific deployment.</p>" 1596 }, 1597 "EfsStorageConfiguration":{ 1598 "type":"structure", 1599 "required":[ 1600 "fileSystemId", 1601 "mountPoint" 1602 ], 1603 "members":{ 1604 "fileSystemId":{ 1605 "shape":"String200", 1606 "documentation":"<p>The file system identifier.</p>", 1607 "locationName":"file-system-id" 1608 }, 1609 "mountPoint":{ 1610 "shape":"String200", 1611 "documentation":"<p>The mount point for the file system.</p>", 1612 "locationName":"mount-point" 1613 } 1614 }, 1615 "documentation":"<p>Defines the storage configuration for an Amazon EFS file system.</p>" 1616 }, 1617 "EngineType":{ 1618 "type":"string", 1619 "enum":[ 1620 "microfocus", 1621 "bluage" 1622 ] 1623 }, 1624 "EngineVersion":{ 1625 "type":"string", 1626 "pattern":"^\\S{1,10}$" 1627 }, 1628 "EngineVersionsSummary":{ 1629 "type":"structure", 1630 "required":[ 1631 "engineType", 1632 "engineVersion" 1633 ], 1634 "members":{ 1635 "engineType":{ 1636 "shape":"String", 1637 "documentation":"<p>The type of target platform for the application.</p>" 1638 }, 1639 "engineVersion":{ 1640 "shape":"String", 1641 "documentation":"<p>The version of the engine type used by the application.</p>" 1642 } 1643 }, 1644 "documentation":"<p>A subset of information about the engine version for a specific application.</p>" 1645 }, 1646 "EngineVersionsSummaryList":{ 1647 "type":"list", 1648 "member":{"shape":"EngineVersionsSummary"} 1649 }, 1650 "EntityDescription":{ 1651 "type":"string", 1652 "max":500, 1653 "min":0 1654 }, 1655 "EntityName":{ 1656 "type":"string", 1657 "pattern":"^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$" 1658 }, 1659 "EntityNameList":{ 1660 "type":"list", 1661 "member":{"shape":"EntityName"}, 1662 "max":10, 1663 "min":1 1664 }, 1665 "EnvironmentLifecycle":{ 1666 "type":"string", 1667 "enum":[ 1668 "Creating", 1669 "Available", 1670 "Updating", 1671 "Deleting", 1672 "Failed" 1673 ] 1674 }, 1675 "EnvironmentSummary":{ 1676 "type":"structure", 1677 "required":[ 1678 "creationTime", 1679 "engineType", 1680 "engineVersion", 1681 "environmentArn", 1682 "environmentId", 1683 "instanceType", 1684 "name", 1685 "status" 1686 ], 1687 "members":{ 1688 "creationTime":{ 1689 "shape":"Timestamp", 1690 "documentation":"<p>The timestamp when the runtime environment was created.</p>" 1691 }, 1692 "engineType":{ 1693 "shape":"EngineType", 1694 "documentation":"<p>The target platform for the runtime environment.</p>" 1695 }, 1696 "engineVersion":{ 1697 "shape":"EngineVersion", 1698 "documentation":"<p>The version of the runtime engine.</p>" 1699 }, 1700 "environmentArn":{ 1701 "shape":"Arn", 1702 "documentation":"<p>The Amazon Resource Name (ARN) of a particular runtime environment.</p>" 1703 }, 1704 "environmentId":{ 1705 "shape":"Identifier", 1706 "documentation":"<p>The unique identifier of a particular runtime environment.</p>" 1707 }, 1708 "instanceType":{ 1709 "shape":"String20", 1710 "documentation":"<p>The instance type of the runtime environment.</p>" 1711 }, 1712 "name":{ 1713 "shape":"EntityName", 1714 "documentation":"<p>The name of the runtime environment.</p>" 1715 }, 1716 "status":{ 1717 "shape":"EnvironmentLifecycle", 1718 "documentation":"<p>The status of the runtime environment</p>" 1719 } 1720 }, 1721 "documentation":"<p>Contains a subset of the possible runtime environment attributes. Used in the environment list.</p>" 1722 }, 1723 "EnvironmentSummaryList":{ 1724 "type":"list", 1725 "member":{"shape":"EnvironmentSummary"} 1726 }, 1727 "ExecutionTimeoutException":{ 1728 "type":"structure", 1729 "required":["message"], 1730 "members":{ 1731 "message":{"shape":"String"} 1732 }, 1733 "documentation":"<p> Failed to connect to server, or didn’t receive response within expected time period.</p>", 1734 "error":{"httpStatusCode":504}, 1735 "exception":true, 1736 "fault":true, 1737 "retryable":{"throttling":false} 1738 }, 1739 "ExternalLocation":{ 1740 "type":"structure", 1741 "members":{ 1742 "s3Location":{ 1743 "shape":"String2000", 1744 "documentation":"<p>The URI of the Amazon S3 bucket.</p>" 1745 } 1746 }, 1747 "documentation":"<p>Defines an external storage location.</p>", 1748 "union":true 1749 }, 1750 "FileBatchJobDefinition":{ 1751 "type":"structure", 1752 "required":["fileName"], 1753 "members":{ 1754 "fileName":{ 1755 "shape":"String", 1756 "documentation":"<p>The name of the file containing the batch job definition.</p>" 1757 }, 1758 "folderPath":{ 1759 "shape":"String", 1760 "documentation":"<p>The path to the file containing the batch job definition.</p>" 1761 } 1762 }, 1763 "documentation":"<p>A file containing a batch job definition.</p>" 1764 }, 1765 "FileBatchJobIdentifier":{ 1766 "type":"structure", 1767 "required":["fileName"], 1768 "members":{ 1769 "fileName":{ 1770 "shape":"String", 1771 "documentation":"<p>The file name for the batch job identifier.</p>" 1772 }, 1773 "folderPath":{ 1774 "shape":"String", 1775 "documentation":"<p>The relative path to the file name for the batch job identifier.</p>" 1776 } 1777 }, 1778 "documentation":"<p>A batch job identifier in which the batch job to run is identified by the file name and the relative path to the file name.</p>" 1779 }, 1780 "FsxStorageConfiguration":{ 1781 "type":"structure", 1782 "required":[ 1783 "fileSystemId", 1784 "mountPoint" 1785 ], 1786 "members":{ 1787 "fileSystemId":{ 1788 "shape":"String200", 1789 "documentation":"<p>The file system identifier.</p>", 1790 "locationName":"file-system-id" 1791 }, 1792 "mountPoint":{ 1793 "shape":"String200", 1794 "documentation":"<p>The mount point for the file system.</p>", 1795 "locationName":"mount-point" 1796 } 1797 }, 1798 "documentation":"<p>Defines the storage configuration for an Amazon FSx file system.</p>" 1799 }, 1800 "GdgAttributes":{ 1801 "type":"structure", 1802 "members":{ 1803 "limit":{ 1804 "shape":"Integer", 1805 "documentation":"<p>The maximum number of generation data sets, up to 255, in a GDG.</p>" 1806 }, 1807 "rollDisposition":{ 1808 "shape":"String", 1809 "documentation":"<p>The disposition of the data set in the catalog.</p>" 1810 } 1811 }, 1812 "documentation":"<p>The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data sets that together are known as a generation data group (GDG). Use this structure when you want to import a GDG. For more information on GDG, see <a href=\"https://www.ibm.com/docs/en/zos/2.3.0?topic=guide-generation-data-sets\">Generation data sets</a>.</p>" 1813 }, 1814 "GdgDetailAttributes":{ 1815 "type":"structure", 1816 "members":{ 1817 "limit":{ 1818 "shape":"Integer", 1819 "documentation":"<p>The maximum number of generation data sets, up to 255, in a GDG.</p>" 1820 }, 1821 "rollDisposition":{ 1822 "shape":"String50", 1823 "documentation":"<p>The disposition of the data set in the catalog.</p>" 1824 } 1825 }, 1826 "documentation":"<p>The required attributes for a generation data group data set. A generation data set is one of a collection of successive, historically related, catalogued data sets that together are known as a generation data group (GDG). Use this structure when you want to import a GDG. For more information on GDG, see <a href=\"https://www.ibm.com/docs/en/zos/2.3.0?topic=guide-generation-data-sets\">Generation data sets</a>.</p>" 1827 }, 1828 "GetApplicationRequest":{ 1829 "type":"structure", 1830 "required":["applicationId"], 1831 "members":{ 1832 "applicationId":{ 1833 "shape":"Identifier", 1834 "documentation":"<p>The identifier of the application.</p>", 1835 "location":"uri", 1836 "locationName":"applicationId" 1837 } 1838 } 1839 }, 1840 "GetApplicationResponse":{ 1841 "type":"structure", 1842 "required":[ 1843 "applicationArn", 1844 "applicationId", 1845 "creationTime", 1846 "engineType", 1847 "latestVersion", 1848 "name", 1849 "status" 1850 ], 1851 "members":{ 1852 "applicationArn":{ 1853 "shape":"Arn", 1854 "documentation":"<p>The Amazon Resource Name (ARN) of the application.</p>" 1855 }, 1856 "applicationId":{ 1857 "shape":"Identifier", 1858 "documentation":"<p>The identifier of the application.</p>" 1859 }, 1860 "creationTime":{ 1861 "shape":"Timestamp", 1862 "documentation":"<p>The timestamp when this application was created.</p>" 1863 }, 1864 "deployedVersion":{ 1865 "shape":"DeployedVersionSummary", 1866 "documentation":"<p>The version of the application that is deployed.</p>" 1867 }, 1868 "description":{ 1869 "shape":"EntityDescription", 1870 "documentation":"<p>The description of the application.</p>" 1871 }, 1872 "engineType":{ 1873 "shape":"EngineType", 1874 "documentation":"<p>The type of the target platform for the application.</p>" 1875 }, 1876 "environmentId":{ 1877 "shape":"Identifier", 1878 "documentation":"<p>The identifier of the runtime environment where you want to deploy the application.</p>" 1879 }, 1880 "kmsKeyId":{ 1881 "shape":"String", 1882 "documentation":"<p>The identifier of a customer managed key.</p>" 1883 }, 1884 "lastStartTime":{ 1885 "shape":"Timestamp", 1886 "documentation":"<p>The timestamp when you last started the application. Null until the application runs for the first time.</p>" 1887 }, 1888 "latestVersion":{ 1889 "shape":"ApplicationVersionSummary", 1890 "documentation":"<p>The latest version of the application.</p>" 1891 }, 1892 "listenerArns":{ 1893 "shape":"ArnList", 1894 "documentation":"<p>The Amazon Resource Name (ARN) for the network load balancer listener created in your Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener for you the first time you deploy an application.</p>" 1895 }, 1896 "listenerPorts":{ 1897 "shape":"PortList", 1898 "documentation":"<p>The port associated with the network load balancer listener created in your Amazon Web Services account.</p>" 1899 }, 1900 "loadBalancerDnsName":{ 1901 "shape":"String100", 1902 "documentation":"<p>The public DNS name of the load balancer created in your Amazon Web Services account.</p>" 1903 }, 1904 "logGroups":{ 1905 "shape":"LogGroupSummaries", 1906 "documentation":"<p>The list of log summaries. Each log summary includes the log type as well as the log group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under the customer's account.</p>" 1907 }, 1908 "name":{ 1909 "shape":"EntityName", 1910 "documentation":"<p>The unique identifier of the application.</p>" 1911 }, 1912 "roleArn":{ 1913 "shape":"Arn", 1914 "documentation":"<p>The Amazon Resource Name (ARN) of the role associated with the application.</p>" 1915 }, 1916 "status":{ 1917 "shape":"ApplicationLifecycle", 1918 "documentation":"<p>The status of the application.</p>" 1919 }, 1920 "statusReason":{ 1921 "shape":"String", 1922 "documentation":"<p>The reason for the reported status.</p>" 1923 }, 1924 "tags":{ 1925 "shape":"TagMap", 1926 "documentation":"<p>A list of tags associated with the application.</p>" 1927 }, 1928 "targetGroupArns":{ 1929 "shape":"ArnList", 1930 "documentation":"<p>Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the network load balancer.</p>" 1931 } 1932 } 1933 }, 1934 "GetApplicationVersionRequest":{ 1935 "type":"structure", 1936 "required":[ 1937 "applicationId", 1938 "applicationVersion" 1939 ], 1940 "members":{ 1941 "applicationId":{ 1942 "shape":"Identifier", 1943 "documentation":"<p>The unique identifier of the application.</p>", 1944 "location":"uri", 1945 "locationName":"applicationId" 1946 }, 1947 "applicationVersion":{ 1948 "shape":"Version", 1949 "documentation":"<p>The specific version of the application.</p>", 1950 "location":"uri", 1951 "locationName":"applicationVersion" 1952 } 1953 } 1954 }, 1955 "GetApplicationVersionResponse":{ 1956 "type":"structure", 1957 "required":[ 1958 "applicationVersion", 1959 "creationTime", 1960 "definitionContent", 1961 "name", 1962 "status" 1963 ], 1964 "members":{ 1965 "applicationVersion":{ 1966 "shape":"Version", 1967 "documentation":"<p>The specific version of the application.</p>" 1968 }, 1969 "creationTime":{ 1970 "shape":"Timestamp", 1971 "documentation":"<p>The timestamp when the application version was created.</p>" 1972 }, 1973 "definitionContent":{ 1974 "shape":"StringFree65000", 1975 "documentation":"<p>The content of the application definition. This is a JSON object that contains the resource configuration and definitions that identify an application.</p>" 1976 }, 1977 "description":{ 1978 "shape":"EntityDescription", 1979 "documentation":"<p>The application description.</p>" 1980 }, 1981 "name":{ 1982 "shape":"EntityName", 1983 "documentation":"<p>The name of the application version.</p>" 1984 }, 1985 "status":{ 1986 "shape":"ApplicationVersionLifecycle", 1987 "documentation":"<p>The status of the application version.</p>" 1988 }, 1989 "statusReason":{ 1990 "shape":"String", 1991 "documentation":"<p>The reason for the reported status.</p>" 1992 } 1993 } 1994 }, 1995 "GetBatchJobExecutionRequest":{ 1996 "type":"structure", 1997 "required":[ 1998 "applicationId", 1999 "executionId" 2000 ], 2001 "members":{ 2002 "applicationId":{ 2003 "shape":"Identifier", 2004 "documentation":"<p>The identifier of the application.</p>", 2005 "location":"uri", 2006 "locationName":"applicationId" 2007 }, 2008 "executionId":{ 2009 "shape":"Identifier", 2010 "documentation":"<p>The unique identifier of the batch job execution.</p>", 2011 "location":"uri", 2012 "locationName":"executionId" 2013 } 2014 } 2015 }, 2016 "GetBatchJobExecutionResponse":{ 2017 "type":"structure", 2018 "required":[ 2019 "applicationId", 2020 "executionId", 2021 "startTime", 2022 "status" 2023 ], 2024 "members":{ 2025 "applicationId":{ 2026 "shape":"Identifier", 2027 "documentation":"<p>The identifier of the application.</p>" 2028 }, 2029 "batchJobIdentifier":{ 2030 "shape":"BatchJobIdentifier", 2031 "documentation":"<p>The unique identifier of this batch job.</p>" 2032 }, 2033 "endTime":{ 2034 "shape":"Timestamp", 2035 "documentation":"<p>The timestamp when the batch job execution ended.</p>" 2036 }, 2037 "executionId":{ 2038 "shape":"Identifier", 2039 "documentation":"<p>The unique identifier for this batch job execution.</p>" 2040 }, 2041 "jobId":{ 2042 "shape":"String100", 2043 "documentation":"<p>The unique identifier for this batch job.</p>" 2044 }, 2045 "jobName":{ 2046 "shape":"String100", 2047 "documentation":"<p>The name of this batch job.</p>" 2048 }, 2049 "jobType":{ 2050 "shape":"BatchJobType", 2051 "documentation":"<p>The type of job.</p>" 2052 }, 2053 "jobUser":{ 2054 "shape":"String100", 2055 "documentation":"<p>The user for the job.</p>" 2056 }, 2057 "returnCode":{ 2058 "shape":"String", 2059 "documentation":"<p>The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see <a href=\"https://www.ibm.com/docs/en/was/8.5.5?topic=model-batch-return-codes\">Batch return codes</a> in the <i>IBM WebSphere Application Server</i> documentation.</p>" 2060 }, 2061 "startTime":{ 2062 "shape":"Timestamp", 2063 "documentation":"<p>The timestamp when the batch job execution started.</p>" 2064 }, 2065 "status":{ 2066 "shape":"BatchJobExecutionStatus", 2067 "documentation":"<p>The status of the batch job execution.</p>" 2068 }, 2069 "statusReason":{ 2070 "shape":"String", 2071 "documentation":"<p>The reason for the reported status.</p>" 2072 } 2073 } 2074 }, 2075 "GetDataSetDetailsRequest":{ 2076 "type":"structure", 2077 "required":[ 2078 "applicationId", 2079 "dataSetName" 2080 ], 2081 "members":{ 2082 "applicationId":{ 2083 "shape":"Identifier", 2084 "documentation":"<p>The unique identifier of the application that this data set is associated with.</p>", 2085 "location":"uri", 2086 "locationName":"applicationId" 2087 }, 2088 "dataSetName":{ 2089 "shape":"String200", 2090 "documentation":"<p>The name of the data set.</p>", 2091 "location":"uri", 2092 "locationName":"dataSetName" 2093 } 2094 } 2095 }, 2096 "GetDataSetDetailsResponse":{ 2097 "type":"structure", 2098 "required":["dataSetName"], 2099 "members":{ 2100 "blocksize":{ 2101 "shape":"Integer", 2102 "documentation":"<p>The size of the block on disk. </p>", 2103 "box":true 2104 }, 2105 "creationTime":{ 2106 "shape":"Timestamp", 2107 "documentation":"<p>The timestamp when the data set was created.</p>" 2108 }, 2109 "dataSetName":{ 2110 "shape":"String200", 2111 "documentation":"<p>The name of the data set.</p>" 2112 }, 2113 "dataSetOrg":{ 2114 "shape":"DatasetDetailOrgAttributes", 2115 "documentation":"<p>The type of data set. The only supported value is VSAM.</p>" 2116 }, 2117 "fileSize":{ 2118 "shape":"Long", 2119 "documentation":"<p>File size of the dataset.</p>" 2120 }, 2121 "lastReferencedTime":{ 2122 "shape":"Timestamp", 2123 "documentation":"<p>The last time the data set was referenced.</p>" 2124 }, 2125 "lastUpdatedTime":{ 2126 "shape":"Timestamp", 2127 "documentation":"<p>The last time the data set was updated.</p>" 2128 }, 2129 "location":{ 2130 "shape":"String2000", 2131 "documentation":"<p>The location where the data set is stored.</p>" 2132 }, 2133 "recordLength":{ 2134 "shape":"Integer", 2135 "documentation":"<p>The length of records in the data set.</p>", 2136 "box":true 2137 } 2138 } 2139 }, 2140 "GetDataSetImportTaskRequest":{ 2141 "type":"structure", 2142 "required":[ 2143 "applicationId", 2144 "taskId" 2145 ], 2146 "members":{ 2147 "applicationId":{ 2148 "shape":"Identifier", 2149 "documentation":"<p>The application identifier.</p>", 2150 "location":"uri", 2151 "locationName":"applicationId" 2152 }, 2153 "taskId":{ 2154 "shape":"Identifier", 2155 "documentation":"<p>The task identifier returned by the <a>CreateDataSetImportTask</a> operation. </p>", 2156 "location":"uri", 2157 "locationName":"taskId" 2158 } 2159 } 2160 }, 2161 "GetDataSetImportTaskResponse":{ 2162 "type":"structure", 2163 "required":[ 2164 "status", 2165 "taskId" 2166 ], 2167 "members":{ 2168 "status":{ 2169 "shape":"DataSetTaskLifecycle", 2170 "documentation":"<p>The status of the task.</p>" 2171 }, 2172 "summary":{ 2173 "shape":"DataSetImportSummary", 2174 "documentation":"<p>A summary of the status of the task.</p>" 2175 }, 2176 "taskId":{ 2177 "shape":"Identifier", 2178 "documentation":"<p>The task identifier.</p>" 2179 } 2180 } 2181 }, 2182 "GetDeploymentRequest":{ 2183 "type":"structure", 2184 "required":[ 2185 "applicationId", 2186 "deploymentId" 2187 ], 2188 "members":{ 2189 "applicationId":{ 2190 "shape":"Identifier", 2191 "documentation":"<p>The unique identifier of the application.</p>", 2192 "location":"uri", 2193 "locationName":"applicationId" 2194 }, 2195 "deploymentId":{ 2196 "shape":"Identifier", 2197 "documentation":"<p>The unique identifier for the deployment.</p>", 2198 "location":"uri", 2199 "locationName":"deploymentId" 2200 } 2201 } 2202 }, 2203 "GetDeploymentResponse":{ 2204 "type":"structure", 2205 "required":[ 2206 "applicationId", 2207 "applicationVersion", 2208 "creationTime", 2209 "deploymentId", 2210 "environmentId", 2211 "status" 2212 ], 2213 "members":{ 2214 "applicationId":{ 2215 "shape":"Identifier", 2216 "documentation":"<p>The unique identifier of the application.</p>" 2217 }, 2218 "applicationVersion":{ 2219 "shape":"Version", 2220 "documentation":"<p>The application version.</p>" 2221 }, 2222 "creationTime":{ 2223 "shape":"Timestamp", 2224 "documentation":"<p>The timestamp when the deployment was created.</p>" 2225 }, 2226 "deploymentId":{ 2227 "shape":"Identifier", 2228 "documentation":"<p>The unique identifier of the deployment.</p>" 2229 }, 2230 "environmentId":{ 2231 "shape":"Identifier", 2232 "documentation":"<p>The unique identifier of the runtime environment.</p>" 2233 }, 2234 "status":{ 2235 "shape":"DeploymentLifecycle", 2236 "documentation":"<p>The status of the deployment.</p>" 2237 }, 2238 "statusReason":{ 2239 "shape":"String", 2240 "documentation":"<p>The reason for the reported status.</p>" 2241 } 2242 } 2243 }, 2244 "GetEnvironmentRequest":{ 2245 "type":"structure", 2246 "required":["environmentId"], 2247 "members":{ 2248 "environmentId":{ 2249 "shape":"Identifier", 2250 "documentation":"<p>The unique identifier of the runtime environment.</p>", 2251 "location":"uri", 2252 "locationName":"environmentId" 2253 } 2254 } 2255 }, 2256 "GetEnvironmentResponse":{ 2257 "type":"structure", 2258 "required":[ 2259 "creationTime", 2260 "engineType", 2261 "engineVersion", 2262 "environmentArn", 2263 "environmentId", 2264 "instanceType", 2265 "name", 2266 "securityGroupIds", 2267 "status", 2268 "subnetIds", 2269 "vpcId" 2270 ], 2271 "members":{ 2272 "actualCapacity":{ 2273 "shape":"CapacityValue", 2274 "documentation":"<p>The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances. </p>" 2275 }, 2276 "creationTime":{ 2277 "shape":"Timestamp", 2278 "documentation":"<p>The timestamp when the runtime environment was created.</p>" 2279 }, 2280 "description":{ 2281 "shape":"EntityDescription", 2282 "documentation":"<p>The description of the runtime environment.</p>" 2283 }, 2284 "engineType":{ 2285 "shape":"EngineType", 2286 "documentation":"<p>The target platform for the runtime environment.</p>" 2287 }, 2288 "engineVersion":{ 2289 "shape":"EngineVersion", 2290 "documentation":"<p>The version of the runtime engine.</p>" 2291 }, 2292 "environmentArn":{ 2293 "shape":"Arn", 2294 "documentation":"<p>The Amazon Resource Name (ARN) of the runtime environment.</p>" 2295 }, 2296 "environmentId":{ 2297 "shape":"Identifier", 2298 "documentation":"<p>The unique identifier of the runtime environment.</p>" 2299 }, 2300 "highAvailabilityConfig":{ 2301 "shape":"HighAvailabilityConfig", 2302 "documentation":"<p>The desired capacity of the high availability configuration for the runtime environment.</p>" 2303 }, 2304 "instanceType":{ 2305 "shape":"String20", 2306 "documentation":"<p>The type of instance underlying the runtime environment.</p>" 2307 }, 2308 "kmsKeyId":{ 2309 "shape":"String", 2310 "documentation":"<p>The identifier of a customer managed key.</p>" 2311 }, 2312 "loadBalancerArn":{ 2313 "shape":"String", 2314 "documentation":"<p>The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.</p>" 2315 }, 2316 "name":{ 2317 "shape":"EntityName", 2318 "documentation":"<p>The name of the runtime environment. Must be unique within the account.</p>" 2319 }, 2320 "pendingMaintenance":{ 2321 "shape":"PendingMaintenance", 2322 "documentation":"<p>Indicates the pending maintenance scheduled on this environment.</p>" 2323 }, 2324 "preferredMaintenanceWindow":{ 2325 "shape":"String50", 2326 "documentation":"<p>The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.</p>" 2327 }, 2328 "publiclyAccessible":{ 2329 "shape":"Boolean", 2330 "documentation":"<p>Whether applications running in this runtime environment are publicly accessible. </p>" 2331 }, 2332 "securityGroupIds":{ 2333 "shape":"String50List", 2334 "documentation":"<p>The unique identifiers of the security groups assigned to this runtime environment.</p>" 2335 }, 2336 "status":{ 2337 "shape":"EnvironmentLifecycle", 2338 "documentation":"<p>The status of the runtime environment.</p>" 2339 }, 2340 "statusReason":{ 2341 "shape":"String", 2342 "documentation":"<p>The reason for the reported status.</p>" 2343 }, 2344 "storageConfigurations":{ 2345 "shape":"StorageConfigurationList", 2346 "documentation":"<p>The storage configurations defined for the runtime environment.</p>" 2347 }, 2348 "subnetIds":{ 2349 "shape":"String50List", 2350 "documentation":"<p>The unique identifiers of the subnets assigned to this runtime environment.</p>" 2351 }, 2352 "tags":{ 2353 "shape":"TagMap", 2354 "documentation":"<p>The tags defined for this runtime environment.</p>" 2355 }, 2356 "vpcId":{ 2357 "shape":"String50", 2358 "documentation":"<p>The unique identifier for the VPC used with this runtime environment.</p>" 2359 } 2360 } 2361 }, 2362 "GetSignedBluinsightsUrlResponse":{ 2363 "type":"structure", 2364 "required":["signedBiUrl"], 2365 "members":{ 2366 "signedBiUrl":{ 2367 "shape":"String", 2368 "documentation":"<p>Single sign-on AWS Blu Insights URL.</p>" 2369 } 2370 } 2371 }, 2372 "HighAvailabilityConfig":{ 2373 "type":"structure", 2374 "required":["desiredCapacity"], 2375 "members":{ 2376 "desiredCapacity":{ 2377 "shape":"CapacityValue", 2378 "documentation":"<p>The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.</p>" 2379 } 2380 }, 2381 "documentation":"<p>Defines the details of a high availability configuration.</p>" 2382 }, 2383 "Identifier":{ 2384 "type":"string", 2385 "pattern":"^\\S{1,80}$" 2386 }, 2387 "IdentifierList":{ 2388 "type":"list", 2389 "member":{"shape":"Identifier"}, 2390 "max":10, 2391 "min":1 2392 }, 2393 "Integer":{"type":"integer"}, 2394 "InternalServerException":{ 2395 "type":"structure", 2396 "required":["message"], 2397 "members":{ 2398 "message":{"shape":"String"}, 2399 "retryAfterSeconds":{ 2400 "shape":"Integer", 2401 "documentation":"<p>The number of seconds to wait before retrying the request.</p>", 2402 "location":"header", 2403 "locationName":"Retry-After" 2404 } 2405 }, 2406 "documentation":"<p>An unexpected error occurred during the processing of the request.</p>", 2407 "error":{"httpStatusCode":500}, 2408 "exception":true, 2409 "fault":true, 2410 "retryable":{"throttling":false} 2411 }, 2412 "JobIdentifier":{ 2413 "type":"structure", 2414 "members":{ 2415 "fileName":{ 2416 "shape":"String", 2417 "documentation":"<p>The name of the file that contains the batch job definition.</p>" 2418 }, 2419 "scriptName":{ 2420 "shape":"String", 2421 "documentation":"<p>The name of the script that contains the batch job definition.</p>" 2422 } 2423 }, 2424 "documentation":"<p>Identifies a specific batch job.</p>", 2425 "union":true 2426 }, 2427 "ListApplicationVersionsRequest":{ 2428 "type":"structure", 2429 "required":["applicationId"], 2430 "members":{ 2431 "applicationId":{ 2432 "shape":"Identifier", 2433 "documentation":"<p>The unique identifier of the application.</p>", 2434 "location":"uri", 2435 "locationName":"applicationId" 2436 }, 2437 "maxResults":{ 2438 "shape":"MaxResults", 2439 "documentation":"<p>The maximum number of application versions to return.</p>", 2440 "location":"querystring", 2441 "locationName":"maxResults" 2442 }, 2443 "nextToken":{ 2444 "shape":"NextToken", 2445 "documentation":"<p>A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.</p>", 2446 "location":"querystring", 2447 "locationName":"nextToken" 2448 } 2449 } 2450 }, 2451 "ListApplicationVersionsResponse":{ 2452 "type":"structure", 2453 "required":["applicationVersions"], 2454 "members":{ 2455 "applicationVersions":{ 2456 "shape":"ApplicationVersionSummaryList", 2457 "documentation":"<p>The list of application versions.</p>" 2458 }, 2459 "nextToken":{ 2460 "shape":"NextToken", 2461 "documentation":"<p>If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.</p>" 2462 } 2463 } 2464 }, 2465 "ListApplicationsRequest":{ 2466 "type":"structure", 2467 "members":{ 2468 "environmentId":{ 2469 "shape":"Identifier", 2470 "documentation":"<p>The unique identifier of the runtime environment where the applications are deployed.</p>", 2471 "location":"querystring", 2472 "locationName":"environmentId" 2473 }, 2474 "maxResults":{ 2475 "shape":"MaxResults", 2476 "documentation":"<p>The maximum number of applications to return.</p>", 2477 "location":"querystring", 2478 "locationName":"maxResults" 2479 }, 2480 "names":{ 2481 "shape":"EntityNameList", 2482 "documentation":"<p>The names of the applications.</p>", 2483 "location":"querystring", 2484 "locationName":"names" 2485 }, 2486 "nextToken":{ 2487 "shape":"NextToken", 2488 "documentation":"<p>A pagination token to control the number of applications displayed in the list.</p>", 2489 "location":"querystring", 2490 "locationName":"nextToken" 2491 } 2492 } 2493 }, 2494 "ListApplicationsResponse":{ 2495 "type":"structure", 2496 "required":["applications"], 2497 "members":{ 2498 "applications":{ 2499 "shape":"ApplicationSummaryList", 2500 "documentation":"<p>Returns a list of summary details for all the applications in a runtime environment.</p>" 2501 }, 2502 "nextToken":{ 2503 "shape":"NextToken", 2504 "documentation":"<p>A pagination token that's returned when the response doesn't contain all applications.</p>" 2505 } 2506 } 2507 }, 2508 "ListBatchJobDefinitionsRequest":{ 2509 "type":"structure", 2510 "required":["applicationId"], 2511 "members":{ 2512 "applicationId":{ 2513 "shape":"Identifier", 2514 "documentation":"<p>The identifier of the application.</p>", 2515 "location":"uri", 2516 "locationName":"applicationId" 2517 }, 2518 "maxResults":{ 2519 "shape":"MaxResults", 2520 "documentation":"<p>The maximum number of batch job definitions to return.</p>", 2521 "location":"querystring", 2522 "locationName":"maxResults" 2523 }, 2524 "nextToken":{ 2525 "shape":"NextToken", 2526 "documentation":"<p>A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.</p>", 2527 "location":"querystring", 2528 "locationName":"nextToken" 2529 }, 2530 "prefix":{ 2531 "shape":"String", 2532 "documentation":"<p>If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.</p>", 2533 "location":"querystring", 2534 "locationName":"prefix" 2535 } 2536 } 2537 }, 2538 "ListBatchJobDefinitionsResponse":{ 2539 "type":"structure", 2540 "required":["batchJobDefinitions"], 2541 "members":{ 2542 "batchJobDefinitions":{ 2543 "shape":"BatchJobDefinitions", 2544 "documentation":"<p>The list of batch job definitions.</p>" 2545 }, 2546 "nextToken":{ 2547 "shape":"NextToken", 2548 "documentation":"<p>If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.</p>" 2549 } 2550 } 2551 }, 2552 "ListBatchJobExecutionsRequest":{ 2553 "type":"structure", 2554 "required":["applicationId"], 2555 "members":{ 2556 "applicationId":{ 2557 "shape":"Identifier", 2558 "documentation":"<p>The unique identifier of the application.</p>", 2559 "location":"uri", 2560 "locationName":"applicationId" 2561 }, 2562 "executionIds":{ 2563 "shape":"IdentifierList", 2564 "documentation":"<p>The unique identifier of each batch job execution.</p>", 2565 "location":"querystring", 2566 "locationName":"executionIds" 2567 }, 2568 "jobName":{ 2569 "shape":"String100", 2570 "documentation":"<p>The name of each batch job execution.</p>", 2571 "location":"querystring", 2572 "locationName":"jobName" 2573 }, 2574 "maxResults":{ 2575 "shape":"MaxResults", 2576 "documentation":"<p>The maximum number of batch job executions to return.</p>", 2577 "location":"querystring", 2578 "locationName":"maxResults" 2579 }, 2580 "nextToken":{ 2581 "shape":"NextToken", 2582 "documentation":"<p>A pagination token to control the number of batch job executions displayed in the list.</p>", 2583 "location":"querystring", 2584 "locationName":"nextToken" 2585 }, 2586 "startedAfter":{ 2587 "shape":"Timestamp", 2588 "documentation":"<p>The time after which the batch job executions started.</p>", 2589 "location":"querystring", 2590 "locationName":"startedAfter" 2591 }, 2592 "startedBefore":{ 2593 "shape":"Timestamp", 2594 "documentation":"<p>The time before the batch job executions started.</p>", 2595 "location":"querystring", 2596 "locationName":"startedBefore" 2597 }, 2598 "status":{ 2599 "shape":"BatchJobExecutionStatus", 2600 "documentation":"<p>The status of the batch job executions.</p>", 2601 "location":"querystring", 2602 "locationName":"status" 2603 } 2604 } 2605 }, 2606 "ListBatchJobExecutionsResponse":{ 2607 "type":"structure", 2608 "required":["batchJobExecutions"], 2609 "members":{ 2610 "batchJobExecutions":{ 2611 "shape":"BatchJobExecutionSummaryList", 2612 "documentation":"<p>Returns a list of batch job executions for an application.</p>" 2613 }, 2614 "nextToken":{ 2615 "shape":"NextToken", 2616 "documentation":"<p>A pagination token that's returned when the response doesn't contain all batch job executions.</p>" 2617 } 2618 } 2619 }, 2620 "ListDataSetImportHistoryRequest":{ 2621 "type":"structure", 2622 "required":["applicationId"], 2623 "members":{ 2624 "applicationId":{ 2625 "shape":"Identifier", 2626 "documentation":"<p>The unique identifier of the application.</p>", 2627 "location":"uri", 2628 "locationName":"applicationId" 2629 }, 2630 "maxResults":{ 2631 "shape":"MaxResults", 2632 "documentation":"<p>The maximum number of objects to return.</p>", 2633 "location":"querystring", 2634 "locationName":"maxResults" 2635 }, 2636 "nextToken":{ 2637 "shape":"NextToken", 2638 "documentation":"<p>A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.</p>", 2639 "location":"querystring", 2640 "locationName":"nextToken" 2641 } 2642 } 2643 }, 2644 "ListDataSetImportHistoryResponse":{ 2645 "type":"structure", 2646 "required":["dataSetImportTasks"], 2647 "members":{ 2648 "dataSetImportTasks":{ 2649 "shape":"DataSetImportTaskList", 2650 "documentation":"<p>The data set import tasks.</p>" 2651 }, 2652 "nextToken":{ 2653 "shape":"NextToken", 2654 "documentation":"<p>If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.</p>" 2655 } 2656 } 2657 }, 2658 "ListDataSetsRequest":{ 2659 "type":"structure", 2660 "required":["applicationId"], 2661 "members":{ 2662 "applicationId":{ 2663 "shape":"Identifier", 2664 "documentation":"<p>The unique identifier of the application for which you want to list the associated data sets.</p>", 2665 "location":"uri", 2666 "locationName":"applicationId" 2667 }, 2668 "maxResults":{ 2669 "shape":"MaxResults", 2670 "documentation":"<p>The maximum number of objects to return.</p>", 2671 "location":"querystring", 2672 "locationName":"maxResults" 2673 }, 2674 "nameFilter":{ 2675 "shape":"String200", 2676 "documentation":"<p>Filter dataset name matching the specified pattern. Can use * and % as wild cards.</p>", 2677 "location":"querystring", 2678 "locationName":"nameFilter" 2679 }, 2680 "nextToken":{ 2681 "shape":"NextToken", 2682 "documentation":"<p>A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.</p>", 2683 "location":"querystring", 2684 "locationName":"nextToken" 2685 }, 2686 "prefix":{ 2687 "shape":"String200", 2688 "documentation":"<p>The prefix of the data set name, which you can use to filter the list of data sets.</p>", 2689 "location":"querystring", 2690 "locationName":"prefix" 2691 } 2692 } 2693 }, 2694 "ListDataSetsResponse":{ 2695 "type":"structure", 2696 "required":["dataSets"], 2697 "members":{ 2698 "dataSets":{ 2699 "shape":"DataSetsSummaryList", 2700 "documentation":"<p>The list of data sets, containing information including the creation time, the data set name, the data set organization, the data set format, and the last time the data set was referenced or updated.</p>" 2701 }, 2702 "nextToken":{ 2703 "shape":"NextToken", 2704 "documentation":"<p>If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.</p>" 2705 } 2706 } 2707 }, 2708 "ListDeploymentsRequest":{ 2709 "type":"structure", 2710 "required":["applicationId"], 2711 "members":{ 2712 "applicationId":{ 2713 "shape":"Identifier", 2714 "documentation":"<p>The application identifier.</p>", 2715 "location":"uri", 2716 "locationName":"applicationId" 2717 }, 2718 "maxResults":{ 2719 "shape":"MaxResults", 2720 "documentation":"<p>The maximum number of objects to return.</p>", 2721 "location":"querystring", 2722 "locationName":"maxResults" 2723 }, 2724 "nextToken":{ 2725 "shape":"NextToken", 2726 "documentation":"<p>A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.</p>", 2727 "location":"querystring", 2728 "locationName":"nextToken" 2729 } 2730 } 2731 }, 2732 "ListDeploymentsResponse":{ 2733 "type":"structure", 2734 "required":["deployments"], 2735 "members":{ 2736 "deployments":{ 2737 "shape":"DeploymentList", 2738 "documentation":"<p>The list of deployments that is returned.</p>" 2739 }, 2740 "nextToken":{ 2741 "shape":"NextToken", 2742 "documentation":"<p>If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.</p>" 2743 } 2744 } 2745 }, 2746 "ListEngineVersionsRequest":{ 2747 "type":"structure", 2748 "members":{ 2749 "engineType":{ 2750 "shape":"EngineType", 2751 "documentation":"<p>The type of target platform.</p>", 2752 "location":"querystring", 2753 "locationName":"engineType" 2754 }, 2755 "maxResults":{ 2756 "shape":"MaxResults", 2757 "documentation":"<p>The maximum number of objects to return.</p>", 2758 "location":"querystring", 2759 "locationName":"maxResults" 2760 }, 2761 "nextToken":{ 2762 "shape":"NextToken", 2763 "documentation":"<p>A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.</p>", 2764 "location":"querystring", 2765 "locationName":"nextToken" 2766 } 2767 } 2768 }, 2769 "ListEngineVersionsResponse":{ 2770 "type":"structure", 2771 "required":["engineVersions"], 2772 "members":{ 2773 "engineVersions":{ 2774 "shape":"EngineVersionsSummaryList", 2775 "documentation":"<p>Returns the engine versions.</p>" 2776 }, 2777 "nextToken":{ 2778 "shape":"NextToken", 2779 "documentation":"<p>If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.</p>" 2780 } 2781 } 2782 }, 2783 "ListEnvironmentsRequest":{ 2784 "type":"structure", 2785 "members":{ 2786 "engineType":{ 2787 "shape":"EngineType", 2788 "documentation":"<p>The engine type for the runtime environment.</p>", 2789 "location":"querystring", 2790 "locationName":"engineType" 2791 }, 2792 "maxResults":{ 2793 "shape":"MaxResults", 2794 "documentation":"<p>The maximum number of runtime environments to return.</p>", 2795 "location":"querystring", 2796 "locationName":"maxResults" 2797 }, 2798 "names":{ 2799 "shape":"EntityNameList", 2800 "documentation":"<p>The names of the runtime environments. Must be unique within the account.</p>", 2801 "location":"querystring", 2802 "locationName":"names" 2803 }, 2804 "nextToken":{ 2805 "shape":"NextToken", 2806 "documentation":"<p>A pagination token to control the number of runtime environments displayed in the list.</p>", 2807 "location":"querystring", 2808 "locationName":"nextToken" 2809 } 2810 } 2811 }, 2812 "ListEnvironmentsResponse":{ 2813 "type":"structure", 2814 "required":["environments"], 2815 "members":{ 2816 "environments":{ 2817 "shape":"EnvironmentSummaryList", 2818 "documentation":"<p>Returns a list of summary details for all the runtime environments in your account. </p>" 2819 }, 2820 "nextToken":{ 2821 "shape":"NextToken", 2822 "documentation":"<p>A pagination token that's returned when the response doesn't contain all the runtime environments.</p>" 2823 } 2824 } 2825 }, 2826 "ListTagsForResourceRequest":{ 2827 "type":"structure", 2828 "required":["resourceArn"], 2829 "members":{ 2830 "resourceArn":{ 2831 "shape":"Arn", 2832 "documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>", 2833 "location":"uri", 2834 "locationName":"resourceArn" 2835 } 2836 } 2837 }, 2838 "ListTagsForResourceResponse":{ 2839 "type":"structure", 2840 "required":["tags"], 2841 "members":{ 2842 "tags":{ 2843 "shape":"TagMap", 2844 "documentation":"<p>The tags for the resource.</p>" 2845 } 2846 } 2847 }, 2848 "LogGroupIdentifier":{ 2849 "type":"string", 2850 "max":512, 2851 "min":1 2852 }, 2853 "LogGroupSummaries":{ 2854 "type":"list", 2855 "member":{"shape":"LogGroupSummary"} 2856 }, 2857 "LogGroupSummary":{ 2858 "type":"structure", 2859 "required":[ 2860 "logGroupName", 2861 "logType" 2862 ], 2863 "members":{ 2864 "logGroupName":{ 2865 "shape":"LogGroupIdentifier", 2866 "documentation":"<p>The name of the log group.</p>" 2867 }, 2868 "logType":{ 2869 "shape":"String20", 2870 "documentation":"<p>The type of log.</p>" 2871 } 2872 }, 2873 "documentation":"<p>A subset of the attributes that describe a log group. In CloudWatch a log group is a group of log streams that share the same retention, monitoring, and access control settings.</p>" 2874 }, 2875 "Long":{ 2876 "type":"long", 2877 "box":true 2878 }, 2879 "MaintenanceSchedule":{ 2880 "type":"structure", 2881 "members":{ 2882 "endTime":{ 2883 "shape":"Timestamp", 2884 "documentation":"<p>The time the scheduled maintenance is to end.</p>" 2885 }, 2886 "startTime":{ 2887 "shape":"Timestamp", 2888 "documentation":"<p>The time the scheduled maintenance is to start.</p>" 2889 } 2890 }, 2891 "documentation":"<p>The information about the maintenance schedule.</p>" 2892 }, 2893 "MaxResults":{ 2894 "type":"integer", 2895 "box":true, 2896 "max":2000, 2897 "min":1 2898 }, 2899 "NextToken":{ 2900 "type":"string", 2901 "pattern":"^\\S{1,2000}$" 2902 }, 2903 "PendingMaintenance":{ 2904 "type":"structure", 2905 "members":{ 2906 "engineVersion":{ 2907 "shape":"String", 2908 "documentation":"<p>The specific runtime engine that the maintenance schedule applies to.</p>" 2909 }, 2910 "schedule":{ 2911 "shape":"MaintenanceSchedule", 2912 "documentation":"<p>The maintenance schedule for the runtime engine version.</p>" 2913 } 2914 }, 2915 "documentation":"<p>The scheduled maintenance for a runtime engine.</p>" 2916 }, 2917 "PoAttributes":{ 2918 "type":"structure", 2919 "required":[ 2920 "format", 2921 "memberFileExtensions" 2922 ], 2923 "members":{ 2924 "encoding":{ 2925 "shape":"String", 2926 "documentation":"<p>The character set encoding of the data set.</p>" 2927 }, 2928 "format":{ 2929 "shape":"String", 2930 "documentation":"<p>The format of the data set records.</p>" 2931 }, 2932 "memberFileExtensions":{ 2933 "shape":"String20List", 2934 "documentation":"<p>An array containing one or more filename extensions, allowing you to specify which files to be included as PDS member.</p>" 2935 } 2936 }, 2937 "documentation":"<p>The supported properties for a PO type data set.</p>" 2938 }, 2939 "PoDetailAttributes":{ 2940 "type":"structure", 2941 "required":[ 2942 "encoding", 2943 "format" 2944 ], 2945 "members":{ 2946 "encoding":{ 2947 "shape":"String", 2948 "documentation":"<p>The character set encoding of the data set.</p>" 2949 }, 2950 "format":{ 2951 "shape":"String", 2952 "documentation":"<p>The format of the data set records.</p>" 2953 } 2954 }, 2955 "documentation":"<p>The supported properties for a PO type data set.</p>" 2956 }, 2957 "PortList":{ 2958 "type":"list", 2959 "member":{"shape":"Integer"}, 2960 "min":1 2961 }, 2962 "PrimaryKey":{ 2963 "type":"structure", 2964 "required":[ 2965 "length", 2966 "offset" 2967 ], 2968 "members":{ 2969 "length":{ 2970 "shape":"Integer", 2971 "documentation":"<p>A strictly positive integer value representing the length of the primary key. </p>" 2972 }, 2973 "name":{ 2974 "shape":"String", 2975 "documentation":"<p>A name for the Primary Key.</p>" 2976 }, 2977 "offset":{ 2978 "shape":"Integer", 2979 "documentation":"<p>A positive integer value representing the offset to mark the start of the primary key in the record byte array.</p>" 2980 } 2981 }, 2982 "documentation":"<p>The primary key for a KSDS data set.</p>" 2983 }, 2984 "PsAttributes":{ 2985 "type":"structure", 2986 "required":["format"], 2987 "members":{ 2988 "encoding":{ 2989 "shape":"String", 2990 "documentation":"<p>The character set encoding of the data set.</p>" 2991 }, 2992 "format":{ 2993 "shape":"String", 2994 "documentation":"<p>The format of the data set records.</p>" 2995 } 2996 }, 2997 "documentation":"<p>The supported properties for a PS type data set.</p>" 2998 }, 2999 "PsDetailAttributes":{ 3000 "type":"structure", 3001 "required":[ 3002 "encoding", 3003 "format" 3004 ], 3005 "members":{ 3006 "encoding":{ 3007 "shape":"String", 3008 "documentation":"<p>The character set encoding of the data set.</p>" 3009 }, 3010 "format":{ 3011 "shape":"String", 3012 "documentation":"<p>The format of the data set records.</p>" 3013 } 3014 }, 3015 "documentation":"<p>The supported properties for a PS type data set.</p>" 3016 }, 3017 "RecordLength":{ 3018 "type":"structure", 3019 "required":[ 3020 "max", 3021 "min" 3022 ], 3023 "members":{ 3024 "max":{ 3025 "shape":"Integer", 3026 "documentation":"<p>The maximum record length. In case of fixed, both minimum and maximum are the same.</p>" 3027 }, 3028 "min":{ 3029 "shape":"Integer", 3030 "documentation":"<p>The minimum record length of a record.</p>" 3031 } 3032 }, 3033 "documentation":"<p>The length of the records in the data set.</p>" 3034 }, 3035 "ResourceNotFoundException":{ 3036 "type":"structure", 3037 "required":["message"], 3038 "members":{ 3039 "message":{"shape":"String"}, 3040 "resourceId":{ 3041 "shape":"String", 3042 "documentation":"<p>The ID of the missing resource.</p>" 3043 }, 3044 "resourceType":{ 3045 "shape":"String", 3046 "documentation":"<p>The type of the missing resource.</p>" 3047 } 3048 }, 3049 "documentation":"<p>The specified resource was not found.</p>", 3050 "error":{ 3051 "httpStatusCode":404, 3052 "senderFault":true 3053 }, 3054 "exception":true 3055 }, 3056 "S3BatchJobIdentifier":{ 3057 "type":"structure", 3058 "required":[ 3059 "bucket", 3060 "identifier" 3061 ], 3062 "members":{ 3063 "bucket":{ 3064 "shape":"String", 3065 "documentation":"<p>The Amazon S3 bucket that contains the batch job definitions.</p>" 3066 }, 3067 "identifier":{ 3068 "shape":"JobIdentifier", 3069 "documentation":"<p>Identifies the batch job definition. This identifier can also point to any batch job definition that already exists in the application or to one of the batch job definitions within the directory that is specified in <code>keyPrefix</code>.</p>" 3070 }, 3071 "keyPrefix":{ 3072 "shape":"String", 3073 "documentation":"<p>The key prefix that specifies the path to the folder in the S3 bucket that has the batch job definitions.</p>" 3074 } 3075 }, 3076 "documentation":"<p>A batch job identifier in which the batch jobs to run are identified by an Amazon S3 location.</p>" 3077 }, 3078 "ScriptBatchJobDefinition":{ 3079 "type":"structure", 3080 "required":["scriptName"], 3081 "members":{ 3082 "scriptName":{ 3083 "shape":"String", 3084 "documentation":"<p>The name of the script containing the batch job definition.</p>" 3085 } 3086 }, 3087 "documentation":"<p>A batch job definition contained in a script.</p>" 3088 }, 3089 "ScriptBatchJobIdentifier":{ 3090 "type":"structure", 3091 "required":["scriptName"], 3092 "members":{ 3093 "scriptName":{ 3094 "shape":"String", 3095 "documentation":"<p>The name of the script containing the batch job definition.</p>" 3096 } 3097 }, 3098 "documentation":"<p>A batch job identifier in which the batch job to run is identified by the script name.</p>" 3099 }, 3100 "ServiceQuotaExceededException":{ 3101 "type":"structure", 3102 "required":["message"], 3103 "members":{ 3104 "message":{"shape":"String"}, 3105 "quotaCode":{ 3106 "shape":"String", 3107 "documentation":"<p>The identifier of the exceeded quota.</p>" 3108 }, 3109 "resourceId":{ 3110 "shape":"String", 3111 "documentation":"<p>The ID of the resource that is exceeding the quota limit.</p>" 3112 }, 3113 "resourceType":{ 3114 "shape":"String", 3115 "documentation":"<p>The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.</p>" 3116 }, 3117 "serviceCode":{ 3118 "shape":"String", 3119 "documentation":"<p>A code that identifies the service that the exceeded quota belongs to.</p>" 3120 } 3121 }, 3122 "documentation":"<p>One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.</p>", 3123 "error":{ 3124 "httpStatusCode":402, 3125 "senderFault":true 3126 }, 3127 "exception":true 3128 }, 3129 "ServiceUnavailableException":{ 3130 "type":"structure", 3131 "required":["message"], 3132 "members":{ 3133 "message":{"shape":"String"} 3134 }, 3135 "documentation":"<p>Server cannot process the request at the moment.</p>", 3136 "error":{"httpStatusCode":503}, 3137 "exception":true, 3138 "fault":true, 3139 "retryable":{"throttling":false} 3140 }, 3141 "StartApplicationRequest":{ 3142 "type":"structure", 3143 "required":["applicationId"], 3144 "members":{ 3145 "applicationId":{ 3146 "shape":"Identifier", 3147 "documentation":"<p>The unique identifier of the application you want to start.</p>", 3148 "location":"uri", 3149 "locationName":"applicationId" 3150 } 3151 } 3152 }, 3153 "StartApplicationResponse":{ 3154 "type":"structure", 3155 "members":{ 3156 } 3157 }, 3158 "StartBatchJobRequest":{ 3159 "type":"structure", 3160 "required":[ 3161 "applicationId", 3162 "batchJobIdentifier" 3163 ], 3164 "members":{ 3165 "applicationId":{ 3166 "shape":"Identifier", 3167 "documentation":"<p>The unique identifier of the application associated with this batch job.</p>", 3168 "location":"uri", 3169 "locationName":"applicationId" 3170 }, 3171 "batchJobIdentifier":{ 3172 "shape":"BatchJobIdentifier", 3173 "documentation":"<p>The unique identifier of the batch job.</p>" 3174 }, 3175 "jobParams":{ 3176 "shape":"BatchJobParametersMap", 3177 "documentation":"<p>The collection of batch job parameters. For details about limits for keys and values, see <a href=\"https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl\">Coding variables in JCL</a>.</p>" 3178 } 3179 } 3180 }, 3181 "StartBatchJobResponse":{ 3182 "type":"structure", 3183 "required":["executionId"], 3184 "members":{ 3185 "executionId":{ 3186 "shape":"Identifier", 3187 "documentation":"<p>The unique identifier of this execution of the batch job.</p>" 3188 } 3189 } 3190 }, 3191 "StopApplicationRequest":{ 3192 "type":"structure", 3193 "required":["applicationId"], 3194 "members":{ 3195 "applicationId":{ 3196 "shape":"Identifier", 3197 "documentation":"<p>The unique identifier of the application you want to stop.</p>", 3198 "location":"uri", 3199 "locationName":"applicationId" 3200 }, 3201 "forceStop":{ 3202 "shape":"Boolean", 3203 "documentation":"<p>Stopping an application process can take a long time. Setting this parameter to true lets you force stop the application so you don't need to wait until the process finishes to apply another action on the application. The default value is false.</p>" 3204 } 3205 } 3206 }, 3207 "StopApplicationResponse":{ 3208 "type":"structure", 3209 "members":{ 3210 } 3211 }, 3212 "StorageConfiguration":{ 3213 "type":"structure", 3214 "members":{ 3215 "efs":{ 3216 "shape":"EfsStorageConfiguration", 3217 "documentation":"<p>Defines the storage configuration for an Amazon EFS file system.</p>" 3218 }, 3219 "fsx":{ 3220 "shape":"FsxStorageConfiguration", 3221 "documentation":"<p>Defines the storage configuration for an Amazon FSx file system.</p>" 3222 } 3223 }, 3224 "documentation":"<p>Defines the storage configuration for a runtime environment.</p>", 3225 "union":true 3226 }, 3227 "StorageConfigurationList":{ 3228 "type":"list", 3229 "member":{"shape":"StorageConfiguration"} 3230 }, 3231 "String":{"type":"string"}, 3232 "String100":{ 3233 "type":"string", 3234 "pattern":"^\\S{1,100}$" 3235 }, 3236 "String20":{ 3237 "type":"string", 3238 "pattern":"^\\S{1,20}$" 3239 }, 3240 "String200":{ 3241 "type":"string", 3242 "pattern":"^\\S{1,200}$" 3243 }, 3244 "String2000":{ 3245 "type":"string", 3246 "pattern":"^\\S{1,2000}$" 3247 }, 3248 "String20List":{ 3249 "type":"list", 3250 "member":{"shape":"String20"}, 3251 "max":10, 3252 "min":1 3253 }, 3254 "String50":{ 3255 "type":"string", 3256 "pattern":"^\\S{1,50}$" 3257 }, 3258 "String50List":{ 3259 "type":"list", 3260 "member":{"shape":"String50"} 3261 }, 3262 "StringFree65000":{ 3263 "type":"string", 3264 "max":65000, 3265 "min":1 3266 }, 3267 "TagKey":{ 3268 "type":"string", 3269 "max":128, 3270 "min":1, 3271 "pattern":"^(?!aws:).+$" 3272 }, 3273 "TagKeyList":{ 3274 "type":"list", 3275 "member":{"shape":"TagKey"} 3276 }, 3277 "TagMap":{ 3278 "type":"map", 3279 "key":{"shape":"TagKey"}, 3280 "value":{"shape":"TagValue"}, 3281 "max":200, 3282 "min":0 3283 }, 3284 "TagResourceRequest":{ 3285 "type":"structure", 3286 "required":[ 3287 "resourceArn", 3288 "tags" 3289 ], 3290 "members":{ 3291 "resourceArn":{ 3292 "shape":"Arn", 3293 "documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>", 3294 "location":"uri", 3295 "locationName":"resourceArn" 3296 }, 3297 "tags":{ 3298 "shape":"TagMap", 3299 "documentation":"<p>The tags to add to the resource.</p>" 3300 } 3301 } 3302 }, 3303 "TagResourceResponse":{ 3304 "type":"structure", 3305 "members":{ 3306 } 3307 }, 3308 "TagValue":{ 3309 "type":"string", 3310 "max":256, 3311 "min":0 3312 }, 3313 "ThrottlingException":{ 3314 "type":"structure", 3315 "required":["message"], 3316 "members":{ 3317 "message":{"shape":"String"}, 3318 "quotaCode":{ 3319 "shape":"String", 3320 "documentation":"<p>The identifier of the throttled request.</p>" 3321 }, 3322 "retryAfterSeconds":{ 3323 "shape":"Integer", 3324 "documentation":"<p>The number of seconds to wait before retrying the request.</p>", 3325 "location":"header", 3326 "locationName":"Retry-After" 3327 }, 3328 "serviceCode":{ 3329 "shape":"String", 3330 "documentation":"<p>The identifier of the service that the throttled request was made to.</p>" 3331 } 3332 }, 3333 "documentation":"<p>The number of requests made exceeds the limit.</p>", 3334 "error":{ 3335 "httpStatusCode":429, 3336 "senderFault":true 3337 }, 3338 "exception":true, 3339 "retryable":{"throttling":true} 3340 }, 3341 "Timestamp":{"type":"timestamp"}, 3342 "UntagResourceRequest":{ 3343 "type":"structure", 3344 "required":[ 3345 "resourceArn", 3346 "tagKeys" 3347 ], 3348 "members":{ 3349 "resourceArn":{ 3350 "shape":"Arn", 3351 "documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>", 3352 "location":"uri", 3353 "locationName":"resourceArn" 3354 }, 3355 "tagKeys":{ 3356 "shape":"TagKeyList", 3357 "documentation":"<p>The keys of the tags to remove.</p>", 3358 "location":"querystring", 3359 "locationName":"tagKeys" 3360 } 3361 } 3362 }, 3363 "UntagResourceResponse":{ 3364 "type":"structure", 3365 "members":{ 3366 } 3367 }, 3368 "UpdateApplicationRequest":{ 3369 "type":"structure", 3370 "required":[ 3371 "applicationId", 3372 "currentApplicationVersion" 3373 ], 3374 "members":{ 3375 "applicationId":{ 3376 "shape":"Identifier", 3377 "documentation":"<p>The unique identifier of the application you want to update.</p>", 3378 "location":"uri", 3379 "locationName":"applicationId" 3380 }, 3381 "currentApplicationVersion":{ 3382 "shape":"Version", 3383 "documentation":"<p>The current version of the application to update.</p>" 3384 }, 3385 "definition":{ 3386 "shape":"Definition", 3387 "documentation":"<p>The application definition for this application. You can specify either inline JSON or an S3 bucket location.</p>" 3388 }, 3389 "description":{ 3390 "shape":"EntityDescription", 3391 "documentation":"<p>The description of the application to update.</p>" 3392 } 3393 } 3394 }, 3395 "UpdateApplicationResponse":{ 3396 "type":"structure", 3397 "required":["applicationVersion"], 3398 "members":{ 3399 "applicationVersion":{ 3400 "shape":"Version", 3401 "documentation":"<p>The new version of the application.</p>" 3402 } 3403 } 3404 }, 3405 "UpdateEnvironmentRequest":{ 3406 "type":"structure", 3407 "required":["environmentId"], 3408 "members":{ 3409 "applyDuringMaintenanceWindow":{ 3410 "shape":"Boolean", 3411 "documentation":"<p>Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the <code>engineVersion</code> parameter only if <code>applyDuringMaintenanceWindow</code> is true. If any parameter other than <code>engineVersion</code> is provided in <code>UpdateEnvironmentRequest</code>, it will fail if <code>applyDuringMaintenanceWindow</code> is set to true.</p>" 3412 }, 3413 "desiredCapacity":{ 3414 "shape":"CapacityValue", 3415 "documentation":"<p>The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.</p>" 3416 }, 3417 "engineVersion":{ 3418 "shape":"EngineVersion", 3419 "documentation":"<p>The version of the runtime engine for the runtime environment.</p>" 3420 }, 3421 "environmentId":{ 3422 "shape":"Identifier", 3423 "documentation":"<p>The unique identifier of the runtime environment that you want to update.</p>", 3424 "location":"uri", 3425 "locationName":"environmentId" 3426 }, 3427 "forceUpdate":{ 3428 "shape":"Boolean", 3429 "documentation":"<p>Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.</p> <p>If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.</p> <p>This option is not needed if the attribute being updated is <code>preferredMaintenanceWindow</code>.</p>" 3430 }, 3431 "instanceType":{ 3432 "shape":"String20", 3433 "documentation":"<p>The instance type for the runtime environment to update.</p>" 3434 }, 3435 "preferredMaintenanceWindow":{ 3436 "shape":"String", 3437 "documentation":"<p>Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format <code>ddd:hh24:mi-ddd:hh24:mi</code> and must be less than 24 hours. The following two examples are valid maintenance windows: <code>sun:23:45-mon:00:15</code> or <code>sat:01:00-sat:03:00</code>. </p> <p>If you do not provide a value, a random system-generated value will be assigned.</p>" 3438 } 3439 } 3440 }, 3441 "UpdateEnvironmentResponse":{ 3442 "type":"structure", 3443 "required":["environmentId"], 3444 "members":{ 3445 "environmentId":{ 3446 "shape":"Identifier", 3447 "documentation":"<p>The unique identifier of the runtime environment that was updated.</p>" 3448 } 3449 } 3450 }, 3451 "ValidationException":{ 3452 "type":"structure", 3453 "required":["message"], 3454 "members":{ 3455 "fieldList":{ 3456 "shape":"ValidationExceptionFieldList", 3457 "documentation":"<p>The list of fields that failed service validation.</p>" 3458 }, 3459 "message":{"shape":"String"}, 3460 "reason":{ 3461 "shape":"ValidationExceptionReason", 3462 "documentation":"<p>The reason why it failed service validation.</p>" 3463 } 3464 }, 3465 "documentation":"<p>One or more parameters provided in the request is not valid.</p>", 3466 "error":{ 3467 "httpStatusCode":400, 3468 "senderFault":true 3469 }, 3470 "exception":true 3471 }, 3472 "ValidationExceptionField":{ 3473 "type":"structure", 3474 "required":[ 3475 "message", 3476 "name" 3477 ], 3478 "members":{ 3479 "message":{ 3480 "shape":"String", 3481 "documentation":"<p>The message of the exception field.</p>" 3482 }, 3483 "name":{ 3484 "shape":"String", 3485 "documentation":"<p>The name of the exception field.</p>" 3486 } 3487 }, 3488 "documentation":"<p>Contains information about a validation exception field.</p>" 3489 }, 3490 "ValidationExceptionFieldList":{ 3491 "type":"list", 3492 "member":{"shape":"ValidationExceptionField"} 3493 }, 3494 "ValidationExceptionReason":{ 3495 "type":"string", 3496 "enum":[ 3497 "unknownOperation", 3498 "cannotParse", 3499 "fieldValidationFailed", 3500 "other" 3501 ] 3502 }, 3503 "Version":{ 3504 "type":"integer", 3505 "box":true, 3506 "min":1 3507 }, 3508 "VsamAttributes":{ 3509 "type":"structure", 3510 "required":["format"], 3511 "members":{ 3512 "alternateKeys":{ 3513 "shape":"AlternateKeyList", 3514 "documentation":"<p>The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.</p>" 3515 }, 3516 "compressed":{ 3517 "shape":"Boolean", 3518 "documentation":"<p>Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.</p>" 3519 }, 3520 "encoding":{ 3521 "shape":"String", 3522 "documentation":"<p>The character set used by the data set. Can be ASCII, EBCDIC, or unknown.</p>" 3523 }, 3524 "format":{ 3525 "shape":"String", 3526 "documentation":"<p>The record format of the data set.</p>" 3527 }, 3528 "primaryKey":{ 3529 "shape":"PrimaryKey", 3530 "documentation":"<p>The primary key of the data set.</p>" 3531 } 3532 }, 3533 "documentation":"<p>The attributes of a VSAM type data set.</p>" 3534 }, 3535 "VsamDetailAttributes":{ 3536 "type":"structure", 3537 "members":{ 3538 "alternateKeys":{ 3539 "shape":"AlternateKeyList", 3540 "documentation":"<p>The alternate key definitions, if any. A legacy dataset might not have any alternate key defined, but if those alternate keys definitions exist, provide them as some applications will make use of them.</p>" 3541 }, 3542 "cacheAtStartup":{ 3543 "shape":"Boolean", 3544 "documentation":"<p>If set to True, enforces loading the data set into cache before it’s used by the application.</p>", 3545 "box":true 3546 }, 3547 "compressed":{ 3548 "shape":"Boolean", 3549 "documentation":"<p>Indicates whether indexes for this dataset are stored as compressed values. If you have a large data set (typically > 100 Mb), consider setting this flag to True.</p>", 3550 "box":true 3551 }, 3552 "encoding":{ 3553 "shape":"String20", 3554 "documentation":"<p>The character set used by the data set. Can be ASCII, EBCDIC, or unknown.</p>" 3555 }, 3556 "primaryKey":{ 3557 "shape":"PrimaryKey", 3558 "documentation":"<p>The primary key of the data set.</p>" 3559 }, 3560 "recordFormat":{ 3561 "shape":"String20", 3562 "documentation":"<p>The record format of the data set.</p>" 3563 } 3564 }, 3565 "documentation":"<p>The attributes of a VSAM type data set.</p>" 3566 } 3567 }, 3568 "documentation":"<p>Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for analyzing existing mainframe applications, developing or updating mainframe applications using COBOL or PL/I, and implementing an automated pipeline for continuous integration and continuous delivery (CI/CD) of the applications.</p>" 3569} 3570