@aws-sdk/client-application-signals 3.594.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/LICENSE +201 -0
- package/README.md +345 -0
- package/dist-cjs/ApplicationSignals.js +41 -0
- package/dist-cjs/ApplicationSignalsClient.js +56 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/commands/BatchGetServiceLevelObjectiveBudgetReportCommand.js +28 -0
- package/dist-cjs/commands/CreateServiceLevelObjectiveCommand.js +28 -0
- package/dist-cjs/commands/DeleteServiceLevelObjectiveCommand.js +28 -0
- package/dist-cjs/commands/GetServiceCommand.js +28 -0
- package/dist-cjs/commands/GetServiceLevelObjectiveCommand.js +28 -0
- package/dist-cjs/commands/ListServiceDependenciesCommand.js +28 -0
- package/dist-cjs/commands/ListServiceDependentsCommand.js +28 -0
- package/dist-cjs/commands/ListServiceLevelObjectivesCommand.js +28 -0
- package/dist-cjs/commands/ListServiceOperationsCommand.js +28 -0
- package/dist-cjs/commands/ListServicesCommand.js +28 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +28 -0
- package/dist-cjs/commands/StartDiscoveryCommand.js +28 -0
- package/dist-cjs/commands/TagResourceCommand.js +28 -0
- package/dist-cjs/commands/UntagResourceCommand.js +28 -0
- package/dist-cjs/commands/UpdateServiceLevelObjectiveCommand.js +28 -0
- package/dist-cjs/commands/index.js +18 -0
- package/dist-cjs/endpoint/EndpointParameters.js +16 -0
- package/dist-cjs/endpoint/endpointResolver.js +14 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/ApplicationSignalsServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +148 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListServiceDependenciesPaginator.js +7 -0
- package/dist-cjs/pagination/ListServiceDependentsPaginator.js +7 -0
- package/dist-cjs/pagination/ListServiceLevelObjectivesPaginator.js +7 -0
- package/dist-cjs/pagination/ListServiceOperationsPaginator.js +7 -0
- package/dist-cjs/pagination/ListServicesPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +9 -0
- package/dist-cjs/protocols/Aws_restJson1.js +713 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +49 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +34 -0
- package/dist-cjs/runtimeExtensions.js +25 -0
- package/dist-es/ApplicationSignals.js +37 -0
- package/dist-es/ApplicationSignalsClient.js +52 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/commands/BatchGetServiceLevelObjectiveBudgetReportCommand.js +24 -0
- package/dist-es/commands/CreateServiceLevelObjectiveCommand.js +24 -0
- package/dist-es/commands/DeleteServiceLevelObjectiveCommand.js +24 -0
- package/dist-es/commands/GetServiceCommand.js +24 -0
- package/dist-es/commands/GetServiceLevelObjectiveCommand.js +24 -0
- package/dist-es/commands/ListServiceDependenciesCommand.js +24 -0
- package/dist-es/commands/ListServiceDependentsCommand.js +24 -0
- package/dist-es/commands/ListServiceLevelObjectivesCommand.js +24 -0
- package/dist-es/commands/ListServiceOperationsCommand.js +24 -0
- package/dist-es/commands/ListServicesCommand.js +24 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +24 -0
- package/dist-es/commands/StartDiscoveryCommand.js +24 -0
- package/dist-es/commands/TagResourceCommand.js +24 -0
- package/dist-es/commands/UntagResourceCommand.js +24 -0
- package/dist-es/commands/UpdateServiceLevelObjectiveCommand.js +24 -0
- package/dist-es/commands/index.js +15 -0
- package/dist-es/endpoint/EndpointParameters.js +12 -0
- package/dist-es/endpoint/endpointResolver.js +10 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/ApplicationSignalsServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +139 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListServiceDependenciesPaginator.js +4 -0
- package/dist-es/pagination/ListServiceDependentsPaginator.js +4 -0
- package/dist-es/pagination/ListServiceLevelObjectivesPaginator.js +4 -0
- package/dist-es/pagination/ListServiceOperationsPaginator.js +4 -0
- package/dist-es/pagination/ListServicesPaginator.js +4 -0
- package/dist-es/pagination/index.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +680 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +44 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +30 -0
- package/dist-es/runtimeExtensions.js +21 -0
- package/dist-types/ApplicationSignals.d.ts +137 -0
- package/dist-types/ApplicationSignalsClient.d.ts +206 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/BatchGetServiceLevelObjectiveBudgetReportCommand.d.ts +148 -0
- package/dist-types/commands/CreateServiceLevelObjectiveCommand.d.ts +252 -0
- package/dist-types/commands/DeleteServiceLevelObjectiveCommand.d.ts +67 -0
- package/dist-types/commands/GetServiceCommand.d.ts +94 -0
- package/dist-types/commands/GetServiceLevelObjectiveCommand.d.ts +126 -0
- package/dist-types/commands/ListServiceDependenciesCommand.d.ts +99 -0
- package/dist-types/commands/ListServiceDependentsCommand.d.ts +97 -0
- package/dist-types/commands/ListServiceLevelObjectivesCommand.d.ts +82 -0
- package/dist-types/commands/ListServiceOperationsCommand.d.ts +93 -0
- package/dist-types/commands/ListServicesCommand.d.ts +98 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +71 -0
- package/dist-types/commands/StartDiscoveryCommand.d.ts +108 -0
- package/dist-types/commands/TagResourceCommand.d.ts +82 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +67 -0
- package/dist-types/commands/UpdateServiceLevelObjectiveCommand.d.ts +181 -0
- package/dist-types/commands/index.d.ts +15 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +34 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +34 -0
- package/dist-types/models/ApplicationSignalsServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2004 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListServiceDependenciesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListServiceDependentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListServiceLevelObjectivesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListServiceOperationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListServicesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +6 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +137 -0
- package/dist-types/runtimeConfig.browser.d.ts +45 -0
- package/dist-types/runtimeConfig.d.ts +45 -0
- package/dist-types/runtimeConfig.native.d.ts +44 -0
- package/dist-types/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/ApplicationSignals.d.ts +270 -0
- package/dist-types/ts3.4/ApplicationSignalsClient.d.ts +213 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +44 -0
- package/dist-types/ts3.4/commands/BatchGetServiceLevelObjectiveBudgetReportCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/CreateServiceLevelObjectiveCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/DeleteServiceLevelObjectiveCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/GetServiceCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/GetServiceLevelObjectiveCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/ListServiceDependenciesCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/ListServiceDependentsCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/ListServiceLevelObjectivesCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/ListServiceOperationsCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/ListServicesCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/StartDiscoveryCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +36 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateServiceLevelObjectiveCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/index.d.ts +15 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +9 -0
- package/dist-types/ts3.4/models/ApplicationSignalsServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +390 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListServiceDependenciesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListServiceDependentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListServiceLevelObjectivesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListServiceOperationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListServicesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +6 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +185 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +87 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +81 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +23 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/package.json +101 -0
|
@@ -0,0 +1,148 @@
|
|
|
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 { BatchGetServiceLevelObjectiveBudgetReportInput, BatchGetServiceLevelObjectiveBudgetReportOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link BatchGetServiceLevelObjectiveBudgetReportCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface BatchGetServiceLevelObjectiveBudgetReportCommandInput extends BatchGetServiceLevelObjectiveBudgetReportInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link BatchGetServiceLevelObjectiveBudgetReportCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface BatchGetServiceLevelObjectiveBudgetReportCommandOutput extends BatchGetServiceLevelObjectiveBudgetReportOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const BatchGetServiceLevelObjectiveBudgetReportCommand_base: {
|
|
25
|
+
new (input: BatchGetServiceLevelObjectiveBudgetReportCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetServiceLevelObjectiveBudgetReportCommandInput, BatchGetServiceLevelObjectiveBudgetReportCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: BatchGetServiceLevelObjectiveBudgetReportCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetServiceLevelObjectiveBudgetReportCommandInput, BatchGetServiceLevelObjectiveBudgetReportCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
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 in unhealthy periods 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>
|
|
41
|
+
* @example
|
|
42
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
+
* ```javascript
|
|
44
|
+
* import { ApplicationSignalsClient, BatchGetServiceLevelObjectiveBudgetReportCommand } from "@aws-sdk/client-application-signals"; // ES Modules import
|
|
45
|
+
* // const { ApplicationSignalsClient, BatchGetServiceLevelObjectiveBudgetReportCommand } = require("@aws-sdk/client-application-signals"); // CommonJS import
|
|
46
|
+
* const client = new ApplicationSignalsClient(config);
|
|
47
|
+
* const input = { // BatchGetServiceLevelObjectiveBudgetReportInput
|
|
48
|
+
* Timestamp: new Date("TIMESTAMP"), // required
|
|
49
|
+
* SloIds: [ // ServiceLevelObjectiveIds // required
|
|
50
|
+
* "STRING_VALUE",
|
|
51
|
+
* ],
|
|
52
|
+
* };
|
|
53
|
+
* const command = new BatchGetServiceLevelObjectiveBudgetReportCommand(input);
|
|
54
|
+
* const response = await client.send(command);
|
|
55
|
+
* // { // BatchGetServiceLevelObjectiveBudgetReportOutput
|
|
56
|
+
* // Timestamp: new Date("TIMESTAMP"), // required
|
|
57
|
+
* // Reports: [ // ServiceLevelObjectiveBudgetReports // required
|
|
58
|
+
* // { // ServiceLevelObjectiveBudgetReport
|
|
59
|
+
* // Arn: "STRING_VALUE", // required
|
|
60
|
+
* // Name: "STRING_VALUE", // required
|
|
61
|
+
* // BudgetStatus: "OK" || "WARNING" || "BREACHED" || "INSUFFICIENT_DATA", // required
|
|
62
|
+
* // Attainment: Number("double"),
|
|
63
|
+
* // TotalBudgetSeconds: Number("int"),
|
|
64
|
+
* // BudgetSecondsRemaining: Number("int"),
|
|
65
|
+
* // Sli: { // ServiceLevelIndicator
|
|
66
|
+
* // SliMetric: { // ServiceLevelIndicatorMetric
|
|
67
|
+
* // KeyAttributes: { // Attributes
|
|
68
|
+
* // "<keys>": "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // OperationName: "STRING_VALUE",
|
|
71
|
+
* // MetricType: "LATENCY" || "AVAILABILITY",
|
|
72
|
+
* // MetricDataQueries: [ // MetricDataQueries // required
|
|
73
|
+
* // { // MetricDataQuery
|
|
74
|
+
* // Id: "STRING_VALUE", // required
|
|
75
|
+
* // MetricStat: { // MetricStat
|
|
76
|
+
* // Metric: { // Metric
|
|
77
|
+
* // Namespace: "STRING_VALUE",
|
|
78
|
+
* // MetricName: "STRING_VALUE",
|
|
79
|
+
* // Dimensions: [ // Dimensions
|
|
80
|
+
* // { // Dimension
|
|
81
|
+
* // Name: "STRING_VALUE", // required
|
|
82
|
+
* // Value: "STRING_VALUE", // required
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
85
|
+
* // },
|
|
86
|
+
* // Period: Number("int"), // required
|
|
87
|
+
* // Stat: "STRING_VALUE", // required
|
|
88
|
+
* // 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",
|
|
89
|
+
* // },
|
|
90
|
+
* // Expression: "STRING_VALUE",
|
|
91
|
+
* // Label: "STRING_VALUE",
|
|
92
|
+
* // ReturnData: true || false,
|
|
93
|
+
* // Period: Number("int"),
|
|
94
|
+
* // AccountId: "STRING_VALUE",
|
|
95
|
+
* // },
|
|
96
|
+
* // ],
|
|
97
|
+
* // },
|
|
98
|
+
* // MetricThreshold: Number("double"), // required
|
|
99
|
+
* // ComparisonOperator: "GreaterThanOrEqualTo" || "GreaterThan" || "LessThan" || "LessThanOrEqualTo", // required
|
|
100
|
+
* // },
|
|
101
|
+
* // Goal: { // Goal
|
|
102
|
+
* // Interval: { // Interval Union: only one key present
|
|
103
|
+
* // RollingInterval: { // RollingInterval
|
|
104
|
+
* // DurationUnit: "DAY" || "MONTH", // required
|
|
105
|
+
* // Duration: Number("int"), // required
|
|
106
|
+
* // },
|
|
107
|
+
* // CalendarInterval: { // CalendarInterval
|
|
108
|
+
* // StartTime: new Date("TIMESTAMP"), // required
|
|
109
|
+
* // DurationUnit: "DAY" || "MONTH", // required
|
|
110
|
+
* // Duration: Number("int"), // required
|
|
111
|
+
* // },
|
|
112
|
+
* // },
|
|
113
|
+
* // AttainmentGoal: Number("double"),
|
|
114
|
+
* // WarningThreshold: Number("double"),
|
|
115
|
+
* // },
|
|
116
|
+
* // },
|
|
117
|
+
* // ],
|
|
118
|
+
* // Errors: [ // ServiceLevelObjectiveBudgetReportErrors // required
|
|
119
|
+
* // { // ServiceLevelObjectiveBudgetReportError
|
|
120
|
+
* // Name: "STRING_VALUE", // required
|
|
121
|
+
* // Arn: "STRING_VALUE", // required
|
|
122
|
+
* // ErrorCode: "STRING_VALUE", // required
|
|
123
|
+
* // ErrorMessage: "STRING_VALUE", // required
|
|
124
|
+
* // },
|
|
125
|
+
* // ],
|
|
126
|
+
* // };
|
|
127
|
+
*
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
130
|
+
* @param BatchGetServiceLevelObjectiveBudgetReportCommandInput - {@link BatchGetServiceLevelObjectiveBudgetReportCommandInput}
|
|
131
|
+
* @returns {@link BatchGetServiceLevelObjectiveBudgetReportCommandOutput}
|
|
132
|
+
* @see {@link BatchGetServiceLevelObjectiveBudgetReportCommandInput} for command's `input` shape.
|
|
133
|
+
* @see {@link BatchGetServiceLevelObjectiveBudgetReportCommandOutput} for command's `response` shape.
|
|
134
|
+
* @see {@link ApplicationSignalsClientResolvedConfig | config} for ApplicationSignalsClient's `config` shape.
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
137
|
+
* <p>The request was throttled because of quota limits.</p>
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link ValidationException} (client fault)
|
|
140
|
+
* <p>The resource is not valid.</p>
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link ApplicationSignalsServiceException}
|
|
143
|
+
* <p>Base exception class for all service exceptions from ApplicationSignals service.</p>
|
|
144
|
+
*
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
export declare class BatchGetServiceLevelObjectiveBudgetReportCommand extends BatchGetServiceLevelObjectiveBudgetReportCommand_base {
|
|
148
|
+
}
|
|
@@ -0,0 +1,252 @@
|
|
|
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 { CreateServiceLevelObjectiveInput, CreateServiceLevelObjectiveOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateServiceLevelObjectiveCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateServiceLevelObjectiveCommandInput extends CreateServiceLevelObjectiveInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateServiceLevelObjectiveCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateServiceLevelObjectiveCommandOutput extends CreateServiceLevelObjectiveOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateServiceLevelObjectiveCommand_base: {
|
|
25
|
+
new (input: CreateServiceLevelObjectiveCommandInput): import("@smithy/smithy-client").CommandImpl<CreateServiceLevelObjectiveCommandInput, CreateServiceLevelObjectiveCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateServiceLevelObjectiveCommandInput): import("@smithy/smithy-client").CommandImpl<CreateServiceLevelObjectiveCommandInput, CreateServiceLevelObjectiveCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
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>When you create an SLO, you set an <i>attainment goal</i> for it. An
|
|
37
|
+
* <i>attainment goal</i> is the
|
|
38
|
+
* ratio of good periods that meet the threshold requirements to the total periods within the interval.
|
|
39
|
+
* For example, an attainment goal of 99.9% means that within your interval, you are targeting 99.9% of the
|
|
40
|
+
* periods to be in healthy state.</p>
|
|
41
|
+
* <p>After you have created an SLO, you can retrieve error budget reports for it.
|
|
42
|
+
* An <i>error budget</i> is the number of periods or amount of time that your service can
|
|
43
|
+
* accumulate during an interval before your overall SLO budget health is breached and the SLO is considered to be
|
|
44
|
+
* unmet. for example, an SLO with a threshold that 99.95% of requests must be completed under 2000ms every month
|
|
45
|
+
* translates to an error budget of 21.9 minutes of downtime per month.</p>
|
|
46
|
+
* <p>When you call this operation, Application Signals creates the <i>AWSServiceRoleForCloudWatchApplicationSignals</i> service-linked role,
|
|
47
|
+
* if it doesn't already exist in your account. This service-
|
|
48
|
+
* linked role has the following permissions:</p>
|
|
49
|
+
* <ul>
|
|
50
|
+
* <li>
|
|
51
|
+
* <p>
|
|
52
|
+
* <code>xray:GetServiceGraph</code>
|
|
53
|
+
* </p>
|
|
54
|
+
* </li>
|
|
55
|
+
* <li>
|
|
56
|
+
* <p>
|
|
57
|
+
* <code>logs:StartQuery</code>
|
|
58
|
+
* </p>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>
|
|
62
|
+
* <code>logs:GetQueryResults</code>
|
|
63
|
+
* </p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>
|
|
67
|
+
* <code>cloudwatch:GetMetricData</code>
|
|
68
|
+
* </p>
|
|
69
|
+
* </li>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>
|
|
72
|
+
* <code>cloudwatch:ListMetrics</code>
|
|
73
|
+
* </p>
|
|
74
|
+
* </li>
|
|
75
|
+
* <li>
|
|
76
|
+
* <p>
|
|
77
|
+
* <code>tag:GetResources</code>
|
|
78
|
+
* </p>
|
|
79
|
+
* </li>
|
|
80
|
+
* <li>
|
|
81
|
+
* <p>
|
|
82
|
+
* <code>autoscaling:DescribeAutoScalingGroups</code>
|
|
83
|
+
* </p>
|
|
84
|
+
* </li>
|
|
85
|
+
* </ul>
|
|
86
|
+
* <p>You can easily set SLO targets for your applications that are discovered by Application Signals, using critical metrics such as latency and availability.
|
|
87
|
+
* You can also set SLOs against any CloudWatch metric or math expression that produces a time series.</p>
|
|
88
|
+
* <p>For more information about SLOs, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-ServiceLevelObjectives.html">
|
|
89
|
+
* Service level objectives (SLOs)</a>.
|
|
90
|
+
* </p>
|
|
91
|
+
* @example
|
|
92
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
93
|
+
* ```javascript
|
|
94
|
+
* import { ApplicationSignalsClient, CreateServiceLevelObjectiveCommand } from "@aws-sdk/client-application-signals"; // ES Modules import
|
|
95
|
+
* // const { ApplicationSignalsClient, CreateServiceLevelObjectiveCommand } = require("@aws-sdk/client-application-signals"); // CommonJS import
|
|
96
|
+
* const client = new ApplicationSignalsClient(config);
|
|
97
|
+
* const input = { // CreateServiceLevelObjectiveInput
|
|
98
|
+
* Name: "STRING_VALUE", // required
|
|
99
|
+
* Description: "STRING_VALUE",
|
|
100
|
+
* SliConfig: { // ServiceLevelIndicatorConfig
|
|
101
|
+
* SliMetricConfig: { // ServiceLevelIndicatorMetricConfig
|
|
102
|
+
* KeyAttributes: { // Attributes
|
|
103
|
+
* "<keys>": "STRING_VALUE",
|
|
104
|
+
* },
|
|
105
|
+
* OperationName: "STRING_VALUE",
|
|
106
|
+
* MetricType: "LATENCY" || "AVAILABILITY",
|
|
107
|
+
* Statistic: "STRING_VALUE",
|
|
108
|
+
* PeriodSeconds: Number("int"),
|
|
109
|
+
* MetricDataQueries: [ // MetricDataQueries
|
|
110
|
+
* { // MetricDataQuery
|
|
111
|
+
* Id: "STRING_VALUE", // required
|
|
112
|
+
* MetricStat: { // MetricStat
|
|
113
|
+
* Metric: { // Metric
|
|
114
|
+
* Namespace: "STRING_VALUE",
|
|
115
|
+
* MetricName: "STRING_VALUE",
|
|
116
|
+
* Dimensions: [ // Dimensions
|
|
117
|
+
* { // Dimension
|
|
118
|
+
* Name: "STRING_VALUE", // required
|
|
119
|
+
* Value: "STRING_VALUE", // required
|
|
120
|
+
* },
|
|
121
|
+
* ],
|
|
122
|
+
* },
|
|
123
|
+
* Period: Number("int"), // required
|
|
124
|
+
* Stat: "STRING_VALUE", // required
|
|
125
|
+
* 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",
|
|
126
|
+
* },
|
|
127
|
+
* Expression: "STRING_VALUE",
|
|
128
|
+
* Label: "STRING_VALUE",
|
|
129
|
+
* ReturnData: true || false,
|
|
130
|
+
* Period: Number("int"),
|
|
131
|
+
* AccountId: "STRING_VALUE",
|
|
132
|
+
* },
|
|
133
|
+
* ],
|
|
134
|
+
* },
|
|
135
|
+
* MetricThreshold: Number("double"), // required
|
|
136
|
+
* ComparisonOperator: "GreaterThanOrEqualTo" || "GreaterThan" || "LessThan" || "LessThanOrEqualTo", // required
|
|
137
|
+
* },
|
|
138
|
+
* Goal: { // Goal
|
|
139
|
+
* Interval: { // Interval Union: only one key present
|
|
140
|
+
* RollingInterval: { // RollingInterval
|
|
141
|
+
* DurationUnit: "DAY" || "MONTH", // required
|
|
142
|
+
* Duration: Number("int"), // required
|
|
143
|
+
* },
|
|
144
|
+
* CalendarInterval: { // CalendarInterval
|
|
145
|
+
* StartTime: new Date("TIMESTAMP"), // required
|
|
146
|
+
* DurationUnit: "DAY" || "MONTH", // required
|
|
147
|
+
* Duration: Number("int"), // required
|
|
148
|
+
* },
|
|
149
|
+
* },
|
|
150
|
+
* AttainmentGoal: Number("double"),
|
|
151
|
+
* WarningThreshold: Number("double"),
|
|
152
|
+
* },
|
|
153
|
+
* Tags: [ // TagList
|
|
154
|
+
* { // Tag
|
|
155
|
+
* Key: "STRING_VALUE", // required
|
|
156
|
+
* Value: "STRING_VALUE", // required
|
|
157
|
+
* },
|
|
158
|
+
* ],
|
|
159
|
+
* };
|
|
160
|
+
* const command = new CreateServiceLevelObjectiveCommand(input);
|
|
161
|
+
* const response = await client.send(command);
|
|
162
|
+
* // { // CreateServiceLevelObjectiveOutput
|
|
163
|
+
* // Slo: { // ServiceLevelObjective
|
|
164
|
+
* // Arn: "STRING_VALUE", // required
|
|
165
|
+
* // Name: "STRING_VALUE", // required
|
|
166
|
+
* // Description: "STRING_VALUE",
|
|
167
|
+
* // CreatedTime: new Date("TIMESTAMP"), // required
|
|
168
|
+
* // LastUpdatedTime: new Date("TIMESTAMP"), // required
|
|
169
|
+
* // Sli: { // ServiceLevelIndicator
|
|
170
|
+
* // SliMetric: { // ServiceLevelIndicatorMetric
|
|
171
|
+
* // KeyAttributes: { // Attributes
|
|
172
|
+
* // "<keys>": "STRING_VALUE",
|
|
173
|
+
* // },
|
|
174
|
+
* // OperationName: "STRING_VALUE",
|
|
175
|
+
* // MetricType: "LATENCY" || "AVAILABILITY",
|
|
176
|
+
* // MetricDataQueries: [ // MetricDataQueries // required
|
|
177
|
+
* // { // MetricDataQuery
|
|
178
|
+
* // Id: "STRING_VALUE", // required
|
|
179
|
+
* // MetricStat: { // MetricStat
|
|
180
|
+
* // Metric: { // Metric
|
|
181
|
+
* // Namespace: "STRING_VALUE",
|
|
182
|
+
* // MetricName: "STRING_VALUE",
|
|
183
|
+
* // Dimensions: [ // Dimensions
|
|
184
|
+
* // { // Dimension
|
|
185
|
+
* // Name: "STRING_VALUE", // required
|
|
186
|
+
* // Value: "STRING_VALUE", // required
|
|
187
|
+
* // },
|
|
188
|
+
* // ],
|
|
189
|
+
* // },
|
|
190
|
+
* // Period: Number("int"), // required
|
|
191
|
+
* // Stat: "STRING_VALUE", // required
|
|
192
|
+
* // 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",
|
|
193
|
+
* // },
|
|
194
|
+
* // Expression: "STRING_VALUE",
|
|
195
|
+
* // Label: "STRING_VALUE",
|
|
196
|
+
* // ReturnData: true || false,
|
|
197
|
+
* // Period: Number("int"),
|
|
198
|
+
* // AccountId: "STRING_VALUE",
|
|
199
|
+
* // },
|
|
200
|
+
* // ],
|
|
201
|
+
* // },
|
|
202
|
+
* // MetricThreshold: Number("double"), // required
|
|
203
|
+
* // ComparisonOperator: "GreaterThanOrEqualTo" || "GreaterThan" || "LessThan" || "LessThanOrEqualTo", // required
|
|
204
|
+
* // },
|
|
205
|
+
* // Goal: { // Goal
|
|
206
|
+
* // Interval: { // Interval Union: only one key present
|
|
207
|
+
* // RollingInterval: { // RollingInterval
|
|
208
|
+
* // DurationUnit: "DAY" || "MONTH", // required
|
|
209
|
+
* // Duration: Number("int"), // required
|
|
210
|
+
* // },
|
|
211
|
+
* // CalendarInterval: { // CalendarInterval
|
|
212
|
+
* // StartTime: new Date("TIMESTAMP"), // required
|
|
213
|
+
* // DurationUnit: "DAY" || "MONTH", // required
|
|
214
|
+
* // Duration: Number("int"), // required
|
|
215
|
+
* // },
|
|
216
|
+
* // },
|
|
217
|
+
* // AttainmentGoal: Number("double"),
|
|
218
|
+
* // WarningThreshold: Number("double"),
|
|
219
|
+
* // },
|
|
220
|
+
* // },
|
|
221
|
+
* // };
|
|
222
|
+
*
|
|
223
|
+
* ```
|
|
224
|
+
*
|
|
225
|
+
* @param CreateServiceLevelObjectiveCommandInput - {@link CreateServiceLevelObjectiveCommandInput}
|
|
226
|
+
* @returns {@link CreateServiceLevelObjectiveCommandOutput}
|
|
227
|
+
* @see {@link CreateServiceLevelObjectiveCommandInput} for command's `input` shape.
|
|
228
|
+
* @see {@link CreateServiceLevelObjectiveCommandOutput} for command's `response` shape.
|
|
229
|
+
* @see {@link ApplicationSignalsClientResolvedConfig | config} for ApplicationSignalsClient's `config` shape.
|
|
230
|
+
*
|
|
231
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
232
|
+
* <p>You don't have sufficient permissions to perform this action.</p>
|
|
233
|
+
*
|
|
234
|
+
* @throws {@link ConflictException} (client fault)
|
|
235
|
+
* <p>This operation attempted to create a resource that already exists.</p>
|
|
236
|
+
*
|
|
237
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
238
|
+
* <p>This request exceeds a service quota.</p>
|
|
239
|
+
*
|
|
240
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
241
|
+
* <p>The request was throttled because of quota limits.</p>
|
|
242
|
+
*
|
|
243
|
+
* @throws {@link ValidationException} (client fault)
|
|
244
|
+
* <p>The resource is not valid.</p>
|
|
245
|
+
*
|
|
246
|
+
* @throws {@link ApplicationSignalsServiceException}
|
|
247
|
+
* <p>Base exception class for all service exceptions from ApplicationSignals service.</p>
|
|
248
|
+
*
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
export declare class CreateServiceLevelObjectiveCommand extends CreateServiceLevelObjectiveCommand_base {
|
|
252
|
+
}
|
|
@@ -0,0 +1,67 @@
|
|
|
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 { DeleteServiceLevelObjectiveInput, DeleteServiceLevelObjectiveOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteServiceLevelObjectiveCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteServiceLevelObjectiveCommandInput extends DeleteServiceLevelObjectiveInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteServiceLevelObjectiveCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteServiceLevelObjectiveCommandOutput extends DeleteServiceLevelObjectiveOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteServiceLevelObjectiveCommand_base: {
|
|
25
|
+
new (input: DeleteServiceLevelObjectiveCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteServiceLevelObjectiveCommandInput, DeleteServiceLevelObjectiveCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteServiceLevelObjectiveCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteServiceLevelObjectiveCommandInput, DeleteServiceLevelObjectiveCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Deletes the specified service level objective.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApplicationSignalsClient, DeleteServiceLevelObjectiveCommand } from "@aws-sdk/client-application-signals"; // ES Modules import
|
|
35
|
+
* // const { ApplicationSignalsClient, DeleteServiceLevelObjectiveCommand } = require("@aws-sdk/client-application-signals"); // CommonJS import
|
|
36
|
+
* const client = new ApplicationSignalsClient(config);
|
|
37
|
+
* const input = { // DeleteServiceLevelObjectiveInput
|
|
38
|
+
* Id: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteServiceLevelObjectiveCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // {};
|
|
43
|
+
*
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* @param DeleteServiceLevelObjectiveCommandInput - {@link DeleteServiceLevelObjectiveCommandInput}
|
|
47
|
+
* @returns {@link DeleteServiceLevelObjectiveCommandOutput}
|
|
48
|
+
* @see {@link DeleteServiceLevelObjectiveCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link DeleteServiceLevelObjectiveCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link ApplicationSignalsClientResolvedConfig | config} for ApplicationSignalsClient's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
53
|
+
* <p>Resource not found.</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
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export declare class DeleteServiceLevelObjectiveCommand extends DeleteServiceLevelObjectiveCommand_base {
|
|
67
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
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 { GetServiceInput, GetServiceOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetServiceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetServiceCommandInput extends GetServiceInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetServiceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetServiceCommandOutput extends GetServiceOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetServiceCommand_base: {
|
|
25
|
+
new (input: GetServiceCommandInput): import("@smithy/smithy-client").CommandImpl<GetServiceCommandInput, GetServiceCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetServiceCommandInput): import("@smithy/smithy-client").CommandImpl<GetServiceCommandInput, GetServiceCommandOutput, ApplicationSignalsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns information about a service discovered by Application Signals.</p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { ApplicationSignalsClient, GetServiceCommand } from "@aws-sdk/client-application-signals"; // ES Modules import
|
|
35
|
+
* // const { ApplicationSignalsClient, GetServiceCommand } = require("@aws-sdk/client-application-signals"); // CommonJS import
|
|
36
|
+
* const client = new ApplicationSignalsClient(config);
|
|
37
|
+
* const input = { // GetServiceInput
|
|
38
|
+
* StartTime: new Date("TIMESTAMP"), // required
|
|
39
|
+
* EndTime: new Date("TIMESTAMP"), // required
|
|
40
|
+
* KeyAttributes: { // Attributes // required
|
|
41
|
+
* "<keys>": "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* };
|
|
44
|
+
* const command = new GetServiceCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // GetServiceOutput
|
|
47
|
+
* // Service: { // Service
|
|
48
|
+
* // KeyAttributes: { // Attributes // required
|
|
49
|
+
* // "<keys>": "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // AttributeMaps: [ // AttributeMaps
|
|
52
|
+
* // { // AttributeMap
|
|
53
|
+
* // "<keys>": "STRING_VALUE",
|
|
54
|
+
* // },
|
|
55
|
+
* // ],
|
|
56
|
+
* // MetricReferences: [ // MetricReferences // required
|
|
57
|
+
* // { // MetricReference
|
|
58
|
+
* // Namespace: "STRING_VALUE", // required
|
|
59
|
+
* // MetricType: "STRING_VALUE", // required
|
|
60
|
+
* // Dimensions: [ // Dimensions
|
|
61
|
+
* // { // Dimension
|
|
62
|
+
* // Name: "STRING_VALUE", // required
|
|
63
|
+
* // Value: "STRING_VALUE", // required
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // MetricName: "STRING_VALUE", // required
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // },
|
|
70
|
+
* // StartTime: new Date("TIMESTAMP"), // required
|
|
71
|
+
* // EndTime: new Date("TIMESTAMP"), // required
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
74
|
+
* ```
|
|
75
|
+
*
|
|
76
|
+
* @param GetServiceCommandInput - {@link GetServiceCommandInput}
|
|
77
|
+
* @returns {@link GetServiceCommandOutput}
|
|
78
|
+
* @see {@link GetServiceCommandInput} for command's `input` shape.
|
|
79
|
+
* @see {@link GetServiceCommandOutput} for command's `response` shape.
|
|
80
|
+
* @see {@link ApplicationSignalsClientResolvedConfig | config} for ApplicationSignalsClient's `config` shape.
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
83
|
+
* <p>The request was throttled because of quota limits.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ValidationException} (client fault)
|
|
86
|
+
* <p>The resource is not valid.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ApplicationSignalsServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from ApplicationSignals service.</p>
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class GetServiceCommand extends GetServiceCommand_base {
|
|
94
|
+
}
|