|
2 | 2 | "version":"2.0",
|
3 | 3 | "metadata":{
|
4 | 4 | "apiVersion":"2024-04-15",
|
| 5 | + "auth":["aws.auth#sigv4"], |
5 | 6 | "endpointPrefix":"application-signals",
|
6 | 7 | "protocol":"rest-json",
|
7 | 8 | "protocols":["rest-json"],
|
|
486 | 487 | "members":{
|
487 | 488 | "StartTime":{
|
488 | 489 | "shape":"Timestamp",
|
489 |
| - "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 490 | + "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>", |
490 | 491 | "location":"querystring",
|
491 | 492 | "locationName":"StartTime"
|
492 | 493 | },
|
493 | 494 | "EndTime":{
|
494 | 495 | "shape":"Timestamp",
|
495 |
| - "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 496 | + "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>", |
496 | 497 | "location":"querystring",
|
497 | 498 | "locationName":"EndTime"
|
498 | 499 | },
|
|
538 | 539 | },
|
539 | 540 | "StartTime":{
|
540 | 541 | "shape":"Timestamp",
|
541 |
| - "documentation":"<p>The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code>.</p>" |
| 542 | + "documentation":"<p>The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code>.</p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
542 | 543 | },
|
543 | 544 | "EndTime":{
|
544 | 545 | "shape":"Timestamp",
|
545 |
| - "documentation":"<p>The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code>.</p>" |
| 546 | + "documentation":"<p>The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code>.</p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
| 547 | + }, |
| 548 | + "LogGroupReferences":{ |
| 549 | + "shape":"LogGroupReferences", |
| 550 | + "documentation":"<p>An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:</p> <ul> <li> <p> <code>\"Type\": \"AWS::Resource\"</code> </p> </li> <li> <p> <code>\"ResourceType\": \"AWS::Logs::LogGroup\"</code> </p> </li> <li> <p> <code>\"Identifier\": \"<i>name-of-log-group</i>\"</code> </p> </li> </ul>" |
546 | 551 | }
|
547 | 552 | }
|
548 | 553 | },
|
|
599 | 604 | "members":{
|
600 | 605 | "StartTime":{
|
601 | 606 | "shape":"Timestamp",
|
602 |
| - "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 607 | + "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>", |
603 | 608 | "location":"querystring",
|
604 | 609 | "locationName":"StartTime"
|
605 | 610 | },
|
606 | 611 | "EndTime":{
|
607 | 612 | "shape":"Timestamp",
|
608 |
| - "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 613 | + "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested end time will be rounded to the nearest hour.</p>", |
609 | 614 | "location":"querystring",
|
610 | 615 | "locationName":"EndTime"
|
611 | 616 | },
|
|
643 | 648 | "members":{
|
644 | 649 | "StartTime":{
|
645 | 650 | "shape":"Timestamp",
|
646 |
| - "documentation":"<p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>" |
| 651 | + "documentation":"<p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
647 | 652 | },
|
648 | 653 | "EndTime":{
|
649 | 654 | "shape":"Timestamp",
|
650 |
| - "documentation":"<p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>" |
| 655 | + "documentation":"<p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
651 | 656 | },
|
652 | 657 | "ServiceDependencies":{
|
653 | 658 | "shape":"ServiceDependencies",
|
|
669 | 674 | "members":{
|
670 | 675 | "StartTime":{
|
671 | 676 | "shape":"Timestamp",
|
672 |
| - "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 677 | + "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>", |
673 | 678 | "location":"querystring",
|
674 | 679 | "locationName":"StartTime"
|
675 | 680 | },
|
676 | 681 | "EndTime":{
|
677 | 682 | "shape":"Timestamp",
|
678 |
| - "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 683 | + "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>", |
679 | 684 | "location":"querystring",
|
680 | 685 | "locationName":"EndTime"
|
681 | 686 | },
|
|
713 | 718 | "members":{
|
714 | 719 | "StartTime":{
|
715 | 720 | "shape":"Timestamp",
|
716 |
| - "documentation":"<p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>" |
| 721 | + "documentation":"<p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
717 | 722 | },
|
718 | 723 | "EndTime":{
|
719 | 724 | "shape":"Timestamp",
|
720 |
| - "documentation":"<p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>" |
| 725 | + "documentation":"<p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
721 | 726 | },
|
722 | 727 | "ServiceDependents":{
|
723 | 728 | "shape":"ServiceDependents",
|
|
791 | 796 | "members":{
|
792 | 797 | "StartTime":{
|
793 | 798 | "shape":"Timestamp",
|
794 |
| - "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 799 | + "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>", |
795 | 800 | "location":"querystring",
|
796 | 801 | "locationName":"StartTime"
|
797 | 802 | },
|
798 | 803 | "EndTime":{
|
799 | 804 | "shape":"Timestamp",
|
800 |
| - "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 805 | + "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested end time will be rounded to the nearest hour.</p>", |
801 | 806 | "location":"querystring",
|
802 | 807 | "locationName":"EndTime"
|
803 | 808 | },
|
|
829 | 834 | "members":{
|
830 | 835 | "StartTime":{
|
831 | 836 | "shape":"Timestamp",
|
832 |
| - "documentation":"<p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>" |
| 837 | + "documentation":"<p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
833 | 838 | },
|
834 | 839 | "EndTime":{
|
835 | 840 | "shape":"Timestamp",
|
836 |
| - "documentation":"<p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>" |
| 841 | + "documentation":"<p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
837 | 842 | },
|
838 | 843 | "ServiceOperations":{
|
839 | 844 | "shape":"ServiceOperations",
|
|
854 | 859 | "members":{
|
855 | 860 | "StartTime":{
|
856 | 861 | "shape":"Timestamp",
|
857 |
| - "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 862 | + "documentation":"<p>The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>", |
858 | 863 | "location":"querystring",
|
859 | 864 | "locationName":"StartTime"
|
860 | 865 | },
|
861 | 866 | "EndTime":{
|
862 | 867 | "shape":"Timestamp",
|
863 |
| - "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>", |
| 868 | + "documentation":"<p>The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>Your requested start time will be rounded to the nearest hour.</p>", |
864 | 869 | "location":"querystring",
|
865 | 870 | "locationName":"EndTime"
|
866 | 871 | },
|
|
894 | 899 | "members":{
|
895 | 900 | "StartTime":{
|
896 | 901 | "shape":"Timestamp",
|
897 |
| - "documentation":"<p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>" |
| 902 | + "documentation":"<p>The start of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
898 | 903 | },
|
899 | 904 | "EndTime":{
|
900 | 905 | "shape":"Timestamp",
|
901 |
| - "documentation":"<p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p>" |
| 906 | + "documentation":"<p>The end of the time period that the returned information applies to. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: <code>1698778057</code> </p> <p>This displays the time that Application Signals used for the request. It might not match your request exactly, because it was rounded to the nearest hour.</p>" |
902 | 907 | },
|
903 | 908 | "ServiceSummaries":{
|
904 | 909 | "shape":"ServiceSummaries",
|
|
931 | 936 | }
|
932 | 937 | }
|
933 | 938 | },
|
| 939 | + "LogGroupReferences":{ |
| 940 | + "type":"list", |
| 941 | + "member":{"shape":"Attributes"} |
| 942 | + }, |
934 | 943 | "Metric":{
|
935 | 944 | "type":"structure",
|
936 | 945 | "members":{
|
|
1098 | 1107 | },
|
1099 | 1108 | "ResourceId":{
|
1100 | 1109 | "shape":"ResourceId",
|
1101 |
| - "documentation":"<p>Cannot find the resource id.</p>" |
| 1110 | + "documentation":"<p>Can't find the resource id.</p>" |
1102 | 1111 | },
|
1103 | 1112 | "Message":{"shape":"FaultDescription"}
|
1104 | 1113 | },
|
|
1161 | 1170 | "MetricReferences":{
|
1162 | 1171 | "shape":"MetricReferences",
|
1163 | 1172 | "documentation":"<p>An array of structures that each contain information about one metric associated with this service.</p>"
|
| 1173 | + }, |
| 1174 | + "LogGroupReferences":{ |
| 1175 | + "shape":"LogGroupReferences", |
| 1176 | + "documentation":"<p>An array of string-to-string maps that each contain information about one log group associated with this service. Each string-to-string map includes the following fields:</p> <ul> <li> <p> <code>\"Type\": \"AWS::Resource\"</code> </p> </li> <li> <p> <code>\"ResourceType\": \"AWS::Logs::LogGroup\"</code> </p> </li> <li> <p> <code>\"Identifier\": \"<i>name-of-log-group</i>\"</code> </p> </li> </ul>" |
1164 | 1177 | }
|
1165 | 1178 | },
|
1166 | 1179 | "documentation":"<p>This structure contains information about one of your services that was discovered by Application Signals. </p>"
|
|
1807 | 1820 | "box":true
|
1808 | 1821 | }
|
1809 | 1822 | },
|
1810 |
| - "documentation":"<important> <p>This is a Preview release of the Application Signals API Reference. Operations and parameters are subject to change before the general availability release.</p> </important> <p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. The application-centric view provides you with unified visibility across your applications, services, and dependencies, so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer experience.</p> <p>Application Signals provides the following benefits:</p> <ul> <li> <p>Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors. </p> </li> <li> <p>Create and monitor service level objectives (SLOs). </p> </li> <li> <p>See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.</p> </li> </ul>" |
| 1823 | + "documentation":"<p>Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. The application-centric view provides you with unified visibility across your applications, services, and dependencies, so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer experience.</p> <p>Application Signals provides the following benefits:</p> <ul> <li> <p>Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors. </p> </li> <li> <p>Create and monitor service level objectives (SLOs). </p> </li> <li> <p>See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity.</p> </li> </ul> <p>Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries, and application names within dashboards and maps.</p>" |
1811 | 1824 | }
|
0 commit comments