1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2017-08-25", 5 "endpointPrefix":"signer", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceAbbreviation":"signer", 9 "serviceFullName":"AWS Signer", 10 "serviceId":"signer", 11 "signatureVersion":"v4", 12 "signingName":"signer", 13 "uid":"signer-2017-08-25" 14 }, 15 "operations":{ 16 "CancelSigningProfile":{ 17 "name":"CancelSigningProfile", 18 "http":{ 19 "method":"DELETE", 20 "requestUri":"/signing-profiles/{profileName}" 21 }, 22 "input":{"shape":"CancelSigningProfileRequest"}, 23 "errors":[ 24 {"shape":"ResourceNotFoundException"}, 25 {"shape":"AccessDeniedException"}, 26 {"shape":"ThrottlingException"}, 27 {"shape":"InternalServiceErrorException"} 28 ] 29 }, 30 "DescribeSigningJob":{ 31 "name":"DescribeSigningJob", 32 "http":{ 33 "method":"GET", 34 "requestUri":"/signing-jobs/{jobId}" 35 }, 36 "input":{"shape":"DescribeSigningJobRequest"}, 37 "output":{"shape":"DescribeSigningJobResponse"}, 38 "errors":[ 39 {"shape":"ResourceNotFoundException"}, 40 {"shape":"AccessDeniedException"}, 41 {"shape":"InternalServiceErrorException"} 42 ] 43 }, 44 "GetSigningPlatform":{ 45 "name":"GetSigningPlatform", 46 "http":{ 47 "method":"GET", 48 "requestUri":"/signing-platforms/{platformId}" 49 }, 50 "input":{"shape":"GetSigningPlatformRequest"}, 51 "output":{"shape":"GetSigningPlatformResponse"}, 52 "errors":[ 53 {"shape":"ResourceNotFoundException"}, 54 {"shape":"AccessDeniedException"}, 55 {"shape":"InternalServiceErrorException"} 56 ] 57 }, 58 "GetSigningProfile":{ 59 "name":"GetSigningProfile", 60 "http":{ 61 "method":"GET", 62 "requestUri":"/signing-profiles/{profileName}" 63 }, 64 "input":{"shape":"GetSigningProfileRequest"}, 65 "output":{"shape":"GetSigningProfileResponse"}, 66 "errors":[ 67 {"shape":"ResourceNotFoundException"}, 68 {"shape":"AccessDeniedException"}, 69 {"shape":"ThrottlingException"}, 70 {"shape":"InternalServiceErrorException"} 71 ] 72 }, 73 "ListSigningJobs":{ 74 "name":"ListSigningJobs", 75 "http":{ 76 "method":"GET", 77 "requestUri":"/signing-jobs" 78 }, 79 "input":{"shape":"ListSigningJobsRequest"}, 80 "output":{"shape":"ListSigningJobsResponse"}, 81 "errors":[ 82 {"shape":"ValidationException"}, 83 {"shape":"AccessDeniedException"}, 84 {"shape":"ThrottlingException"}, 85 {"shape":"InternalServiceErrorException"} 86 ] 87 }, 88 "ListSigningPlatforms":{ 89 "name":"ListSigningPlatforms", 90 "http":{ 91 "method":"GET", 92 "requestUri":"/signing-platforms" 93 }, 94 "input":{"shape":"ListSigningPlatformsRequest"}, 95 "output":{"shape":"ListSigningPlatformsResponse"}, 96 "errors":[ 97 {"shape":"ValidationException"}, 98 {"shape":"AccessDeniedException"}, 99 {"shape":"ThrottlingException"}, 100 {"shape":"InternalServiceErrorException"} 101 ] 102 }, 103 "ListSigningProfiles":{ 104 "name":"ListSigningProfiles", 105 "http":{ 106 "method":"GET", 107 "requestUri":"/signing-profiles" 108 }, 109 "input":{"shape":"ListSigningProfilesRequest"}, 110 "output":{"shape":"ListSigningProfilesResponse"}, 111 "errors":[ 112 {"shape":"AccessDeniedException"}, 113 {"shape":"ThrottlingException"}, 114 {"shape":"InternalServiceErrorException"} 115 ] 116 }, 117 "PutSigningProfile":{ 118 "name":"PutSigningProfile", 119 "http":{ 120 "method":"PUT", 121 "requestUri":"/signing-profiles/{profileName}" 122 }, 123 "input":{"shape":"PutSigningProfileRequest"}, 124 "output":{"shape":"PutSigningProfileResponse"}, 125 "errors":[ 126 {"shape":"ResourceNotFoundException"}, 127 {"shape":"AccessDeniedException"}, 128 {"shape":"ValidationException"}, 129 {"shape":"ThrottlingException"}, 130 {"shape":"InternalServiceErrorException"} 131 ] 132 }, 133 "StartSigningJob":{ 134 "name":"StartSigningJob", 135 "http":{ 136 "method":"POST", 137 "requestUri":"/signing-jobs" 138 }, 139 "input":{"shape":"StartSigningJobRequest"}, 140 "output":{"shape":"StartSigningJobResponse"}, 141 "errors":[ 142 {"shape":"ValidationException"}, 143 {"shape":"ResourceNotFoundException"}, 144 {"shape":"AccessDeniedException"}, 145 {"shape":"ThrottlingException"}, 146 {"shape":"InternalServiceErrorException"} 147 ] 148 } 149 }, 150 "shapes":{ 151 "key":{"type":"string"}, 152 "AccessDeniedException":{ 153 "type":"structure", 154 "members":{ 155 "message":{"shape":"ErrorMessage"} 156 }, 157 "error":{"httpStatusCode":403}, 158 "exception":true 159 }, 160 "BucketName":{"type":"string"}, 161 "CancelSigningProfileRequest":{ 162 "type":"structure", 163 "required":["profileName"], 164 "members":{ 165 "profileName":{ 166 "shape":"ProfileName", 167 "location":"uri", 168 "locationName":"profileName" 169 } 170 } 171 }, 172 "Category":{ 173 "type":"string", 174 "enum":["AWSIoT"] 175 }, 176 "CertificateArn":{"type":"string"}, 177 "ClientRequestToken":{"type":"string"}, 178 "CompletedAt":{"type":"timestamp"}, 179 "CreatedAt":{"type":"timestamp"}, 180 "DescribeSigningJobRequest":{ 181 "type":"structure", 182 "required":["jobId"], 183 "members":{ 184 "jobId":{ 185 "shape":"JobId", 186 "location":"uri", 187 "locationName":"jobId" 188 } 189 } 190 }, 191 "DescribeSigningJobResponse":{ 192 "type":"structure", 193 "members":{ 194 "jobId":{"shape":"JobId"}, 195 "source":{"shape":"Source"}, 196 "signingMaterial":{"shape":"SigningMaterial"}, 197 "platformId":{"shape":"PlatformId"}, 198 "profileName":{"shape":"ProfileName"}, 199 "overrides":{"shape":"SigningPlatformOverrides"}, 200 "signingParameters":{"shape":"SigningParameters"}, 201 "createdAt":{"shape":"CreatedAt"}, 202 "completedAt":{"shape":"CompletedAt"}, 203 "requestedBy":{"shape":"RequestedBy"}, 204 "status":{"shape":"SigningStatus"}, 205 "statusReason":{"shape":"StatusReason"}, 206 "signedObject":{"shape":"SignedObject"} 207 } 208 }, 209 "Destination":{ 210 "type":"structure", 211 "members":{ 212 "s3":{"shape":"S3Destination"} 213 } 214 }, 215 "DisplayName":{"type":"string"}, 216 "EncryptionAlgorithm":{ 217 "type":"string", 218 "enum":[ 219 "RSA", 220 "ECDSA" 221 ] 222 }, 223 "EncryptionAlgorithmOptions":{ 224 "type":"structure", 225 "required":[ 226 "allowedValues", 227 "defaultValue" 228 ], 229 "members":{ 230 "allowedValues":{"shape":"EncryptionAlgorithms"}, 231 "defaultValue":{"shape":"EncryptionAlgorithm"} 232 } 233 }, 234 "EncryptionAlgorithms":{ 235 "type":"list", 236 "member":{"shape":"EncryptionAlgorithm"} 237 }, 238 "ErrorMessage":{"type":"string"}, 239 "GetSigningPlatformRequest":{ 240 "type":"structure", 241 "required":["platformId"], 242 "members":{ 243 "platformId":{ 244 "shape":"PlatformId", 245 "location":"uri", 246 "locationName":"platformId" 247 } 248 } 249 }, 250 "GetSigningPlatformResponse":{ 251 "type":"structure", 252 "members":{ 253 "platformId":{"shape":"PlatformId"}, 254 "displayName":{"shape":"DisplayName"}, 255 "partner":{"shape":"String"}, 256 "target":{"shape":"String"}, 257 "category":{"shape":"Category"}, 258 "signingConfiguration":{"shape":"SigningConfiguration"}, 259 "signingImageFormat":{"shape":"SigningImageFormat"}, 260 "maxSizeInMB":{"shape":"MaxSizeInMB"} 261 } 262 }, 263 "GetSigningProfileRequest":{ 264 "type":"structure", 265 "required":["profileName"], 266 "members":{ 267 "profileName":{ 268 "shape":"ProfileName", 269 "location":"uri", 270 "locationName":"profileName" 271 } 272 } 273 }, 274 "GetSigningProfileResponse":{ 275 "type":"structure", 276 "members":{ 277 "profileName":{"shape":"ProfileName"}, 278 "signingMaterial":{"shape":"SigningMaterial"}, 279 "platformId":{"shape":"PlatformId"}, 280 "overrides":{"shape":"SigningPlatformOverrides"}, 281 "signingParameters":{"shape":"SigningParameters"}, 282 "status":{"shape":"SigningProfileStatus"} 283 } 284 }, 285 "HashAlgorithm":{ 286 "type":"string", 287 "enum":[ 288 "SHA1", 289 "SHA256" 290 ] 291 }, 292 "HashAlgorithmOptions":{ 293 "type":"structure", 294 "required":[ 295 "allowedValues", 296 "defaultValue" 297 ], 298 "members":{ 299 "allowedValues":{"shape":"HashAlgorithms"}, 300 "defaultValue":{"shape":"HashAlgorithm"} 301 } 302 }, 303 "HashAlgorithms":{ 304 "type":"list", 305 "member":{"shape":"HashAlgorithm"} 306 }, 307 "ImageFormat":{ 308 "type":"string", 309 "enum":["JSON"] 310 }, 311 "ImageFormats":{ 312 "type":"list", 313 "member":{"shape":"ImageFormat"} 314 }, 315 "InternalServiceErrorException":{ 316 "type":"structure", 317 "members":{ 318 "message":{"shape":"ErrorMessage"} 319 }, 320 "error":{"httpStatusCode":500}, 321 "exception":true 322 }, 323 "JobId":{"type":"string"}, 324 "Key":{"type":"string"}, 325 "ListSigningJobsRequest":{ 326 "type":"structure", 327 "members":{ 328 "status":{ 329 "shape":"SigningStatus", 330 "location":"querystring", 331 "locationName":"status" 332 }, 333 "platformId":{ 334 "shape":"PlatformId", 335 "location":"querystring", 336 "locationName":"platformId" 337 }, 338 "requestedBy":{ 339 "shape":"RequestedBy", 340 "location":"querystring", 341 "locationName":"requestedBy" 342 }, 343 "maxResults":{ 344 "shape":"MaxResults", 345 "location":"querystring", 346 "locationName":"maxResults" 347 }, 348 "nextToken":{ 349 "shape":"NextToken", 350 "location":"querystring", 351 "locationName":"nextToken" 352 } 353 } 354 }, 355 "ListSigningJobsResponse":{ 356 "type":"structure", 357 "members":{ 358 "jobs":{"shape":"SigningJobs"}, 359 "nextToken":{"shape":"NextToken"} 360 } 361 }, 362 "ListSigningPlatformsRequest":{ 363 "type":"structure", 364 "members":{ 365 "category":{ 366 "shape":"String", 367 "location":"querystring", 368 "locationName":"category" 369 }, 370 "partner":{ 371 "shape":"String", 372 "location":"querystring", 373 "locationName":"partner" 374 }, 375 "target":{ 376 "shape":"String", 377 "location":"querystring", 378 "locationName":"target" 379 }, 380 "maxResults":{ 381 "shape":"MaxResults", 382 "location":"querystring", 383 "locationName":"maxResults" 384 }, 385 "nextToken":{ 386 "shape":"String", 387 "location":"querystring", 388 "locationName":"nextToken" 389 } 390 } 391 }, 392 "ListSigningPlatformsResponse":{ 393 "type":"structure", 394 "members":{ 395 "platforms":{"shape":"SigningPlatforms"}, 396 "nextToken":{"shape":"String"} 397 } 398 }, 399 "ListSigningProfilesRequest":{ 400 "type":"structure", 401 "members":{ 402 "includeCanceled":{ 403 "shape":"bool", 404 "location":"querystring", 405 "locationName":"includeCanceled" 406 }, 407 "maxResults":{ 408 "shape":"MaxResults", 409 "location":"querystring", 410 "locationName":"maxResults" 411 }, 412 "nextToken":{ 413 "shape":"NextToken", 414 "location":"querystring", 415 "locationName":"nextToken" 416 } 417 } 418 }, 419 "ListSigningProfilesResponse":{ 420 "type":"structure", 421 "members":{ 422 "profiles":{"shape":"SigningProfiles"}, 423 "nextToken":{"shape":"NextToken"} 424 } 425 }, 426 "MaxResults":{ 427 "type":"integer", 428 "box":true, 429 "max":25, 430 "min":1 431 }, 432 "MaxSizeInMB":{"type":"integer"}, 433 "NextToken":{"type":"string"}, 434 "PlatformId":{"type":"string"}, 435 "Prefix":{"type":"string"}, 436 "ProfileName":{ 437 "type":"string", 438 "max":20, 439 "min":2, 440 "pattern":"^[a-zA-Z0-9_]{2,}" 441 }, 442 "PutSigningProfileRequest":{ 443 "type":"structure", 444 "required":[ 445 "profileName", 446 "signingMaterial", 447 "platformId" 448 ], 449 "members":{ 450 "profileName":{ 451 "shape":"ProfileName", 452 "location":"uri", 453 "locationName":"profileName" 454 }, 455 "signingMaterial":{"shape":"SigningMaterial"}, 456 "platformId":{"shape":"PlatformId"}, 457 "overrides":{"shape":"SigningPlatformOverrides"}, 458 "signingParameters":{"shape":"SigningParameters"} 459 } 460 }, 461 "PutSigningProfileResponse":{ 462 "type":"structure", 463 "members":{ 464 "arn":{"shape":"string"} 465 } 466 }, 467 "RequestedBy":{"type":"string"}, 468 "ResourceNotFoundException":{ 469 "type":"structure", 470 "members":{ 471 "message":{"shape":"ErrorMessage"} 472 }, 473 "error":{"httpStatusCode":404}, 474 "exception":true 475 }, 476 "S3Destination":{ 477 "type":"structure", 478 "members":{ 479 "bucketName":{"shape":"BucketName"}, 480 "prefix":{"shape":"Prefix"} 481 } 482 }, 483 "S3SignedObject":{ 484 "type":"structure", 485 "members":{ 486 "bucketName":{"shape":"BucketName"}, 487 "key":{"shape":"key"} 488 } 489 }, 490 "S3Source":{ 491 "type":"structure", 492 "required":[ 493 "bucketName", 494 "key", 495 "version" 496 ], 497 "members":{ 498 "bucketName":{"shape":"BucketName"}, 499 "key":{"shape":"Key"}, 500 "version":{"shape":"Version"} 501 } 502 }, 503 "SignedObject":{ 504 "type":"structure", 505 "members":{ 506 "s3":{"shape":"S3SignedObject"} 507 } 508 }, 509 "SigningConfiguration":{ 510 "type":"structure", 511 "required":[ 512 "encryptionAlgorithmOptions", 513 "hashAlgorithmOptions" 514 ], 515 "members":{ 516 "encryptionAlgorithmOptions":{"shape":"EncryptionAlgorithmOptions"}, 517 "hashAlgorithmOptions":{"shape":"HashAlgorithmOptions"} 518 } 519 }, 520 "SigningConfigurationOverrides":{ 521 "type":"structure", 522 "members":{ 523 "encryptionAlgorithm":{"shape":"EncryptionAlgorithm"}, 524 "hashAlgorithm":{"shape":"HashAlgorithm"} 525 } 526 }, 527 "SigningImageFormat":{ 528 "type":"structure", 529 "required":[ 530 "supportedFormats", 531 "defaultFormat" 532 ], 533 "members":{ 534 "supportedFormats":{"shape":"ImageFormats"}, 535 "defaultFormat":{"shape":"ImageFormat"} 536 } 537 }, 538 "SigningJob":{ 539 "type":"structure", 540 "members":{ 541 "jobId":{"shape":"JobId"}, 542 "source":{"shape":"Source"}, 543 "signedObject":{"shape":"SignedObject"}, 544 "signingMaterial":{"shape":"SigningMaterial"}, 545 "createdAt":{"shape":"CreatedAt"}, 546 "status":{"shape":"SigningStatus"} 547 } 548 }, 549 "SigningJobs":{ 550 "type":"list", 551 "member":{"shape":"SigningJob"} 552 }, 553 "SigningMaterial":{ 554 "type":"structure", 555 "required":["certificateArn"], 556 "members":{ 557 "certificateArn":{"shape":"CertificateArn"} 558 } 559 }, 560 "SigningParameterKey":{"type":"string"}, 561 "SigningParameterValue":{"type":"string"}, 562 "SigningParameters":{ 563 "type":"map", 564 "key":{"shape":"SigningParameterKey"}, 565 "value":{"shape":"SigningParameterValue"} 566 }, 567 "SigningPlatform":{ 568 "type":"structure", 569 "members":{ 570 "platformId":{"shape":"String"}, 571 "displayName":{"shape":"String"}, 572 "partner":{"shape":"String"}, 573 "target":{"shape":"String"}, 574 "category":{"shape":"Category"}, 575 "signingConfiguration":{"shape":"SigningConfiguration"}, 576 "signingImageFormat":{"shape":"SigningImageFormat"}, 577 "maxSizeInMB":{"shape":"MaxSizeInMB"} 578 } 579 }, 580 "SigningPlatformOverrides":{ 581 "type":"structure", 582 "members":{ 583 "signingConfiguration":{"shape":"SigningConfigurationOverrides"} 584 } 585 }, 586 "SigningPlatforms":{ 587 "type":"list", 588 "member":{"shape":"SigningPlatform"} 589 }, 590 "SigningProfile":{ 591 "type":"structure", 592 "members":{ 593 "profileName":{"shape":"ProfileName"}, 594 "signingMaterial":{"shape":"SigningMaterial"}, 595 "platformId":{"shape":"PlatformId"}, 596 "signingParameters":{"shape":"SigningParameters"}, 597 "status":{"shape":"SigningProfileStatus"} 598 } 599 }, 600 "SigningProfileStatus":{ 601 "type":"string", 602 "enum":[ 603 "Active", 604 "Canceled" 605 ] 606 }, 607 "SigningProfiles":{ 608 "type":"list", 609 "member":{"shape":"SigningProfile"} 610 }, 611 "SigningStatus":{ 612 "type":"string", 613 "enum":[ 614 "InProgress", 615 "Failed", 616 "Succeeded" 617 ] 618 }, 619 "Source":{ 620 "type":"structure", 621 "members":{ 622 "s3":{"shape":"S3Source"} 623 } 624 }, 625 "StartSigningJobRequest":{ 626 "type":"structure", 627 "required":[ 628 "source", 629 "destination", 630 "clientRequestToken" 631 ], 632 "members":{ 633 "source":{"shape":"Source"}, 634 "destination":{"shape":"Destination"}, 635 "profileName":{"shape":"ProfileName"}, 636 "clientRequestToken":{ 637 "shape":"ClientRequestToken", 638 "idempotencyToken":true 639 } 640 } 641 }, 642 "StartSigningJobResponse":{ 643 "type":"structure", 644 "members":{ 645 "jobId":{"shape":"JobId"} 646 } 647 }, 648 "StatusReason":{"type":"string"}, 649 "String":{"type":"string"}, 650 "ThrottlingException":{ 651 "type":"structure", 652 "members":{ 653 "message":{"shape":"ErrorMessage"} 654 }, 655 "error":{"httpStatusCode":429}, 656 "exception":true 657 }, 658 "ValidationException":{ 659 "type":"structure", 660 "members":{ 661 "message":{"shape":"ErrorMessage"} 662 }, 663 "error":{"httpStatusCode":400}, 664 "exception":true 665 }, 666 "Version":{"type":"string"}, 667 "bool":{"type":"boolean"}, 668 "string":{"type":"string"} 669 } 670} 671