@aws-sdk/client-application-signals 3.899.0 → 3.900.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -19
- package/dist-cjs/index.js +373 -0
- package/dist-es/ApplicationSignals.js +10 -0
- package/dist-es/commands/DeleteGroupingConfigurationCommand.js +22 -0
- package/dist-es/commands/ListAuditFindingsCommand.js +22 -0
- package/dist-es/commands/ListGroupingAttributeDefinitionsCommand.js +22 -0
- package/dist-es/commands/ListServiceStatesCommand.js +22 -0
- package/dist-es/commands/PutGroupingConfigurationCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +26 -0
- package/dist-es/pagination/ListServiceStatesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +250 -0
- package/dist-types/ApplicationSignals.d.ts +38 -19
- package/dist-types/ApplicationSignalsClient.d.ts +8 -21
- package/dist-types/commands/BatchGetServiceLevelObjectiveBudgetReportCommand.d.ts +1 -11
- package/dist-types/commands/CreateServiceLevelObjectiveCommand.d.ts +2 -90
- package/dist-types/commands/DeleteGroupingConfigurationCommand.d.ts +79 -0
- package/dist-types/commands/GetServiceCommand.d.ts +8 -0
- package/dist-types/commands/ListAuditFindingsCommand.d.ts +181 -0
- package/dist-types/commands/ListGroupingAttributeDefinitionsCommand.d.ts +93 -0
- package/dist-types/commands/ListServiceDependenciesCommand.d.ts +1 -4
- package/dist-types/commands/ListServiceDependentsCommand.d.ts +1 -2
- package/dist-types/commands/ListServiceLevelObjectivesCommand.d.ts +2 -2
- package/dist-types/commands/ListServiceOperationsCommand.d.ts +1 -2
- package/dist-types/commands/ListServiceStatesCommand.d.ts +124 -0
- package/dist-types/commands/ListServicesCommand.d.ts +9 -3
- package/dist-types/commands/PutGroupingConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/StartDiscoveryCommand.d.ts +1 -44
- package/dist-types/commands/TagResourceCommand.d.ts +1 -10
- package/dist-types/commands/UpdateServiceLevelObjectiveCommand.d.ts +2 -4
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/index.d.ts +1 -19
- package/dist-types/models/models_0.d.ts +812 -1114
- package/dist-types/pagination/ListServiceStatesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/ts3.4/ApplicationSignals.d.ts +87 -0
- package/dist-types/ts3.4/ApplicationSignalsClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/DeleteGroupingConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListAuditFindingsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListGroupingAttributeDefinitionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListServiceStatesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/PutGroupingConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +193 -1
- package/dist-types/ts3.4/pagination/ListServiceStatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/package.json +1 -1
|
@@ -27,17 +27,7 @@ declare const BatchGetServiceLevelObjectiveBudgetReportCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Use this operation to retrieve one or more <i>service level objective (SLO) budget reports</i>.</p>
|
|
31
|
-
* <p>An <i>error budget</i> is the amount of time or requests in an unhealthy state that your service can
|
|
32
|
-
* accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be
|
|
33
|
-
* unmet. For example, an SLO with a threshold of 99.95% and a monthly interval
|
|
34
|
-
* translates to an error budget of 21.9 minutes of
|
|
35
|
-
* downtime in a 30-day month.</p>
|
|
36
|
-
* <p>Budget reports include a health indicator, the attainment value, and
|
|
37
|
-
* remaining budget.</p>
|
|
38
|
-
* <p>For more information about SLO error budgets, see
|
|
39
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html#CloudWatch-ServiceLevelObjectives-concepts">
|
|
40
|
-
* SLO concepts</a>.</p>
|
|
30
|
+
* <p>Use this operation to retrieve one or more <i>service level objective (SLO) budget reports</i>.</p> <p>An <i>error budget</i> is the amount of time or requests in an unhealthy state that your service can accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be unmet. For example, an SLO with a threshold of 99.95% and a monthly interval translates to an error budget of 21.9 minutes of downtime in a 30-day month.</p> <p>Budget reports include a health indicator, the attainment value, and remaining budget.</p> <p>For more information about SLO error budgets, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html#CloudWatch-ServiceLevelObjectives-concepts"> SLO concepts</a>.</p>
|
|
41
31
|
* @example
|
|
42
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
33
|
* ```javascript
|
|
@@ -27,96 +27,7 @@ declare const CreateServiceLevelObjectiveCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a service level objective (SLO), which can help you ensure that your critical business operations are
|
|
31
|
-
* meeting customer expectations. Use SLOs to set and track specific target levels for the
|
|
32
|
-
* reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to
|
|
33
|
-
* calculate whether the application is performing at the level that you want.</p>
|
|
34
|
-
* <p>Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch
|
|
35
|
-
* measures this target frequently you can find whether it has been breached. </p>
|
|
36
|
-
* <p>The target performance quality that is defined for an SLO is the <i>attainment goal</i>.</p>
|
|
37
|
-
* <p>You can set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability.
|
|
38
|
-
* You can also set SLOs against any CloudWatch metric or math expression that produces a time series.</p>
|
|
39
|
-
* <note>
|
|
40
|
-
* <p>You can't create an SLO for a service operation that was discovered by Application Signals until after that operation has reported standard
|
|
41
|
-
* metrics to Application Signals.</p>
|
|
42
|
-
* </note>
|
|
43
|
-
* <p>When you create an SLO, you specify whether it is a <i>period-based SLO</i>
|
|
44
|
-
* or a <i>request-based SLO</i>. Each type of SLO has a different way of evaluating
|
|
45
|
-
* your application's performance against its attainment goal.</p>
|
|
46
|
-
* <ul>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>A <i>period-based SLO</i> uses defined <i>periods</i> of time within
|
|
49
|
-
* a specified total time interval. For each period of time, Application Signals determines whether the
|
|
50
|
-
* application met its goal. The attainment rate is calculated as the <code>number of good periods/number of total periods</code>.</p>
|
|
51
|
-
* <p>For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its
|
|
52
|
-
* performance goal during at least 99.9% of the
|
|
53
|
-
* time periods.</p>
|
|
54
|
-
* </li>
|
|
55
|
-
* <li>
|
|
56
|
-
* <p>A <i>request-based SLO</i> doesn't use pre-defined periods of time. Instead,
|
|
57
|
-
* the SLO measures <code>number of good requests/number of total requests</code> during the interval. At any time, you can find the ratio of
|
|
58
|
-
* good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.</p>
|
|
59
|
-
* </li>
|
|
60
|
-
* </ul>
|
|
61
|
-
* <p>After you have created an SLO, you can retrieve error budget reports for it.
|
|
62
|
-
* An <i>error budget</i> is the amount of time or amount of requests that your application can be non-compliant
|
|
63
|
-
* with the SLO's goal, and still have your application meet the goal.</p>
|
|
64
|
-
* <ul>
|
|
65
|
-
* <li>
|
|
66
|
-
* <p>For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold,
|
|
67
|
-
* while still meeting the overall goal. The <i>remaining error budget</i> decreases with every failed period
|
|
68
|
-
* that is recorded. The error budget within one interval can never increase.</p>
|
|
69
|
-
* <p>For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month
|
|
70
|
-
* translates to an error budget of 21.9 minutes of downtime per month.</p>
|
|
71
|
-
* </li>
|
|
72
|
-
* <li>
|
|
73
|
-
* <p>For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on
|
|
74
|
-
* the ratio of good requests to total requests.</p>
|
|
75
|
-
* </li>
|
|
76
|
-
* </ul>
|
|
77
|
-
* <p>For more information about SLOs, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html">
|
|
78
|
-
* Service level objectives (SLOs)</a>.
|
|
79
|
-
* </p>
|
|
80
|
-
* <p>When you perform a <code>CreateServiceLevelObjective</code> operation, Application Signals creates the <i>AWSServiceRoleForCloudWatchApplicationSignals</i> service-linked role,
|
|
81
|
-
* if it doesn't already exist in your account. This service-
|
|
82
|
-
* linked role has the following permissions:</p>
|
|
83
|
-
* <ul>
|
|
84
|
-
* <li>
|
|
85
|
-
* <p>
|
|
86
|
-
* <code>xray:GetServiceGraph</code>
|
|
87
|
-
* </p>
|
|
88
|
-
* </li>
|
|
89
|
-
* <li>
|
|
90
|
-
* <p>
|
|
91
|
-
* <code>logs:StartQuery</code>
|
|
92
|
-
* </p>
|
|
93
|
-
* </li>
|
|
94
|
-
* <li>
|
|
95
|
-
* <p>
|
|
96
|
-
* <code>logs:GetQueryResults</code>
|
|
97
|
-
* </p>
|
|
98
|
-
* </li>
|
|
99
|
-
* <li>
|
|
100
|
-
* <p>
|
|
101
|
-
* <code>cloudwatch:GetMetricData</code>
|
|
102
|
-
* </p>
|
|
103
|
-
* </li>
|
|
104
|
-
* <li>
|
|
105
|
-
* <p>
|
|
106
|
-
* <code>cloudwatch:ListMetrics</code>
|
|
107
|
-
* </p>
|
|
108
|
-
* </li>
|
|
109
|
-
* <li>
|
|
110
|
-
* <p>
|
|
111
|
-
* <code>tag:GetResources</code>
|
|
112
|
-
* </p>
|
|
113
|
-
* </li>
|
|
114
|
-
* <li>
|
|
115
|
-
* <p>
|
|
116
|
-
* <code>autoscaling:DescribeAutoScalingGroups</code>
|
|
117
|
-
* </p>
|
|
118
|
-
* </li>
|
|
119
|
-
* </ul>
|
|
30
|
+
* <p>Creates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set and track specific target levels for the reliability and availability of your applications and services. SLOs use service level indicators (SLIs) to calculate whether the application is performing at the level that you want.</p> <p>Create an SLO to set a target for a service or operation’s availability or latency. CloudWatch measures this target frequently you can find whether it has been breached. </p> <p>The target performance quality that is defined for an SLO is the <i>attainment goal</i>.</p> <p>You can set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability. You can also set SLOs against any CloudWatch metric or math expression that produces a time series.</p> <note> <p>You can't create an SLO for a service operation that was discovered by Application Signals until after that operation has reported standard metrics to Application Signals.</p> </note> <p>When you create an SLO, you specify whether it is a <i>period-based SLO</i> or a <i>request-based SLO</i>. Each type of SLO has a different way of evaluating your application's performance against its attainment goal.</p> <ul> <li> <p>A <i>period-based SLO</i> uses defined <i>periods</i> of time within a specified total time interval. For each period of time, Application Signals determines whether the application met its goal. The attainment rate is calculated as the <code>number of good periods/number of total periods</code>.</p> <p>For example, for a period-based SLO, meeting an attainment goal of 99.9% means that within your interval, your application must meet its performance goal during at least 99.9% of the time periods.</p> </li> <li> <p>A <i>request-based SLO</i> doesn't use pre-defined periods of time. Instead, the SLO measures <code>number of good requests/number of total requests</code> during the interval. At any time, you can find the ratio of good requests to total requests for the interval up to the time stamp that you specify, and measure that ratio against the goal set in your SLO.</p> </li> </ul> <p>After you have created an SLO, you can retrieve error budget reports for it. An <i>error budget</i> is the amount of time or amount of requests that your application can be non-compliant with the SLO's goal, and still have your application meet the goal.</p> <ul> <li> <p>For a period-based SLO, the error budget starts at a number defined by the highest number of periods that can fail to meet the threshold, while still meeting the overall goal. The <i>remaining error budget</i> decreases with every failed period that is recorded. The error budget within one interval can never increase.</p> <p>For example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month translates to an error budget of 21.9 minutes of downtime per month.</p> </li> <li> <p>For a request-based SLO, the remaining error budget is dynamic and can increase or decrease, depending on the ratio of good requests to total requests.</p> </li> </ul> <p>For more information about SLOs, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html"> Service level objectives (SLOs)</a>. </p> <p>When you perform a <code>CreateServiceLevelObjective</code> operation, Application Signals creates the <i>AWSServiceRoleForCloudWatchApplicationSignals</i> service-linked role, if it doesn't already exist in your account. This service- linked role has the following permissions:</p> <ul> <li> <p> <code>xray:GetServiceGraph</code> </p> </li> <li> <p> <code>logs:StartQuery</code> </p> </li> <li> <p> <code>logs:GetQueryResults</code> </p> </li> <li> <p> <code>cloudwatch:GetMetricData</code> </p> </li> <li> <p> <code>cloudwatch:ListMetrics</code> </p> </li> <li> <p> <code>tag:GetResources</code> </p> </li> <li> <p> <code>autoscaling:DescribeAutoScalingGroups</code> </p> </li> </ul>
|
|
120
31
|
* @example
|
|
121
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
122
33
|
* ```javascript
|
|
@@ -135,6 +46,7 @@ declare const CreateServiceLevelObjectiveCommand_base: {
|
|
|
135
46
|
* },
|
|
136
47
|
* OperationName: "STRING_VALUE",
|
|
137
48
|
* MetricType: "LATENCY" || "AVAILABILITY",
|
|
49
|
+
* MetricName: "STRING_VALUE",
|
|
138
50
|
* Statistic: "STRING_VALUE",
|
|
139
51
|
* PeriodSeconds: Number("int"),
|
|
140
52
|
* MetricDataQueries: [ // MetricDataQueries
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationSignalsClient";
|
|
4
|
+
import { DeleteGroupingConfigurationOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteGroupingConfigurationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteGroupingConfigurationCommandInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteGroupingConfigurationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteGroupingConfigurationCommandOutput extends DeleteGroupingConfigurationOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteGroupingConfigurationCommand_base: {
|
|
25
|
+
new (input: DeleteGroupingConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteGroupingConfigurationCommandInput, DeleteGroupingConfigurationCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [DeleteGroupingConfigurationCommandInput]): import("@smithy/smithy-client").CommandImpl<DeleteGroupingConfigurationCommandInput, DeleteGroupingConfigurationCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes the grouping configuration for this account. This removes all custom grouping attribute definitions that were previously configured.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApplicationSignalsClient, DeleteGroupingConfigurationCommand } from "@aws-sdk/client-application-signals"; // ES Modules import
|
|
35
|
+
* // const { ApplicationSignalsClient, DeleteGroupingConfigurationCommand } = require("@aws-sdk/client-application-signals"); // CommonJS import
|
|
36
|
+
* // import type { ApplicationSignalsClientConfig } from "@aws-sdk/client-application-signals";
|
|
37
|
+
* const config = {}; // type is ApplicationSignalsClientConfig
|
|
38
|
+
* const client = new ApplicationSignalsClient(config);
|
|
39
|
+
* const input = {};
|
|
40
|
+
* const command = new DeleteGroupingConfigurationCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // {};
|
|
43
|
+
*
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* @param DeleteGroupingConfigurationCommandInput - {@link DeleteGroupingConfigurationCommandInput}
|
|
47
|
+
* @returns {@link DeleteGroupingConfigurationCommandOutput}
|
|
48
|
+
* @see {@link DeleteGroupingConfigurationCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link DeleteGroupingConfigurationCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link ApplicationSignalsClientResolvedConfig | config} for ApplicationSignalsClient's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
+
* <p>You don't have sufficient permissions to perform this action.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
56
|
+
* <p>The request was throttled because of quota limits.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link ValidationException} (client fault)
|
|
59
|
+
* <p>The resource is not valid.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ApplicationSignalsServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from ApplicationSignals service.</p>
|
|
63
|
+
*
|
|
64
|
+
*
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
export declare class DeleteGroupingConfigurationCommand extends DeleteGroupingConfigurationCommand_base {
|
|
68
|
+
/** @internal type navigation helper, not in runtime. */
|
|
69
|
+
protected static __types: {
|
|
70
|
+
api: {
|
|
71
|
+
input: {};
|
|
72
|
+
output: {};
|
|
73
|
+
};
|
|
74
|
+
sdk: {
|
|
75
|
+
input: DeleteGroupingConfigurationCommandInput;
|
|
76
|
+
output: DeleteGroupingConfigurationCommandOutput;
|
|
77
|
+
};
|
|
78
|
+
};
|
|
79
|
+
}
|
|
@@ -55,6 +55,14 @@ declare const GetServiceCommand_base: {
|
|
|
55
55
|
* // "<keys>": "STRING_VALUE",
|
|
56
56
|
* // },
|
|
57
57
|
* // ],
|
|
58
|
+
* // ServiceGroups: [ // ServiceGroups
|
|
59
|
+
* // { // ServiceGroup
|
|
60
|
+
* // GroupName: "STRING_VALUE", // required
|
|
61
|
+
* // GroupValue: "STRING_VALUE", // required
|
|
62
|
+
* // GroupSource: "STRING_VALUE", // required
|
|
63
|
+
* // GroupIdentifier: "STRING_VALUE", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
58
66
|
* // MetricReferences: [ // MetricReferences // required
|
|
59
67
|
* // { // MetricReference
|
|
60
68
|
* // Namespace: "STRING_VALUE", // required
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationSignalsClient";
|
|
4
|
+
import { ListAuditFindingsInput, ListAuditFindingsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAuditFindingsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAuditFindingsCommandInput extends ListAuditFindingsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAuditFindingsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAuditFindingsCommandOutput extends ListAuditFindingsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListAuditFindingsCommand_base: {
|
|
25
|
+
new (input: ListAuditFindingsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAuditFindingsCommandInput, ListAuditFindingsCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: ListAuditFindingsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAuditFindingsCommandInput, ListAuditFindingsCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of audit findings that provide automated analysis of service behavior and root cause analysis. These findings help identify the most significant observations about your services, including performance issues, anomalies, and potential problems. The findings are generated using heuristic algorithms based on established troubleshooting patterns.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApplicationSignalsClient, ListAuditFindingsCommand } from "@aws-sdk/client-application-signals"; // ES Modules import
|
|
35
|
+
* // const { ApplicationSignalsClient, ListAuditFindingsCommand } = require("@aws-sdk/client-application-signals"); // CommonJS import
|
|
36
|
+
* // import type { ApplicationSignalsClientConfig } from "@aws-sdk/client-application-signals";
|
|
37
|
+
* const config = {}; // type is ApplicationSignalsClientConfig
|
|
38
|
+
* const client = new ApplicationSignalsClient(config);
|
|
39
|
+
* const input = { // ListAuditFindingsInput
|
|
40
|
+
* StartTime: new Date("TIMESTAMP"), // required
|
|
41
|
+
* EndTime: new Date("TIMESTAMP"), // required
|
|
42
|
+
* Auditors: [ // Auditors
|
|
43
|
+
* "STRING_VALUE",
|
|
44
|
+
* ],
|
|
45
|
+
* AuditTargets: [ // AuditTargets // required
|
|
46
|
+
* { // AuditTarget
|
|
47
|
+
* Type: "STRING_VALUE", // required
|
|
48
|
+
* Data: { // AuditTargetEntity Union: only one key present
|
|
49
|
+
* Service: { // ServiceEntity
|
|
50
|
+
* Type: "STRING_VALUE",
|
|
51
|
+
* Name: "STRING_VALUE",
|
|
52
|
+
* Environment: "STRING_VALUE",
|
|
53
|
+
* AwsAccountId: "STRING_VALUE",
|
|
54
|
+
* },
|
|
55
|
+
* Slo: { // ServiceLevelObjectiveEntity
|
|
56
|
+
* SloName: "STRING_VALUE",
|
|
57
|
+
* SloArn: "STRING_VALUE",
|
|
58
|
+
* },
|
|
59
|
+
* ServiceOperation: { // ServiceOperationEntity
|
|
60
|
+
* Service: {
|
|
61
|
+
* Type: "STRING_VALUE",
|
|
62
|
+
* Name: "STRING_VALUE",
|
|
63
|
+
* Environment: "STRING_VALUE",
|
|
64
|
+
* AwsAccountId: "STRING_VALUE",
|
|
65
|
+
* },
|
|
66
|
+
* Operation: "STRING_VALUE",
|
|
67
|
+
* MetricType: "STRING_VALUE",
|
|
68
|
+
* },
|
|
69
|
+
* },
|
|
70
|
+
* },
|
|
71
|
+
* ],
|
|
72
|
+
* NextToken: "STRING_VALUE",
|
|
73
|
+
* MaxResults: Number("int"),
|
|
74
|
+
* };
|
|
75
|
+
* const command = new ListAuditFindingsCommand(input);
|
|
76
|
+
* const response = await client.send(command);
|
|
77
|
+
* // { // ListAuditFindingsOutput
|
|
78
|
+
* // AuditFindings: [ // AuditFindings // required
|
|
79
|
+
* // { // AuditFinding
|
|
80
|
+
* // KeyAttributes: { // Attributes // required
|
|
81
|
+
* // "<keys>": "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // AuditorResults: [ // AuditorResults
|
|
84
|
+
* // { // AuditorResult
|
|
85
|
+
* // Auditor: "STRING_VALUE",
|
|
86
|
+
* // Description: "STRING_VALUE",
|
|
87
|
+
* // Severity: "CRITICAL" || "HIGH" || "MEDIUM" || "LOW" || "NONE",
|
|
88
|
+
* // },
|
|
89
|
+
* // ],
|
|
90
|
+
* // Operation: "STRING_VALUE",
|
|
91
|
+
* // MetricGraph: { // MetricGraph
|
|
92
|
+
* // MetricDataQueries: [ // MetricDataQueries
|
|
93
|
+
* // { // MetricDataQuery
|
|
94
|
+
* // Id: "STRING_VALUE", // required
|
|
95
|
+
* // MetricStat: { // MetricStat
|
|
96
|
+
* // Metric: { // Metric
|
|
97
|
+
* // Namespace: "STRING_VALUE",
|
|
98
|
+
* // MetricName: "STRING_VALUE",
|
|
99
|
+
* // Dimensions: [ // Dimensions
|
|
100
|
+
* // { // Dimension
|
|
101
|
+
* // Name: "STRING_VALUE", // required
|
|
102
|
+
* // Value: "STRING_VALUE", // required
|
|
103
|
+
* // },
|
|
104
|
+
* // ],
|
|
105
|
+
* // },
|
|
106
|
+
* // Period: Number("int"), // required
|
|
107
|
+
* // Stat: "STRING_VALUE", // required
|
|
108
|
+
* // Unit: "Microseconds" || "Milliseconds" || "Seconds" || "Bytes" || "Kilobytes" || "Megabytes" || "Gigabytes" || "Terabytes" || "Bits" || "Kilobits" || "Megabits" || "Gigabits" || "Terabits" || "Percent" || "Count" || "Bytes/Second" || "Kilobytes/Second" || "Megabytes/Second" || "Gigabytes/Second" || "Terabytes/Second" || "Bits/Second" || "Kilobits/Second" || "Megabits/Second" || "Gigabits/Second" || "Terabits/Second" || "Count/Second" || "None",
|
|
109
|
+
* // },
|
|
110
|
+
* // Expression: "STRING_VALUE",
|
|
111
|
+
* // Label: "STRING_VALUE",
|
|
112
|
+
* // ReturnData: true || false,
|
|
113
|
+
* // Period: Number("int"),
|
|
114
|
+
* // AccountId: "STRING_VALUE",
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
118
|
+
* // EndTime: new Date("TIMESTAMP"),
|
|
119
|
+
* // },
|
|
120
|
+
* // DependencyGraph: { // DependencyGraph
|
|
121
|
+
* // Nodes: [ // Nodes
|
|
122
|
+
* // { // Node
|
|
123
|
+
* // KeyAttributes: { // required
|
|
124
|
+
* // "<keys>": "STRING_VALUE",
|
|
125
|
+
* // },
|
|
126
|
+
* // Name: "STRING_VALUE", // required
|
|
127
|
+
* // NodeId: "STRING_VALUE", // required
|
|
128
|
+
* // Operation: "STRING_VALUE",
|
|
129
|
+
* // Type: "STRING_VALUE",
|
|
130
|
+
* // Duration: Number("double"),
|
|
131
|
+
* // Status: "STRING_VALUE",
|
|
132
|
+
* // },
|
|
133
|
+
* // ],
|
|
134
|
+
* // Edges: [ // Edges
|
|
135
|
+
* // { // Edge
|
|
136
|
+
* // SourceNodeId: "STRING_VALUE",
|
|
137
|
+
* // DestinationNodeId: "STRING_VALUE",
|
|
138
|
+
* // Duration: Number("double"),
|
|
139
|
+
* // ConnectionType: "INDIRECT" || "DIRECT",
|
|
140
|
+
* // },
|
|
141
|
+
* // ],
|
|
142
|
+
* // },
|
|
143
|
+
* // Type: "STRING_VALUE",
|
|
144
|
+
* // },
|
|
145
|
+
* // ],
|
|
146
|
+
* // NextToken: "STRING_VALUE",
|
|
147
|
+
* // };
|
|
148
|
+
*
|
|
149
|
+
* ```
|
|
150
|
+
*
|
|
151
|
+
* @param ListAuditFindingsCommandInput - {@link ListAuditFindingsCommandInput}
|
|
152
|
+
* @returns {@link ListAuditFindingsCommandOutput}
|
|
153
|
+
* @see {@link ListAuditFindingsCommandInput} for command's `input` shape.
|
|
154
|
+
* @see {@link ListAuditFindingsCommandOutput} for command's `response` shape.
|
|
155
|
+
* @see {@link ApplicationSignalsClientResolvedConfig | config} for ApplicationSignalsClient's `config` shape.
|
|
156
|
+
*
|
|
157
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
158
|
+
* <p>The request was throttled because of quota limits.</p>
|
|
159
|
+
*
|
|
160
|
+
* @throws {@link ValidationException} (client fault)
|
|
161
|
+
* <p>The resource is not valid.</p>
|
|
162
|
+
*
|
|
163
|
+
* @throws {@link ApplicationSignalsServiceException}
|
|
164
|
+
* <p>Base exception class for all service exceptions from ApplicationSignals service.</p>
|
|
165
|
+
*
|
|
166
|
+
*
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
export declare class ListAuditFindingsCommand extends ListAuditFindingsCommand_base {
|
|
170
|
+
/** @internal type navigation helper, not in runtime. */
|
|
171
|
+
protected static __types: {
|
|
172
|
+
api: {
|
|
173
|
+
input: ListAuditFindingsInput;
|
|
174
|
+
output: ListAuditFindingsOutput;
|
|
175
|
+
};
|
|
176
|
+
sdk: {
|
|
177
|
+
input: ListAuditFindingsCommandInput;
|
|
178
|
+
output: ListAuditFindingsCommandOutput;
|
|
179
|
+
};
|
|
180
|
+
};
|
|
181
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationSignalsClient";
|
|
4
|
+
import { ListGroupingAttributeDefinitionsInput, ListGroupingAttributeDefinitionsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListGroupingAttributeDefinitionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListGroupingAttributeDefinitionsCommandInput extends ListGroupingAttributeDefinitionsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListGroupingAttributeDefinitionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListGroupingAttributeDefinitionsCommandOutput extends ListGroupingAttributeDefinitionsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListGroupingAttributeDefinitionsCommand_base: {
|
|
25
|
+
new (input: ListGroupingAttributeDefinitionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListGroupingAttributeDefinitionsCommandInput, ListGroupingAttributeDefinitionsCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListGroupingAttributeDefinitionsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListGroupingAttributeDefinitionsCommandInput, ListGroupingAttributeDefinitionsCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured. These definitions determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApplicationSignalsClient, ListGroupingAttributeDefinitionsCommand } from "@aws-sdk/client-application-signals"; // ES Modules import
|
|
35
|
+
* // const { ApplicationSignalsClient, ListGroupingAttributeDefinitionsCommand } = require("@aws-sdk/client-application-signals"); // CommonJS import
|
|
36
|
+
* // import type { ApplicationSignalsClientConfig } from "@aws-sdk/client-application-signals";
|
|
37
|
+
* const config = {}; // type is ApplicationSignalsClientConfig
|
|
38
|
+
* const client = new ApplicationSignalsClient(config);
|
|
39
|
+
* const input = { // ListGroupingAttributeDefinitionsInput
|
|
40
|
+
* NextToken: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new ListGroupingAttributeDefinitionsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // ListGroupingAttributeDefinitionsOutput
|
|
45
|
+
* // GroupingAttributeDefinitions: [ // GroupingAttributeDefinitions // required
|
|
46
|
+
* // { // GroupingAttributeDefinition
|
|
47
|
+
* // GroupingName: "STRING_VALUE", // required
|
|
48
|
+
* // GroupingSourceKeys: [ // GroupingSourceKeyStringList
|
|
49
|
+
* // "STRING_VALUE",
|
|
50
|
+
* // ],
|
|
51
|
+
* // DefaultGroupingValue: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
55
|
+
* // NextToken: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
60
|
+
* @param ListGroupingAttributeDefinitionsCommandInput - {@link ListGroupingAttributeDefinitionsCommandInput}
|
|
61
|
+
* @returns {@link ListGroupingAttributeDefinitionsCommandOutput}
|
|
62
|
+
* @see {@link ListGroupingAttributeDefinitionsCommandInput} for command's `input` shape.
|
|
63
|
+
* @see {@link ListGroupingAttributeDefinitionsCommandOutput} for command's `response` shape.
|
|
64
|
+
* @see {@link ApplicationSignalsClientResolvedConfig | config} for ApplicationSignalsClient's `config` shape.
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
67
|
+
* <p>You don't have sufficient permissions to perform this action.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
+
* <p>The request was throttled because of quota limits.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ValidationException} (client fault)
|
|
73
|
+
* <p>The resource is not valid.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ApplicationSignalsServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from ApplicationSignals service.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare class ListGroupingAttributeDefinitionsCommand extends ListGroupingAttributeDefinitionsCommand_base {
|
|
82
|
+
/** @internal type navigation helper, not in runtime. */
|
|
83
|
+
protected static __types: {
|
|
84
|
+
api: {
|
|
85
|
+
input: ListGroupingAttributeDefinitionsInput;
|
|
86
|
+
output: ListGroupingAttributeDefinitionsOutput;
|
|
87
|
+
};
|
|
88
|
+
sdk: {
|
|
89
|
+
input: ListGroupingAttributeDefinitionsCommandInput;
|
|
90
|
+
output: ListGroupingAttributeDefinitionsCommandOutput;
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
}
|
|
@@ -27,10 +27,7 @@ declare const ListServiceDependenciesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure
|
|
31
|
-
* component that an operation of this service connects with. Dependencies can include Amazon Web Services
|
|
32
|
-
* services, Amazon Web Services resources, and third-party services.
|
|
33
|
-
* </p>
|
|
30
|
+
* <p>Returns a list of service dependencies of the service that you specify. A dependency is an infrastructure component that an operation of this service connects with. Dependencies can include Amazon Web Services services, Amazon Web Services resources, and third-party services. </p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const ListServiceDependentsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns the list of dependents that invoked the specified service during the provided time range. Dependents include
|
|
31
|
-
* other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.</p>
|
|
30
|
+
* <p>Returns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics canaries, and clients that are instrumented with CloudWatch RUM app monitors.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -49,11 +49,11 @@ declare const ListServiceLevelObjectivesCommand_base: {
|
|
|
49
49
|
* },
|
|
50
50
|
* MaxResults: Number("int"),
|
|
51
51
|
* NextToken: "STRING_VALUE",
|
|
52
|
+
* IncludeLinkedAccounts: true || false,
|
|
53
|
+
* SloOwnerAwsAccountId: "STRING_VALUE",
|
|
52
54
|
* MetricSourceTypes: [ // MetricSourceTypes
|
|
53
55
|
* "ServiceOperation" || "CloudWatchMetric" || "ServiceDependency",
|
|
54
56
|
* ],
|
|
55
|
-
* IncludeLinkedAccounts: true || false,
|
|
56
|
-
* SloOwnerAwsAccountId: "STRING_VALUE",
|
|
57
57
|
* };
|
|
58
58
|
* const command = new ListServiceLevelObjectivesCommand(input);
|
|
59
59
|
* const response = await client.send(command);
|
|
@@ -27,8 +27,7 @@ declare const ListServiceOperationsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of the <i>operations</i> of this service that have been discovered by Application Signals.
|
|
31
|
-
* Only the operations that were invoked during the specified time range are returned.</p>
|
|
30
|
+
* <p>Returns a list of the <i>operations</i> of this service that have been discovered by Application Signals. Only the operations that were invoked during the specified time range are returned.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|