|
571 | 571 | "members":{
|
572 | 572 | }
|
573 | 573 | },
|
| 574 | + "DependencyConfig":{ |
| 575 | + "type":"structure", |
| 576 | + "required":[ |
| 577 | + "DependencyKeyAttributes", |
| 578 | + "DependencyOperationName" |
| 579 | + ], |
| 580 | + "members":{ |
| 581 | + "DependencyKeyAttributes":{ |
| 582 | + "shape":"Attributes", |
| 583 | + "documentation":"<p>This is a string-to-string map. It can include the following fields.</p> <ul> <li> <p> <code>Type</code> designates the type of object this is.</p> </li> <li> <p> <code>ResourceType</code> specifies the type of the resource. This field is used only when the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Name</code> specifies the name of the object. This is used only if the value of the <code>Type</code> field is <code>Service</code>, <code>RemoteService</code>, or <code>AWS::Service</code>.</p> </li> <li> <p> <code>Identifier</code> identifies the resource objects of this resource. This is used only if the value of the <code>Type</code> field is <code>Resource</code> or <code>AWS::Resource</code>.</p> </li> <li> <p> <code>Environment</code> specifies the location where this object is hosted, or what it belongs to.</p> </li> </ul>" |
| 584 | + }, |
| 585 | + "DependencyOperationName":{ |
| 586 | + "shape":"OperationName", |
| 587 | + "documentation":"<p>The name of the called operation in the dependency.</p>" |
| 588 | + } |
| 589 | + }, |
| 590 | + "documentation":"<p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>.</p> <p>When creating a service dependency SLO, you must specify the <code>KeyAttributes</code> of the service, and the <code>DependencyConfig</code> for the dependency. You can specify the <code>OperationName</code> of the service, from which it calls the dependency. Alternatively, you can exclude <code>OperationName</code> and the SLO will monitor all of the service's operations that call the dependency.</p>" |
| 591 | + }, |
574 | 592 | "Dimension":{
|
575 | 593 | "type":"structure",
|
576 | 594 | "required":[
|
|
982 | 1000 | "location":"querystring",
|
983 | 1001 | "locationName":"OperationName"
|
984 | 1002 | },
|
| 1003 | + "DependencyConfig":{ |
| 1004 | + "shape":"DependencyConfig", |
| 1005 | + "documentation":"<p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>. </p>" |
| 1006 | + }, |
985 | 1007 | "MaxResults":{
|
986 | 1008 | "shape":"ListServiceLevelObjectivesMaxResults",
|
987 | 1009 | "documentation":"<p>The maximum number of results to return in one operation. If you omit this parameter, the default of 50 is used.</p>",
|
|
994 | 1016 | "location":"querystring",
|
995 | 1017 | "locationName":"NextToken"
|
996 | 1018 | },
|
| 1019 | + "MetricSourceTypes":{ |
| 1020 | + "shape":"MetricSourceTypes", |
| 1021 | + "documentation":"<p>Use this optional field to only include SLOs with the specified metric source types in the output. Supported types are:</p> <ul> <li> <p>Service operation</p> </li> <li> <p>Service dependency</p> </li> <li> <p>CloudWatch metric</p> </li> </ul>" |
| 1022 | + }, |
997 | 1023 | "IncludeLinkedAccounts":{
|
998 | 1024 | "shape":"Boolean",
|
999 | 1025 | "documentation":"<p>If you are using this operation in a monitoring account, specify <code>true</code> to include SLO from source accounts in the returned data. <pre><code> </p> <p>When you are monitoring an account, you can use Amazon Web Services account ID in <code>KeyAttribute</code> filter for service source account and <code>SloOwnerawsaccountID</code> for SLO source account with <code>IncludeLinkedAccounts</code> to filter the returned data to only a single source account. </p> </code></pre>",
|
|
1307 | 1333 | "type":"list",
|
1308 | 1334 | "member":{"shape":"MetricReference"}
|
1309 | 1335 | },
|
| 1336 | + "MetricSourceType":{ |
| 1337 | + "type":"string", |
| 1338 | + "enum":[ |
| 1339 | + "ServiceOperation", |
| 1340 | + "CloudWatchMetric", |
| 1341 | + "ServiceDependency" |
| 1342 | + ] |
| 1343 | + }, |
| 1344 | + "MetricSourceTypes":{ |
| 1345 | + "type":"list", |
| 1346 | + "member":{"shape":"MetricSourceType"}, |
| 1347 | + "max":3, |
| 1348 | + "min":1 |
| 1349 | + }, |
1310 | 1350 | "MetricStat":{
|
1311 | 1351 | "type":"structure",
|
1312 | 1352 | "required":[
|
|
1445 | 1485 | "MonitoredRequestCountMetric":{
|
1446 | 1486 | "shape":"MonitoredRequestCountMetricDataQueries",
|
1447 | 1487 | "documentation":"<p>This structure defines the metric that is used as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in <code>TotalRequestCountMetric</code> is divided by the number found for <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that this SLO tracks.</p>"
|
| 1488 | + }, |
| 1489 | + "DependencyConfig":{ |
| 1490 | + "shape":"DependencyConfig", |
| 1491 | + "documentation":"<p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>. </p>" |
1448 | 1492 | }
|
1449 | 1493 | },
|
1450 | 1494 | "documentation":"<p>This structure contains the information about the metric that is used for a request-based SLO.</p>"
|
|
1471 | 1515 | "MonitoredRequestCountMetric":{
|
1472 | 1516 | "shape":"MonitoredRequestCountMetricDataQueries",
|
1473 | 1517 | "documentation":"<p>Use this structure to define the metric that you want to use as the \"good request\" or \"bad request\" value for a request-based SLO. This value observed for the metric defined in <code>TotalRequestCountMetric</code> will be divided by the number found for <code>MonitoredRequestCountMetric</code> to determine the percentage of successful requests that this SLO tracks.</p>"
|
| 1518 | + }, |
| 1519 | + "DependencyConfig":{ |
| 1520 | + "shape":"DependencyConfig", |
| 1521 | + "documentation":"<p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>. </p>" |
1474 | 1522 | }
|
1475 | 1523 | },
|
1476 | 1524 | "documentation":"<p>Use this structure to specify the information for the metric that a period-based SLO will monitor.</p>"
|
|
1702 | 1750 | "MetricDataQueries":{
|
1703 | 1751 | "shape":"MetricDataQueries",
|
1704 | 1752 | "documentation":"<p>If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, this structure includes the information about that metric or expression. </p>"
|
| 1753 | + }, |
| 1754 | + "DependencyConfig":{ |
| 1755 | + "shape":"DependencyConfig", |
| 1756 | + "documentation":"<p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>. </p>" |
1705 | 1757 | }
|
1706 | 1758 | },
|
1707 | 1759 | "documentation":"<p>This structure contains the information about the metric that is used for a period-based SLO.</p>"
|
|
1732 | 1784 | "MetricDataQueries":{
|
1733 | 1785 | "shape":"MetricDataQueries",
|
1734 | 1786 | "documentation":"<p>If this SLO monitors a CloudWatch metric or the result of a CloudWatch metric math expression, use this structure to specify that metric or expression. </p>"
|
| 1787 | + }, |
| 1788 | + "DependencyConfig":{ |
| 1789 | + "shape":"DependencyConfig", |
| 1790 | + "documentation":"<p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>. </p>" |
1735 | 1791 | }
|
1736 | 1792 | },
|
1737 | 1793 | "documentation":"<p>Use this structure to specify the information for the metric that a period-based SLO will monitor.</p>"
|
|
1799 | 1855 | "BurnRateConfigurations":{
|
1800 | 1856 | "shape":"BurnRateConfigurations",
|
1801 | 1857 | "documentation":"<p>Each object in this array defines the length of the look-back window used to calculate one burn rate metric for this SLO. The burn rate measures how fast the service is consuming the error budget, relative to the attainment goal of the SLO.</p>"
|
| 1858 | + }, |
| 1859 | + "MetricSourceType":{ |
| 1860 | + "shape":"MetricSourceType", |
| 1861 | + "documentation":"<p>Displays the SLI metric source type for this SLO. Supported types are:</p> <ul> <li> <p>Service operation</p> </li> <li> <p>Service dependency</p> </li> <li> <p>CloudWatch metric</p> </li> </ul>" |
1802 | 1862 | }
|
1803 | 1863 | },
|
1804 | 1864 | "documentation":"<p>A structure containing information about one service level objective (SLO) that has been created in Application Signals. Creating SLOs can help you ensure your services are performing to the level that you expect. SLOs help you set and track a specific target level for the reliability and availability of your applications and services. Each SLO uses a service level indicator (SLI), which is a key performance metric, to calculate how much underperformance can be tolerated before the goal that you set for the SLO is not achieved.</p>"
|
|
1959 | 2019 | "shape":"OperationName",
|
1960 | 2020 | "documentation":"<p>If this service level objective is specific to a single operation, this field displays the name of that operation.</p>"
|
1961 | 2021 | },
|
| 2022 | + "DependencyConfig":{ |
| 2023 | + "shape":"DependencyConfig", |
| 2024 | + "documentation":"<p>Identifies the dependency using the <code>DependencyKeyAttributes</code> and <code>DependencyOperationName</code>. </p>" |
| 2025 | + }, |
1962 | 2026 | "CreatedTime":{
|
1963 | 2027 | "shape":"Timestamp",
|
1964 | 2028 | "documentation":"<p>The date and time that this service level objective was created. It is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>"
|
| 2029 | + }, |
| 2030 | + "EvaluationType":{ |
| 2031 | + "shape":"EvaluationType", |
| 2032 | + "documentation":"<p>Displays whether this is a period-based SLO or a request-based SLO.</p>" |
| 2033 | + }, |
| 2034 | + "MetricSourceType":{ |
| 2035 | + "shape":"MetricSourceType", |
| 2036 | + "documentation":"<p>Displays the SLI metric source type for this SLO. Supported types are:</p> <ul> <li> <p>Service operation</p> </li> <li> <p>Service dependency</p> </li> <li> <p>CloudWatch metric</p> </li> </ul>" |
1965 | 2037 | }
|
1966 | 2038 | },
|
1967 | 2039 | "documentation":"<p>A structure that contains information about one service level objective (SLO) created in Application Signals.</p>"
|
|
0 commit comments