|
2 | 2 | "version":"2.0", |
3 | 3 | "metadata":{ |
4 | 4 | "apiVersion":"2018-05-10", |
| 5 | + "auth":["aws.auth#sigv4"], |
5 | 6 | "endpointPrefix":"artifact", |
6 | | - "jsonVersion":"1.1", |
7 | 7 | "protocol":"rest-json", |
| 8 | + "protocols":["rest-json"], |
8 | 9 | "serviceFullName":"AWS Artifact", |
9 | 10 | "serviceId":"Artifact", |
10 | 11 | "signatureVersion":"v4", |
|
345 | 346 | "ListReportsResponse":{ |
346 | 347 | "type":"structure", |
347 | 348 | "members":{ |
348 | | - "nextToken":{ |
349 | | - "shape":"NextTokenAttribute", |
350 | | - "documentation":"<p>Pagination token to request the next page of resources.</p>" |
351 | | - }, |
352 | 349 | "reports":{ |
353 | 350 | "shape":"ReportsList", |
354 | 351 | "documentation":"<p>List of report resources.</p>" |
| 352 | + }, |
| 353 | + "nextToken":{ |
| 354 | + "shape":"NextTokenAttribute", |
| 355 | + "documentation":"<p>Pagination token to request the next page of resources.</p>" |
355 | 356 | } |
356 | 357 | } |
357 | 358 | }, |
358 | 359 | "LongStringAttribute":{ |
359 | 360 | "type":"string", |
360 | 361 | "max":1024, |
361 | 362 | "min":1, |
362 | | - "pattern":"^[^<>]*$" |
| 363 | + "pattern":"[^<>]*" |
363 | 364 | }, |
364 | 365 | "MaxResultsAttribute":{ |
365 | 366 | "type":"integer", |
|
404 | 405 | "ReportDetail":{ |
405 | 406 | "type":"structure", |
406 | 407 | "members":{ |
407 | | - "acceptanceType":{ |
408 | | - "shape":"AcceptanceType", |
409 | | - "documentation":"<p>Acceptance type for report.</p>" |
410 | | - }, |
411 | | - "arn":{ |
412 | | - "shape":"LongStringAttribute", |
413 | | - "documentation":"<p>ARN for the report resource.</p>" |
414 | | - }, |
415 | | - "category":{ |
416 | | - "shape":"ShortStringAttribute", |
417 | | - "documentation":"<p>Category for the report resource.</p>" |
| 408 | + "id":{ |
| 409 | + "shape":"ReportId", |
| 410 | + "documentation":"<p>Unique resource ID for the report resource.</p>" |
418 | 411 | }, |
419 | | - "companyName":{ |
| 412 | + "name":{ |
420 | 413 | "shape":"ShortStringAttribute", |
421 | | - "documentation":"<p>Associated company name for the report resource.</p>" |
422 | | - }, |
423 | | - "createdAt":{ |
424 | | - "shape":"TimestampAttribute", |
425 | | - "documentation":"<p>Timestamp indicating when the report resource was created.</p>" |
426 | | - }, |
427 | | - "deletedAt":{ |
428 | | - "shape":"TimestampAttribute", |
429 | | - "documentation":"<p>Timestamp indicating when the report resource was deleted.</p>" |
| 414 | + "documentation":"<p>Name for the report resource.</p>" |
430 | 415 | }, |
431 | 416 | "description":{ |
432 | 417 | "shape":"LongStringAttribute", |
433 | 418 | "documentation":"<p>Description for the report resource.</p>" |
434 | 419 | }, |
435 | | - "id":{ |
436 | | - "shape":"ReportId", |
437 | | - "documentation":"<p>Unique resource ID for the report resource.</p>" |
438 | | - }, |
439 | | - "lastModifiedAt":{ |
| 420 | + "periodStart":{ |
440 | 421 | "shape":"TimestampAttribute", |
441 | | - "documentation":"<p>Timestamp indicating when the report resource was last modified.</p>" |
442 | | - }, |
443 | | - "name":{ |
444 | | - "shape":"ShortStringAttribute", |
445 | | - "documentation":"<p>Name for the report resource.</p>" |
| 422 | + "documentation":"<p>Timestamp indicating the report resource effective start.</p>" |
446 | 423 | }, |
447 | 424 | "periodEnd":{ |
448 | 425 | "shape":"TimestampAttribute", |
449 | 426 | "documentation":"<p>Timestamp indicating the report resource effective end.</p>" |
450 | 427 | }, |
451 | | - "periodStart":{ |
| 428 | + "createdAt":{ |
452 | 429 | "shape":"TimestampAttribute", |
453 | | - "documentation":"<p>Timestamp indicating the report resource effective start.</p>" |
| 430 | + "documentation":"<p>Timestamp indicating when the report resource was created.</p>" |
454 | 431 | }, |
455 | | - "productName":{ |
456 | | - "shape":"ShortStringAttribute", |
457 | | - "documentation":"<p>Associated product name for the report resource.</p>" |
| 432 | + "lastModifiedAt":{ |
| 433 | + "shape":"TimestampAttribute", |
| 434 | + "documentation":"<p>Timestamp indicating when the report resource was last modified.</p>" |
458 | 435 | }, |
459 | | - "sequenceNumber":{ |
460 | | - "shape":"SequenceNumberAttribute", |
461 | | - "documentation":"<p>Sequence number to enforce optimistic locking.</p>" |
| 436 | + "deletedAt":{ |
| 437 | + "shape":"TimestampAttribute", |
| 438 | + "documentation":"<p>Timestamp indicating when the report resource was deleted.</p>" |
| 439 | + }, |
| 440 | + "state":{ |
| 441 | + "shape":"PublishedState", |
| 442 | + "documentation":"<p>Current state of the report resource</p>" |
| 443 | + }, |
| 444 | + "arn":{ |
| 445 | + "shape":"LongStringAttribute", |
| 446 | + "documentation":"<p>ARN for the report resource.</p>" |
462 | 447 | }, |
463 | 448 | "series":{ |
464 | 449 | "shape":"ShortStringAttribute", |
465 | 450 | "documentation":"<p>Series for the report resource.</p>" |
466 | 451 | }, |
467 | | - "state":{ |
468 | | - "shape":"PublishedState", |
469 | | - "documentation":"<p>Current state of the report resource</p>" |
| 452 | + "category":{ |
| 453 | + "shape":"ShortStringAttribute", |
| 454 | + "documentation":"<p>Category for the report resource.</p>" |
470 | 455 | }, |
471 | | - "statusMessage":{ |
472 | | - "shape":"StatusMessage", |
473 | | - "documentation":"<p>The message associated with the current upload state.</p>" |
| 456 | + "companyName":{ |
| 457 | + "shape":"ShortStringAttribute", |
| 458 | + "documentation":"<p>Associated company name for the report resource.</p>" |
| 459 | + }, |
| 460 | + "productName":{ |
| 461 | + "shape":"ShortStringAttribute", |
| 462 | + "documentation":"<p>Associated product name for the report resource.</p>" |
474 | 463 | }, |
475 | 464 | "termArn":{ |
476 | 465 | "shape":"LongStringAttribute", |
477 | 466 | "documentation":"<p>Unique resource ARN for term resource.</p>" |
478 | 467 | }, |
| 468 | + "version":{ |
| 469 | + "shape":"VersionAttribute", |
| 470 | + "documentation":"<p>Version for the report resource.</p>" |
| 471 | + }, |
| 472 | + "acceptanceType":{ |
| 473 | + "shape":"AcceptanceType", |
| 474 | + "documentation":"<p>Acceptance type for report.</p>" |
| 475 | + }, |
| 476 | + "sequenceNumber":{ |
| 477 | + "shape":"SequenceNumberAttribute", |
| 478 | + "documentation":"<p>Sequence number to enforce optimistic locking.</p>" |
| 479 | + }, |
479 | 480 | "uploadState":{ |
480 | 481 | "shape":"UploadState", |
481 | 482 | "documentation":"<p>The current state of the document upload.</p>" |
482 | 483 | }, |
483 | | - "version":{ |
484 | | - "shape":"VersionAttribute", |
485 | | - "documentation":"<p>Version for the report resource.</p>" |
| 484 | + "statusMessage":{ |
| 485 | + "shape":"StatusMessage", |
| 486 | + "documentation":"<p>The message associated with the current upload state.</p>" |
486 | 487 | } |
487 | 488 | }, |
488 | 489 | "documentation":"<p>Full detail for report resource metadata.</p>" |
489 | 490 | }, |
490 | 491 | "ReportId":{ |
491 | 492 | "type":"string", |
492 | | - "pattern":"^report-[a-zA-Z0-9]{16}$" |
| 493 | + "pattern":"report-[a-zA-Z0-9]{16}" |
493 | 494 | }, |
494 | 495 | "ReportSummary":{ |
495 | 496 | "type":"structure", |
496 | 497 | "members":{ |
| 498 | + "id":{ |
| 499 | + "shape":"ReportId", |
| 500 | + "documentation":"<p>Unique resource ID for the report resource.</p>" |
| 501 | + }, |
| 502 | + "name":{ |
| 503 | + "shape":"ShortStringAttribute", |
| 504 | + "documentation":"<p>Name for the report resource.</p>" |
| 505 | + }, |
| 506 | + "state":{ |
| 507 | + "shape":"PublishedState", |
| 508 | + "documentation":"<p>Current state of the report resource.</p>" |
| 509 | + }, |
497 | 510 | "arn":{ |
498 | 511 | "shape":"LongStringAttribute", |
499 | 512 | "documentation":"<p>ARN for the report resource.</p>" |
500 | 513 | }, |
501 | | - "category":{ |
502 | | - "shape":"ShortStringAttribute", |
503 | | - "documentation":"<p>Category for the report resource.</p>" |
| 514 | + "version":{ |
| 515 | + "shape":"VersionAttribute", |
| 516 | + "documentation":"<p>Version for the report resource.</p>" |
504 | 517 | }, |
505 | | - "companyName":{ |
506 | | - "shape":"ShortStringAttribute", |
507 | | - "documentation":"<p>Associated company name for the report resource.</p>" |
| 518 | + "uploadState":{ |
| 519 | + "shape":"UploadState", |
| 520 | + "documentation":"<p>The current state of the document upload.</p>" |
508 | 521 | }, |
509 | 522 | "description":{ |
510 | 523 | "shape":"LongStringAttribute", |
511 | 524 | "documentation":"<p>Description for the report resource.</p>" |
512 | 525 | }, |
513 | | - "id":{ |
514 | | - "shape":"ReportId", |
515 | | - "documentation":"<p>Unique resource ID for the report resource.</p>" |
516 | | - }, |
517 | | - "name":{ |
518 | | - "shape":"ShortStringAttribute", |
519 | | - "documentation":"<p>Name for the report resource.</p>" |
| 526 | + "periodStart":{ |
| 527 | + "shape":"TimestampAttribute", |
| 528 | + "documentation":"<p>Timestamp indicating the report resource effective start.</p>" |
520 | 529 | }, |
521 | 530 | "periodEnd":{ |
522 | 531 | "shape":"TimestampAttribute", |
523 | 532 | "documentation":"<p>Timestamp indicating the report resource effective end.</p>" |
524 | 533 | }, |
525 | | - "periodStart":{ |
526 | | - "shape":"TimestampAttribute", |
527 | | - "documentation":"<p>Timestamp indicating the report resource effective start.</p>" |
| 534 | + "series":{ |
| 535 | + "shape":"ShortStringAttribute", |
| 536 | + "documentation":"<p>Series for the report resource.</p>" |
528 | 537 | }, |
529 | | - "productName":{ |
| 538 | + "category":{ |
530 | 539 | "shape":"ShortStringAttribute", |
531 | | - "documentation":"<p>Associated product name for the report resource.</p>" |
| 540 | + "documentation":"<p>Category for the report resource.</p>" |
532 | 541 | }, |
533 | | - "series":{ |
| 542 | + "companyName":{ |
534 | 543 | "shape":"ShortStringAttribute", |
535 | | - "documentation":"<p>Series for the report resource.</p>" |
| 544 | + "documentation":"<p>Associated company name for the report resource.</p>" |
536 | 545 | }, |
537 | | - "state":{ |
538 | | - "shape":"PublishedState", |
539 | | - "documentation":"<p>Current state of the report resource.</p>" |
| 546 | + "productName":{ |
| 547 | + "shape":"ShortStringAttribute", |
| 548 | + "documentation":"<p>Associated product name for the report resource.</p>" |
540 | 549 | }, |
541 | 550 | "statusMessage":{ |
542 | 551 | "shape":"StatusMessage", |
543 | 552 | "documentation":"<p>The message associated with the current upload state.</p>" |
544 | 553 | }, |
545 | | - "uploadState":{ |
546 | | - "shape":"UploadState", |
547 | | - "documentation":"<p>The current state of the document upload.</p>" |
548 | | - }, |
549 | | - "version":{ |
550 | | - "shape":"VersionAttribute", |
551 | | - "documentation":"<p>Version for the report resource.</p>" |
| 554 | + "acceptanceType":{ |
| 555 | + "shape":"AcceptanceType", |
| 556 | + "documentation":"<p>Acceptance type for report.</p>" |
552 | 557 | } |
553 | 558 | }, |
554 | 559 | "documentation":"<p>Summary for report resource.</p>" |
|
591 | 596 | "type":"structure", |
592 | 597 | "required":[ |
593 | 598 | "message", |
594 | | - "quotaCode", |
595 | 599 | "resourceId", |
596 | 600 | "resourceType", |
597 | | - "serviceCode" |
| 601 | + "serviceCode", |
| 602 | + "quotaCode" |
598 | 603 | ], |
599 | 604 | "members":{ |
600 | 605 | "message":{"shape":"String"}, |
601 | | - "quotaCode":{ |
602 | | - "shape":"String", |
603 | | - "documentation":"<p>Code for the affected quota.</p>" |
604 | | - }, |
605 | 606 | "resourceId":{ |
606 | 607 | "shape":"String", |
607 | 608 | "documentation":"<p>Identifier of the affected resource.</p>" |
|
613 | 614 | "serviceCode":{ |
614 | 615 | "shape":"String", |
615 | 616 | "documentation":"<p>Code for the affected service.</p>" |
| 617 | + }, |
| 618 | + "quotaCode":{ |
| 619 | + "shape":"String", |
| 620 | + "documentation":"<p>Code for the affected quota.</p>" |
616 | 621 | } |
617 | 622 | }, |
618 | 623 | "documentation":"<p>Request would cause a service quota to be exceeded.</p>", |
|
626 | 631 | "type":"string", |
627 | 632 | "max":256, |
628 | 633 | "min":1, |
629 | | - "pattern":"^[a-zA-Z0-9_\\-\\s]*$" |
| 634 | + "pattern":"[a-zA-Z0-9_\\-\\s]*" |
630 | 635 | }, |
631 | 636 | "StatusMessage":{"type":"string"}, |
632 | 637 | "String":{"type":"string"}, |
|
635 | 640 | "required":["message"], |
636 | 641 | "members":{ |
637 | 642 | "message":{"shape":"String"}, |
| 643 | + "serviceCode":{ |
| 644 | + "shape":"String", |
| 645 | + "documentation":"<p>Code for the affected service.</p>" |
| 646 | + }, |
638 | 647 | "quotaCode":{ |
639 | 648 | "shape":"String", |
640 | 649 | "documentation":"<p>Code for the affected quota.</p>" |
|
644 | 653 | "documentation":"<p>Number of seconds in which the caller can retry the request.</p>", |
645 | 654 | "location":"header", |
646 | 655 | "locationName":"Retry-After" |
647 | | - }, |
648 | | - "serviceCode":{ |
649 | | - "shape":"String", |
650 | | - "documentation":"<p>Code for the affected service.</p>" |
651 | 656 | } |
652 | 657 | }, |
653 | 658 | "documentation":"<p>Request was denied due to request throttling.</p>", |
|
678 | 683 | "reason" |
679 | 684 | ], |
680 | 685 | "members":{ |
681 | | - "fieldList":{ |
682 | | - "shape":"ValidationExceptionFieldList", |
683 | | - "documentation":"<p>The field that caused the error, if applicable.</p>" |
684 | | - }, |
685 | 686 | "message":{"shape":"String"}, |
686 | 687 | "reason":{ |
687 | 688 | "shape":"ValidationExceptionReason", |
688 | 689 | "documentation":"<p>Reason the request failed validation.</p>" |
| 690 | + }, |
| 691 | + "fieldList":{ |
| 692 | + "shape":"ValidationExceptionFieldList", |
| 693 | + "documentation":"<p>The field that caused the error, if applicable.</p>" |
689 | 694 | } |
690 | 695 | }, |
691 | 696 | "documentation":"<p>Request fails to satisfy the constraints specified by an AWS service.</p>", |
|
698 | 703 | "ValidationExceptionField":{ |
699 | 704 | "type":"structure", |
700 | 705 | "required":[ |
701 | | - "message", |
702 | | - "name" |
| 706 | + "name", |
| 707 | + "message" |
703 | 708 | ], |
704 | 709 | "members":{ |
705 | | - "message":{ |
706 | | - "shape":"String", |
707 | | - "documentation":"<p>Message describing why the field failed validation.</p>" |
708 | | - }, |
709 | 710 | "name":{ |
710 | 711 | "shape":"String", |
711 | 712 | "documentation":"<p>Name of validation exception.</p>" |
| 713 | + }, |
| 714 | + "message":{ |
| 715 | + "shape":"String", |
| 716 | + "documentation":"<p>Message describing why the field failed validation.</p>" |
712 | 717 | } |
713 | 718 | }, |
714 | 719 | "documentation":"<p>Validation exception message and name.</p>" |
|
0 commit comments