@aws-sdk/client-devops-guru 3.41.0 → 3.45.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/CHANGELOG.md +41 -0
- package/README.md +14 -16
- package/dist-cjs/DevOpsGuru.js +75 -0
- package/dist-cjs/commands/DescribeOrganizationHealthCommand.js +36 -0
- package/dist-cjs/commands/DescribeOrganizationOverviewCommand.js +36 -0
- package/dist-cjs/commands/DescribeOrganizationResourceCollectionHealthCommand.js +36 -0
- package/dist-cjs/commands/ListOrganizationInsightsCommand.js +36 -0
- package/dist-cjs/commands/SearchOrganizationInsightsCommand.js +36 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/models/models_0.js +220 -12
- package/dist-cjs/pagination/DescribeOrganizationResourceCollectionHealthPaginator.js +34 -0
- package/dist-cjs/pagination/ListOrganizationInsightsPaginator.js +35 -0
- package/dist-cjs/pagination/SearchOrganizationInsightsPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1339 -208
- package/dist-es/DevOpsGuru.js +75 -0
- package/dist-es/commands/DescribeOrganizationHealthCommand.js +39 -0
- package/dist-es/commands/DescribeOrganizationOverviewCommand.js +39 -0
- package/dist-es/commands/DescribeOrganizationResourceCollectionHealthCommand.js +39 -0
- package/dist-es/commands/ListOrganizationInsightsCommand.js +39 -0
- package/dist-es/commands/SearchOrganizationInsightsCommand.js +39 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/endpoints.js +1 -0
- package/dist-es/models/models_0.js +154 -9
- package/dist-es/pagination/DescribeOrganizationResourceCollectionHealthPaginator.js +73 -0
- package/dist-es/pagination/ListOrganizationInsightsPaginator.js +74 -0
- package/dist-es/pagination/SearchOrganizationInsightsPaginator.js +74 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +1284 -111
- package/dist-types/DevOpsGuru.d.ts +117 -92
- package/dist-types/DevOpsGuruClient.d.ts +19 -16
- package/dist-types/commands/AddNotificationChannelCommand.d.ts +4 -6
- package/dist-types/commands/DescribeAccountHealthCommand.d.ts +3 -4
- package/dist-types/commands/DescribeAccountOverviewCommand.d.ts +3 -4
- package/dist-types/commands/DescribeAnomalyCommand.d.ts +1 -3
- package/dist-types/commands/DescribeFeedbackCommand.d.ts +1 -2
- package/dist-types/commands/DescribeInsightCommand.d.ts +1 -3
- package/dist-types/commands/DescribeOrganizationHealthCommand.d.ts +36 -0
- package/dist-types/commands/DescribeOrganizationOverviewCommand.d.ts +36 -0
- package/dist-types/commands/DescribeOrganizationResourceCollectionHealthCommand.d.ts +37 -0
- package/dist-types/commands/DescribeResourceCollectionHealthCommand.d.ts +5 -5
- package/dist-types/commands/DescribeServiceIntegrationCommand.d.ts +2 -4
- package/dist-types/commands/GetCostEstimationCommand.d.ts +1 -1
- package/dist-types/commands/GetResourceCollectionCommand.d.ts +4 -4
- package/dist-types/commands/ListAnomaliesForInsightCommand.d.ts +2 -3
- package/dist-types/commands/ListEventsCommand.d.ts +2 -3
- package/dist-types/commands/ListInsightsCommand.d.ts +3 -4
- package/dist-types/commands/ListNotificationChannelsCommand.d.ts +4 -5
- package/dist-types/commands/ListOrganizationInsightsCommand.d.ts +35 -0
- package/dist-types/commands/ListRecommendationsCommand.d.ts +2 -3
- package/dist-types/commands/PutFeedbackCommand.d.ts +1 -3
- package/dist-types/commands/RemoveNotificationChannelCommand.d.ts +3 -4
- package/dist-types/commands/SearchInsightsCommand.d.ts +8 -9
- package/dist-types/commands/SearchOrganizationInsightsCommand.d.ts +42 -0
- package/dist-types/commands/StartCostEstimationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateResourceCollectionCommand.d.ts +4 -3
- package/dist-types/commands/UpdateServiceIntegrationCommand.d.ts +3 -4
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +2078 -886
- package/dist-types/pagination/DescribeOrganizationResourceCollectionHealthPaginator.d.ts +4 -0
- package/dist-types/pagination/ListOrganizationInsightsPaginator.d.ts +4 -0
- package/dist-types/pagination/SearchOrganizationInsightsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +15 -0
- package/dist-types/ts3.4/DevOpsGuru.d.ts +25 -0
- package/dist-types/ts3.4/DevOpsGuruClient.d.ts +7 -2
- package/dist-types/ts3.4/commands/DescribeOrganizationHealthCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeOrganizationOverviewCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeOrganizationResourceCollectionHealthCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListOrganizationInsightsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/SearchOrganizationInsightsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +490 -7
- package/dist-types/ts3.4/pagination/DescribeOrganizationResourceCollectionHealthPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListOrganizationInsightsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/SearchOrganizationInsightsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +15 -0
- package/package.json +5 -5
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
2
|
/**
|
|
3
|
-
* <p> You don't have permissions to perform the requested operation. The user or role that
|
|
4
|
-
* least one IAM permissions policy attached that grants
|
|
5
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the
|
|
3
|
+
* <p> You don't have permissions to perform the requested operation. The user or role that
|
|
4
|
+
* is making the request must have at least one IAM permissions policy attached that grants
|
|
5
|
+
* the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the
|
|
6
|
+
* <i>IAM User Guide</i>. </p>
|
|
6
7
|
*/
|
|
7
8
|
export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
|
|
8
9
|
name: "AccessDeniedException";
|
|
@@ -15,16 +16,60 @@ export declare namespace AccessDeniedException {
|
|
|
15
16
|
*/
|
|
16
17
|
const filterSensitiveLog: (obj: AccessDeniedException) => any;
|
|
17
18
|
}
|
|
19
|
+
/**
|
|
20
|
+
* <p> Information about the number of open reactive and proactive insights that can be used
|
|
21
|
+
* to gauge the health of your system. </p>
|
|
22
|
+
*/
|
|
23
|
+
export interface AccountInsightHealth {
|
|
24
|
+
/**
|
|
25
|
+
* <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
|
|
26
|
+
* account.</p>
|
|
27
|
+
*/
|
|
28
|
+
OpenProactiveInsights?: number;
|
|
29
|
+
/**
|
|
30
|
+
* <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
|
|
31
|
+
* account.</p>
|
|
32
|
+
*/
|
|
33
|
+
OpenReactiveInsights?: number;
|
|
34
|
+
}
|
|
35
|
+
export declare namespace AccountInsightHealth {
|
|
36
|
+
/**
|
|
37
|
+
* @internal
|
|
38
|
+
*/
|
|
39
|
+
const filterSensitiveLog: (obj: AccountInsightHealth) => any;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* <p> Returns the number of open reactive insights, the number of open proactive insights,
|
|
43
|
+
* and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the
|
|
44
|
+
* health of operations in your Amazon Web Services account. </p>
|
|
45
|
+
*/
|
|
46
|
+
export interface AccountHealth {
|
|
47
|
+
/**
|
|
48
|
+
* <p>The ID of the Amazon Web Services account. </p>
|
|
49
|
+
*/
|
|
50
|
+
AccountId?: string;
|
|
51
|
+
/**
|
|
52
|
+
* <p> Information about the health of the Amazon Web Services resources in your account, including the
|
|
53
|
+
* number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.
|
|
54
|
+
* </p>
|
|
55
|
+
*/
|
|
56
|
+
Insight?: AccountInsightHealth;
|
|
57
|
+
}
|
|
58
|
+
export declare namespace AccountHealth {
|
|
59
|
+
/**
|
|
60
|
+
* @internal
|
|
61
|
+
*/
|
|
62
|
+
const filterSensitiveLog: (obj: AccountHealth) => any;
|
|
63
|
+
}
|
|
18
64
|
/**
|
|
19
65
|
* <p> Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic. </p>
|
|
20
|
-
*
|
|
21
|
-
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission
|
|
66
|
+
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission
|
|
22
67
|
* to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account.
|
|
23
68
|
* For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html">Permissions
|
|
24
69
|
* for cross account Amazon SNS topics</a>.</p>
|
|
25
|
-
* <p>If you use an Amazon SNS topic that is encrypted by an
|
|
70
|
+
* <p>If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions
|
|
26
71
|
* to the CMK. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html">Permissions for
|
|
27
|
-
*
|
|
72
|
+
* Amazon Web Services KMS–encrypted Amazon SNS topics</a>.</p>
|
|
28
73
|
*/
|
|
29
74
|
export interface SnsChannelConfig {
|
|
30
75
|
/**
|
|
@@ -45,17 +90,15 @@ export declare namespace SnsChannelConfig {
|
|
|
45
90
|
*/
|
|
46
91
|
export interface NotificationChannelConfig {
|
|
47
92
|
/**
|
|
48
|
-
* <p>
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission
|
|
93
|
+
* <p> Information about a notification channel configured in DevOps Guru to send notifications
|
|
94
|
+
* when insights are created. </p>
|
|
95
|
+
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission
|
|
53
96
|
* to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account.
|
|
54
97
|
* For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html">Permissions
|
|
55
98
|
* for cross account Amazon SNS topics</a>.</p>
|
|
56
|
-
* <p>If you use an Amazon SNS topic that is encrypted by an
|
|
99
|
+
* <p>If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions
|
|
57
100
|
* to the CMK. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html">Permissions for
|
|
58
|
-
*
|
|
101
|
+
* Amazon Web Services KMS–encrypted Amazon SNS topics</a>.</p>
|
|
59
102
|
*/
|
|
60
103
|
Sns: SnsChannelConfig | undefined;
|
|
61
104
|
}
|
|
@@ -68,7 +111,7 @@ export declare namespace NotificationChannelConfig {
|
|
|
68
111
|
export interface AddNotificationChannelRequest {
|
|
69
112
|
/**
|
|
70
113
|
* <p> A <code>NotificationChannelConfig</code> object that specifies what type of
|
|
71
|
-
*
|
|
114
|
+
* notification channel to add. The one
|
|
72
115
|
* supported notification channel is Amazon Simple Notification Service (Amazon SNS). </p>
|
|
73
116
|
*/
|
|
74
117
|
Config: NotificationChannelConfig | undefined;
|
|
@@ -81,9 +124,7 @@ export declare namespace AddNotificationChannelRequest {
|
|
|
81
124
|
}
|
|
82
125
|
export interface AddNotificationChannelResponse {
|
|
83
126
|
/**
|
|
84
|
-
* <p>
|
|
85
|
-
* The ID of the added notification channel.
|
|
86
|
-
* </p>
|
|
127
|
+
* <p> The ID of the added notification channel. </p>
|
|
87
128
|
*/
|
|
88
129
|
Id: string | undefined;
|
|
89
130
|
}
|
|
@@ -94,24 +135,18 @@ export declare namespace AddNotificationChannelResponse {
|
|
|
94
135
|
const filterSensitiveLog: (obj: AddNotificationChannelResponse) => any;
|
|
95
136
|
}
|
|
96
137
|
/**
|
|
97
|
-
* <p>
|
|
98
|
-
* An exception that is thrown when a conflict occurs.
|
|
99
|
-
* </p>
|
|
138
|
+
* <p> An exception that is thrown when a conflict occurs. </p>
|
|
100
139
|
*/
|
|
101
140
|
export interface ConflictException extends __SmithyException, $MetadataBearer {
|
|
102
141
|
name: "ConflictException";
|
|
103
142
|
$fault: "client";
|
|
104
143
|
Message: string | undefined;
|
|
105
144
|
/**
|
|
106
|
-
* <p>
|
|
107
|
-
* The ID of the AWS resource in which a conflict occurred.
|
|
108
|
-
* </p>
|
|
145
|
+
* <p> The ID of the Amazon Web Services resource in which a conflict occurred. </p>
|
|
109
146
|
*/
|
|
110
147
|
ResourceId: string | undefined;
|
|
111
148
|
/**
|
|
112
|
-
* <p>
|
|
113
|
-
* The type of the AWS resource in which a conflict occurred.
|
|
114
|
-
* </p>
|
|
149
|
+
* <p> The type of the Amazon Web Services resource in which a conflict occurred. </p>
|
|
115
150
|
*/
|
|
116
151
|
ResourceType: string | undefined;
|
|
117
152
|
}
|
|
@@ -129,10 +164,8 @@ export interface InternalServerException extends __SmithyException, $MetadataBea
|
|
|
129
164
|
$fault: "server";
|
|
130
165
|
Message: string | undefined;
|
|
131
166
|
/**
|
|
132
|
-
* <p>
|
|
133
|
-
*
|
|
134
|
-
* exception can be retried.
|
|
135
|
-
* </p>
|
|
167
|
+
* <p> The number of seconds after which the action that caused the internal server
|
|
168
|
+
* exception can be retried. </p>
|
|
136
169
|
*/
|
|
137
170
|
RetryAfterSeconds?: number;
|
|
138
171
|
}
|
|
@@ -150,15 +183,11 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
|
|
|
150
183
|
$fault: "client";
|
|
151
184
|
Message: string | undefined;
|
|
152
185
|
/**
|
|
153
|
-
* <p>
|
|
154
|
-
* The ID of the AWS resource that could not be found.
|
|
155
|
-
* </p>
|
|
186
|
+
* <p> The ID of the Amazon Web Services resource that could not be found. </p>
|
|
156
187
|
*/
|
|
157
188
|
ResourceId: string | undefined;
|
|
158
189
|
/**
|
|
159
|
-
* <p>
|
|
160
|
-
* The type of the AWS resource that could not be found.
|
|
161
|
-
* </p>
|
|
190
|
+
* <p> The type of the Amazon Web Services resource that could not be found. </p>
|
|
162
191
|
*/
|
|
163
192
|
ResourceType: string | undefined;
|
|
164
193
|
}
|
|
@@ -190,22 +219,16 @@ export interface ThrottlingException extends __SmithyException, $MetadataBearer
|
|
|
190
219
|
$fault: "client";
|
|
191
220
|
Message: string | undefined;
|
|
192
221
|
/**
|
|
193
|
-
* <p>
|
|
194
|
-
* The code of the quota that was exceeded, causing the throttling exception.
|
|
195
|
-
* </p>
|
|
222
|
+
* <p> The code of the quota that was exceeded, causing the throttling exception. </p>
|
|
196
223
|
*/
|
|
197
224
|
QuotaCode?: string;
|
|
198
225
|
/**
|
|
199
|
-
* <p>
|
|
200
|
-
* The code of the service that caused the throttling exception.
|
|
201
|
-
* </p>
|
|
226
|
+
* <p> The code of the service that caused the throttling exception. </p>
|
|
202
227
|
*/
|
|
203
228
|
ServiceCode?: string;
|
|
204
229
|
/**
|
|
205
|
-
* <p>
|
|
206
|
-
*
|
|
207
|
-
* exception can be retried.
|
|
208
|
-
* </p>
|
|
230
|
+
* <p> The number of seconds after which the action that caused the throttling exception can
|
|
231
|
+
* be retried. </p>
|
|
209
232
|
*/
|
|
210
233
|
RetryAfterSeconds?: number;
|
|
211
234
|
}
|
|
@@ -216,22 +239,16 @@ export declare namespace ThrottlingException {
|
|
|
216
239
|
const filterSensitiveLog: (obj: ThrottlingException) => any;
|
|
217
240
|
}
|
|
218
241
|
/**
|
|
219
|
-
* <p>
|
|
220
|
-
* The field associated with the validation exception.
|
|
221
|
-
* </p>
|
|
242
|
+
* <p> The field associated with the validation exception. </p>
|
|
222
243
|
*/
|
|
223
244
|
export interface ValidationExceptionField {
|
|
224
245
|
/**
|
|
225
|
-
* <p>
|
|
226
|
-
* The name of the field.
|
|
227
|
-
* </p>
|
|
246
|
+
* <p> The name of the field. </p>
|
|
228
247
|
*/
|
|
229
248
|
Name: string | undefined;
|
|
230
249
|
/**
|
|
231
|
-
* <p>
|
|
232
|
-
*
|
|
233
|
-
* determine its cause.
|
|
234
|
-
* </p>
|
|
250
|
+
* <p> The message associated with the validation exception with information to help
|
|
251
|
+
* determine its cause. </p>
|
|
235
252
|
*/
|
|
236
253
|
Message: string | undefined;
|
|
237
254
|
}
|
|
@@ -244,33 +261,28 @@ export declare namespace ValidationExceptionField {
|
|
|
244
261
|
export declare enum ValidationExceptionReason {
|
|
245
262
|
CANNOT_PARSE = "CANNOT_PARSE",
|
|
246
263
|
FIELD_VALIDATION_FAILED = "FIELD_VALIDATION_FAILED",
|
|
264
|
+
INVALID_PARAMETER_COMBINATION = "INVALID_PARAMETER_COMBINATION",
|
|
247
265
|
OTHER = "OTHER",
|
|
266
|
+
PARAMETER_INCONSISTENT_WITH_SERVICE_STATE = "PARAMETER_INCONSISTENT_WITH_SERVICE_STATE",
|
|
248
267
|
UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
|
|
249
268
|
}
|
|
250
269
|
/**
|
|
251
|
-
* <p>
|
|
252
|
-
*
|
|
253
|
-
* </p>
|
|
270
|
+
* <p> Contains information about data passed in to a field during a request that is not
|
|
271
|
+
* valid. </p>
|
|
254
272
|
*/
|
|
255
273
|
export interface ValidationException extends __SmithyException, $MetadataBearer {
|
|
256
274
|
name: "ValidationException";
|
|
257
275
|
$fault: "client";
|
|
258
276
|
/**
|
|
259
|
-
* <p>
|
|
260
|
-
* A message that describes the validation exception.
|
|
261
|
-
* </p>
|
|
277
|
+
* <p> A message that describes the validation exception. </p>
|
|
262
278
|
*/
|
|
263
279
|
Message: string | undefined;
|
|
264
280
|
/**
|
|
265
|
-
* <p>
|
|
266
|
-
* The reason the validation exception was thrown.
|
|
267
|
-
* </p>
|
|
281
|
+
* <p> The reason the validation exception was thrown. </p>
|
|
268
282
|
*/
|
|
269
283
|
Reason?: ValidationExceptionReason | string;
|
|
270
284
|
/**
|
|
271
|
-
* <p>
|
|
272
|
-
* An array of fields that are associated with the validation exception.
|
|
273
|
-
* </p>
|
|
285
|
+
* <p> An array of fields that are associated with the validation exception. </p>
|
|
274
286
|
*/
|
|
275
287
|
Fields?: ValidationExceptionField[];
|
|
276
288
|
}
|
|
@@ -281,23 +293,17 @@ export declare namespace ValidationException {
|
|
|
281
293
|
const filterSensitiveLog: (obj: ValidationException) => any;
|
|
282
294
|
}
|
|
283
295
|
/**
|
|
284
|
-
* <p>
|
|
285
|
-
*
|
|
286
|
-
*
|
|
287
|
-
* the anomalous behavior.
|
|
288
|
-
* </p>
|
|
296
|
+
* <p> A time range that specifies when DevOps Guru opens and then closes an anomaly. This
|
|
297
|
+
* is different from <code>AnomalyTimeRange</code>, which specifies the time range when
|
|
298
|
+
* DevOps Guru actually observes the anomalous behavior. </p>
|
|
289
299
|
*/
|
|
290
300
|
export interface AnomalyReportedTimeRange {
|
|
291
301
|
/**
|
|
292
|
-
* <p>
|
|
293
|
-
* The time when an anomaly is opened.
|
|
294
|
-
* </p>
|
|
302
|
+
* <p> The time when an anomaly is opened. </p>
|
|
295
303
|
*/
|
|
296
304
|
OpenTime: Date | undefined;
|
|
297
305
|
/**
|
|
298
|
-
* <p>
|
|
299
|
-
* The time when an anomaly is closed.
|
|
300
|
-
* </p>
|
|
306
|
+
* <p> The time when an anomaly is closed. </p>
|
|
301
307
|
*/
|
|
302
308
|
CloseTime?: Date;
|
|
303
309
|
}
|
|
@@ -307,28 +313,46 @@ export declare namespace AnomalyReportedTimeRange {
|
|
|
307
313
|
*/
|
|
308
314
|
const filterSensitiveLog: (obj: AnomalyReportedTimeRange) => any;
|
|
309
315
|
}
|
|
316
|
+
/**
|
|
317
|
+
* <p>The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in
|
|
318
|
+
* the generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates
|
|
319
|
+
* and insight with details about the anomalous behavior and suggestions about how to correct the
|
|
320
|
+
* problem.</p>
|
|
321
|
+
*/
|
|
322
|
+
export interface AnomalyResource {
|
|
323
|
+
/**
|
|
324
|
+
* <p>The name of the Amazon Web Services resource.</p>
|
|
325
|
+
*/
|
|
326
|
+
Name?: string;
|
|
327
|
+
/**
|
|
328
|
+
* <p>The type of the Amazon Web Services resource.</p>
|
|
329
|
+
*/
|
|
330
|
+
Type?: string;
|
|
331
|
+
}
|
|
332
|
+
export declare namespace AnomalyResource {
|
|
333
|
+
/**
|
|
334
|
+
* @internal
|
|
335
|
+
*/
|
|
336
|
+
const filterSensitiveLog: (obj: AnomalyResource) => any;
|
|
337
|
+
}
|
|
310
338
|
export declare enum AnomalySeverity {
|
|
311
339
|
HIGH = "HIGH",
|
|
312
340
|
LOW = "LOW",
|
|
313
341
|
MEDIUM = "MEDIUM"
|
|
314
342
|
}
|
|
315
343
|
/**
|
|
316
|
-
* <p> The dimension of
|
|
317
|
-
* account for operational problems and anomalous behavior. A dimension is a
|
|
318
|
-
* that is part of the identity of a metric. A metric can have up to 10
|
|
319
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension">Dimensions</a> in the <i>Amazon CloudWatch User Guide</i>. </p>
|
|
344
|
+
* <p> The dimension of am Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in
|
|
345
|
+
* your account for operational problems and anomalous behavior. A dimension is a
|
|
346
|
+
* name/value pair that is part of the identity of a metric. A metric can have up to 10
|
|
347
|
+
* dimensions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension">Dimensions</a> in the <i>Amazon CloudWatch User Guide</i>. </p>
|
|
320
348
|
*/
|
|
321
349
|
export interface CloudWatchMetricsDimension {
|
|
322
350
|
/**
|
|
323
|
-
* <p>
|
|
324
|
-
* The name of the CloudWatch dimension.
|
|
325
|
-
* </p>
|
|
351
|
+
* <p> The name of the CloudWatch dimension. </p>
|
|
326
352
|
*/
|
|
327
353
|
Name?: string;
|
|
328
354
|
/**
|
|
329
|
-
* <p>
|
|
330
|
-
* The value of the CloudWatch dimension.
|
|
331
|
-
* </p>
|
|
355
|
+
* <p> The value of the CloudWatch dimension. </p>
|
|
332
356
|
*/
|
|
333
357
|
Value?: string;
|
|
334
358
|
}
|
|
@@ -338,6 +362,51 @@ export declare namespace CloudWatchMetricsDimension {
|
|
|
338
362
|
*/
|
|
339
363
|
const filterSensitiveLog: (obj: CloudWatchMetricsDimension) => any;
|
|
340
364
|
}
|
|
365
|
+
export declare enum CloudWatchMetricDataStatusCode {
|
|
366
|
+
COMPLETE = "Complete",
|
|
367
|
+
INTERNAL_ERROR = "InternalError",
|
|
368
|
+
PARTIAL_DATA = "PartialData"
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* <p>A pair that contains metric values at the respective timestamp.</p>
|
|
372
|
+
*/
|
|
373
|
+
export interface TimestampMetricValuePair {
|
|
374
|
+
/**
|
|
375
|
+
* <p>A <code>Timestamp</code> that specifies the time the event occurred. </p>
|
|
376
|
+
*/
|
|
377
|
+
Timestamp?: Date;
|
|
378
|
+
/**
|
|
379
|
+
* <p>Value of the anomalous metric data point at respective Timestamp.</p>
|
|
380
|
+
*/
|
|
381
|
+
MetricValue?: number;
|
|
382
|
+
}
|
|
383
|
+
export declare namespace TimestampMetricValuePair {
|
|
384
|
+
/**
|
|
385
|
+
* @internal
|
|
386
|
+
*/
|
|
387
|
+
const filterSensitiveLog: (obj: TimestampMetricValuePair) => any;
|
|
388
|
+
}
|
|
389
|
+
/**
|
|
390
|
+
* <p>Contains information about the analyzed metrics that displayed anomalous behavior.
|
|
391
|
+
* </p>
|
|
392
|
+
*/
|
|
393
|
+
export interface CloudWatchMetricsDataSummary {
|
|
394
|
+
/**
|
|
395
|
+
* <p>This is a list of Amazon CloudWatch metric values at given timestamp.</p>
|
|
396
|
+
*/
|
|
397
|
+
TimestampMetricValuePairList?: TimestampMetricValuePair[];
|
|
398
|
+
/**
|
|
399
|
+
* <p>This is an enum of the status showing whether the metric value pair list has partial or
|
|
400
|
+
* complete data, or if there was an error.</p>
|
|
401
|
+
*/
|
|
402
|
+
StatusCode?: CloudWatchMetricDataStatusCode | string;
|
|
403
|
+
}
|
|
404
|
+
export declare namespace CloudWatchMetricsDataSummary {
|
|
405
|
+
/**
|
|
406
|
+
* @internal
|
|
407
|
+
*/
|
|
408
|
+
const filterSensitiveLog: (obj: CloudWatchMetricsDataSummary) => any;
|
|
409
|
+
}
|
|
341
410
|
export declare enum CloudWatchMetricsStat {
|
|
342
411
|
AVERAGE = "Average",
|
|
343
412
|
MAXIMUM = "Maximum",
|
|
@@ -349,50 +418,40 @@ export declare enum CloudWatchMetricsStat {
|
|
|
349
418
|
SUM = "Sum"
|
|
350
419
|
}
|
|
351
420
|
/**
|
|
352
|
-
* <p>
|
|
353
|
-
* Information about an Amazon CloudWatch metric.
|
|
354
|
-
* </p>
|
|
421
|
+
* <p> Information about an Amazon CloudWatch metric. </p>
|
|
355
422
|
*/
|
|
356
423
|
export interface CloudWatchMetricsDetail {
|
|
357
424
|
/**
|
|
358
|
-
* <p>
|
|
359
|
-
* The name of the CloudWatch metric.
|
|
360
|
-
* </p>
|
|
425
|
+
* <p> The name of the CloudWatch metric. </p>
|
|
361
426
|
*/
|
|
362
427
|
MetricName?: string;
|
|
363
428
|
/**
|
|
364
|
-
* <p>
|
|
365
|
-
* The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
|
|
429
|
+
* <p> The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
|
|
366
430
|
* </p>
|
|
367
431
|
*/
|
|
368
432
|
Namespace?: string;
|
|
369
433
|
/**
|
|
370
|
-
* <p>
|
|
371
|
-
* An array of CloudWatch dimensions associated with
|
|
372
|
-
* </p>
|
|
434
|
+
* <p> An array of CloudWatch dimensions associated with </p>
|
|
373
435
|
*/
|
|
374
436
|
Dimensions?: CloudWatchMetricsDimension[];
|
|
375
437
|
/**
|
|
376
|
-
* <p>
|
|
377
|
-
*
|
|
378
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic">Statistics</a> in the
|
|
379
|
-
* <i>Amazon CloudWatch User Guide</i>.
|
|
380
|
-
* </p>
|
|
438
|
+
* <p> The type of statistic associated with the CloudWatch metric. For more information, see
|
|
439
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic">Statistics</a> in the <i>Amazon CloudWatch User Guide</i>. </p>
|
|
381
440
|
*/
|
|
382
441
|
Stat?: CloudWatchMetricsStat | string;
|
|
383
442
|
/**
|
|
384
|
-
* <p>
|
|
385
|
-
*
|
|
386
|
-
* <code>Count</code>, and <code>Percent</code>.
|
|
387
|
-
* </p>
|
|
443
|
+
* <p> The unit of measure used for the CloudWatch metric. For example, <code>Bytes</code>,
|
|
444
|
+
* <code>Seconds</code>, <code>Count</code>, and <code>Percent</code>. </p>
|
|
388
445
|
*/
|
|
389
446
|
Unit?: string;
|
|
390
447
|
/**
|
|
391
|
-
* <p>
|
|
392
|
-
* The length of time associated with the CloudWatch metric in number of seconds.
|
|
393
|
-
* </p>
|
|
448
|
+
* <p> The length of time associated with the CloudWatch metric in number of seconds. </p>
|
|
394
449
|
*/
|
|
395
450
|
Period?: number;
|
|
451
|
+
/**
|
|
452
|
+
* <p>This object returns anomaly metric data.</p>
|
|
453
|
+
*/
|
|
454
|
+
MetricDataSummary?: CloudWatchMetricsDataSummary;
|
|
396
455
|
}
|
|
397
456
|
export declare namespace CloudWatchMetricsDetail {
|
|
398
457
|
/**
|
|
@@ -401,15 +460,428 @@ export declare namespace CloudWatchMetricsDetail {
|
|
|
401
460
|
const filterSensitiveLog: (obj: CloudWatchMetricsDetail) => any;
|
|
402
461
|
}
|
|
403
462
|
/**
|
|
404
|
-
* <p>
|
|
405
|
-
*
|
|
463
|
+
* <p>A logical grouping of Performance Insights metrics for a related subject area. For example, the
|
|
464
|
+
* <code>db.sql</code> dimension group consists of the following dimensions:
|
|
465
|
+
* <code>db.sql.id</code>, <code>db.sql.db_id</code>, <code>db.sql.statement</code>, and
|
|
466
|
+
* <code>db.sql.tokenized_id</code>.</p>
|
|
467
|
+
* <note>
|
|
468
|
+
* <p>Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements,
|
|
469
|
+
* only the first 500 bytes are returned.</p>
|
|
470
|
+
* </note>
|
|
471
|
+
*
|
|
472
|
+
* <p>Amazon RDS Performance Insights enables you to monitor and explore different
|
|
473
|
+
* dimensions of database load based on data captured from a running DB instance.
|
|
474
|
+
* DB load is measured as average active sessions. Performance Insights provides the
|
|
475
|
+
* data to API consumers as a two-dimensional time-series dataset. The time dimension
|
|
476
|
+
* provides DB load data for each time point in the queried time range. Each time point
|
|
477
|
+
* decomposes overall load in relation to the requested dimensions, measured at that
|
|
478
|
+
* time point. Examples include SQL, Wait event, User, and Host. </p>
|
|
479
|
+
*
|
|
480
|
+
* <ul>
|
|
481
|
+
* <li>
|
|
482
|
+
* <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>.
|
|
483
|
+
* </p>
|
|
484
|
+
* </li>
|
|
485
|
+
* <li>
|
|
486
|
+
* <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>.
|
|
487
|
+
* </p>
|
|
488
|
+
* </li>
|
|
489
|
+
* </ul>
|
|
490
|
+
*/
|
|
491
|
+
export interface PerformanceInsightsMetricDimensionGroup {
|
|
492
|
+
/**
|
|
493
|
+
* <p>The name of the dimension group. Its valid values are:</p>
|
|
494
|
+
*
|
|
495
|
+
* <ul>
|
|
496
|
+
* <li>
|
|
497
|
+
* <p>
|
|
498
|
+
* <code>db</code> - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL,
|
|
499
|
+
* Aurora MySQL, Amazon RDS MySQL, and MariaDB)</p>
|
|
500
|
+
* </li>
|
|
501
|
+
* <li>
|
|
502
|
+
* <p>
|
|
503
|
+
* <code>db.application</code> - The name of the application that is connected to the database (only Aurora
|
|
504
|
+
* PostgreSQL and RDS PostgreSQL)</p>
|
|
505
|
+
* </li>
|
|
506
|
+
* <li>
|
|
507
|
+
* <p>
|
|
508
|
+
* <code>db.host</code> - The host name of the connected client (all engines)</p>
|
|
509
|
+
* </li>
|
|
510
|
+
* <li>
|
|
511
|
+
* <p>
|
|
512
|
+
* <code>db.session_type</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</p>
|
|
513
|
+
* </li>
|
|
514
|
+
* <li>
|
|
515
|
+
* <p>
|
|
516
|
+
* <code>db.sql</code> - The SQL that is currently executing (all engines)</p>
|
|
517
|
+
* </li>
|
|
518
|
+
* <li>
|
|
519
|
+
* <p>
|
|
520
|
+
* <code>db.sql_tokenized</code> - The SQL digest (all engines)</p>
|
|
521
|
+
* </li>
|
|
522
|
+
* <li>
|
|
523
|
+
* <p>
|
|
524
|
+
* <code>db.wait_event</code> - The event for which the database backend is waiting (all engines)</p>
|
|
525
|
+
* </li>
|
|
526
|
+
* <li>
|
|
527
|
+
* <p>
|
|
528
|
+
* <code>db.wait_event_type</code> - The type of event for which the database backend is waiting (all engines)</p>
|
|
529
|
+
* </li>
|
|
530
|
+
* <li>
|
|
531
|
+
* <p>
|
|
532
|
+
* <code>db.user</code> - The user logged in to the database (all engines)</p>
|
|
533
|
+
* </li>
|
|
534
|
+
* </ul>
|
|
535
|
+
*/
|
|
536
|
+
Group?: string;
|
|
537
|
+
/**
|
|
538
|
+
* <p>A list of specific dimensions from a dimension group. If this parameter is not present,
|
|
539
|
+
* then it signifies that all of the dimensions in the group were requested or are present in
|
|
540
|
+
* the response.</p>
|
|
541
|
+
* <p>Valid values for elements in the <code>Dimensions</code> array are:</p>
|
|
542
|
+
*
|
|
543
|
+
* <ul>
|
|
544
|
+
* <li>
|
|
545
|
+
* <p>
|
|
546
|
+
* <code>db.application.name</code> - The name of the application that is connected to the database (only
|
|
547
|
+
* Aurora PostgreSQL and RDS PostgreSQL)</p>
|
|
548
|
+
* </li>
|
|
549
|
+
* <li>
|
|
550
|
+
* <p>
|
|
551
|
+
* <code>db.host.id</code> - The host ID of the connected client (all engines)</p>
|
|
552
|
+
* </li>
|
|
553
|
+
* <li>
|
|
554
|
+
* <p>
|
|
555
|
+
* <code>db.host.name</code> - The host name of the connected client (all engines)</p>
|
|
556
|
+
* </li>
|
|
557
|
+
* <li>
|
|
558
|
+
* <p>
|
|
559
|
+
* <code>db.name</code> - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS
|
|
560
|
+
* PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)</p>
|
|
561
|
+
* </li>
|
|
562
|
+
* <li>
|
|
563
|
+
* <p>
|
|
564
|
+
* <code>db.session_type.name</code> - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)</p>
|
|
565
|
+
* </li>
|
|
566
|
+
* <li>
|
|
567
|
+
* <p>
|
|
568
|
+
* <code>db.sql.id</code> - The SQL ID generated by Performance Insights (all engines)</p>
|
|
569
|
+
* </li>
|
|
570
|
+
* <li>
|
|
571
|
+
* <p>
|
|
572
|
+
* <code>db.sql.db_id</code> - The SQL ID generated by the database (all engines)</p>
|
|
573
|
+
* </li>
|
|
574
|
+
* <li>
|
|
575
|
+
* <p>
|
|
576
|
+
* <code>db.sql.statement</code> - The SQL text that is being executed (all engines)</p>
|
|
577
|
+
* </li>
|
|
578
|
+
* <li>
|
|
579
|
+
* <p>
|
|
580
|
+
* <code>db.sql.tokenized_id</code>
|
|
581
|
+
* </p>
|
|
582
|
+
* </li>
|
|
583
|
+
* <li>
|
|
584
|
+
* <p>
|
|
585
|
+
* <code>db.sql_tokenized.id</code> - The SQL digest ID generated by Performance Insights (all engines)</p>
|
|
586
|
+
* </li>
|
|
587
|
+
* <li>
|
|
588
|
+
* <p>
|
|
589
|
+
* <code>db.sql_tokenized.db_id</code> - SQL digest ID generated by the database (all engines)</p>
|
|
590
|
+
* </li>
|
|
591
|
+
* <li>
|
|
592
|
+
* <p>
|
|
593
|
+
* <code>db.sql_tokenized.statement</code> - The SQL digest text (all engines)</p>
|
|
594
|
+
* </li>
|
|
595
|
+
* <li>
|
|
596
|
+
* <p>
|
|
597
|
+
* <code>db.user.id</code> - The ID of the user logged in to the database (all engines)</p>
|
|
598
|
+
* </li>
|
|
599
|
+
* <li>
|
|
600
|
+
* <p>
|
|
601
|
+
* <code>db.user.name</code> - The name of the user logged in to the database (all engines)</p>
|
|
602
|
+
* </li>
|
|
603
|
+
* <li>
|
|
604
|
+
* <p>
|
|
605
|
+
* <code>db.wait_event.name</code> - The event for which the backend is waiting (all engines)</p>
|
|
606
|
+
* </li>
|
|
607
|
+
* <li>
|
|
608
|
+
* <p>
|
|
609
|
+
* <code>db.wait_event.type</code> - The type of event for which the backend is waiting (all engines)</p>
|
|
610
|
+
* </li>
|
|
611
|
+
* <li>
|
|
612
|
+
* <p>
|
|
613
|
+
* <code>db.wait_event_type.name</code> - The name of the event type for which the backend is waiting (all
|
|
614
|
+
* engines)</p>
|
|
615
|
+
* </li>
|
|
616
|
+
* </ul>
|
|
617
|
+
*/
|
|
618
|
+
Dimensions?: string[];
|
|
619
|
+
/**
|
|
620
|
+
* <p>The maximum number of items to fetch for this dimension group.</p>
|
|
621
|
+
*/
|
|
622
|
+
Limit?: number;
|
|
623
|
+
}
|
|
624
|
+
export declare namespace PerformanceInsightsMetricDimensionGroup {
|
|
625
|
+
/**
|
|
626
|
+
* @internal
|
|
627
|
+
*/
|
|
628
|
+
const filterSensitiveLog: (obj: PerformanceInsightsMetricDimensionGroup) => any;
|
|
629
|
+
}
|
|
630
|
+
/**
|
|
631
|
+
* <p>A single query to be processed. Use these parameters to
|
|
632
|
+
* query the Performance Insights <code>GetResourceMetrics</code> API to retrieve the metrics
|
|
633
|
+
* for an anomaly. For more information, see <code>
|
|
634
|
+
* <a href="https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html">GetResourceMetrics</a>
|
|
635
|
+
* </code>
|
|
636
|
+
* in the <i>Amazon RDS Performance Insights API Reference</i>.</p>
|
|
637
|
+
*
|
|
638
|
+
* <p>Amazon RDS Performance Insights enables you to monitor and explore different
|
|
639
|
+
* dimensions of database load based on data captured from a running DB instance.
|
|
640
|
+
* DB load is measured as average active sessions. Performance Insights provides the
|
|
641
|
+
* data to API consumers as a two-dimensional time-series dataset. The time dimension
|
|
642
|
+
* provides DB load data for each time point in the queried time range. Each time point
|
|
643
|
+
* decomposes overall load in relation to the requested dimensions, measured at that
|
|
644
|
+
* time point. Examples include SQL, Wait event, User, and Host. </p>
|
|
645
|
+
*
|
|
646
|
+
* <ul>
|
|
647
|
+
* <li>
|
|
648
|
+
* <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>.
|
|
649
|
+
* </p>
|
|
650
|
+
* </li>
|
|
651
|
+
* <li>
|
|
652
|
+
* <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>.
|
|
653
|
+
* </p>
|
|
654
|
+
* </li>
|
|
655
|
+
* </ul>
|
|
656
|
+
*/
|
|
657
|
+
export interface PerformanceInsightsMetricQuery {
|
|
658
|
+
/**
|
|
659
|
+
* <p>The name of the meteric used used when querying an Performance Insights <code>GetResourceMetrics</code> API for
|
|
660
|
+
* anomaly metrics.</p>
|
|
661
|
+
*
|
|
662
|
+
* <p>Valid values for <code>Metric</code> are:</p>
|
|
663
|
+
*
|
|
664
|
+
* <ul>
|
|
665
|
+
* <li>
|
|
666
|
+
* <p>
|
|
667
|
+
* <code>db.load.avg</code> - a scaled representation of the number of active sessions
|
|
668
|
+
* for the database engine.</p>
|
|
669
|
+
* </li>
|
|
670
|
+
* <li>
|
|
671
|
+
* <p>
|
|
672
|
+
* <code>db.sampledload.avg</code> - the raw number of active sessions for the
|
|
673
|
+
* database engine.</p>
|
|
674
|
+
* </li>
|
|
675
|
+
* </ul>
|
|
676
|
+
* <p>If the number of active sessions is less than an internal Performance Insights threshold, <code>db.load.avg</code> and <code>db.sampledload.avg</code>
|
|
677
|
+
* are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with <code>db.load.avg</code>
|
|
678
|
+
* showing the scaled values, <code>db.sampledload.avg</code> showing the raw values, and <code>db.sampledload.avg</code> less than <code>db.load.avg</code>.
|
|
679
|
+
* For most use cases, you can query <code>db.load.avg</code> only. </p>
|
|
680
|
+
*/
|
|
681
|
+
Metric?: string;
|
|
682
|
+
/**
|
|
683
|
+
* <p>The specification for how to aggregate the data points from a Performance Insights <code>GetResourceMetrics</code> API query. The
|
|
684
|
+
* Performance Insights query returns all of the dimensions within that group,
|
|
685
|
+
* unless you provide the names of specific dimensions within that group. You can also request
|
|
686
|
+
* that Performance Insights return a limited number of values for a dimension.</p>
|
|
687
|
+
*/
|
|
688
|
+
GroupBy?: PerformanceInsightsMetricDimensionGroup;
|
|
689
|
+
/**
|
|
690
|
+
* <p>One or more filters to apply to a Performance Insights <code>GetResourceMetrics</code> API query. Restrictions:</p>
|
|
691
|
+
* <ul>
|
|
692
|
+
* <li>
|
|
693
|
+
* <p>Any number of filters by the same dimension, as specified in the <code>GroupBy</code> parameter.</p>
|
|
694
|
+
* </li>
|
|
695
|
+
* <li>
|
|
696
|
+
* <p>A single filter for any other dimension in this dimension group.</p>
|
|
697
|
+
* </li>
|
|
698
|
+
* </ul>
|
|
699
|
+
*/
|
|
700
|
+
Filter?: {
|
|
701
|
+
[key: string]: string;
|
|
702
|
+
};
|
|
703
|
+
}
|
|
704
|
+
export declare namespace PerformanceInsightsMetricQuery {
|
|
705
|
+
/**
|
|
706
|
+
* @internal
|
|
707
|
+
*/
|
|
708
|
+
const filterSensitiveLog: (obj: PerformanceInsightsMetricQuery) => any;
|
|
709
|
+
}
|
|
710
|
+
/**
|
|
711
|
+
* <p>Information about a reference metric used to evaluate Performance Insights.</p>
|
|
712
|
+
*/
|
|
713
|
+
export interface PerformanceInsightsReferenceMetric {
|
|
714
|
+
/**
|
|
715
|
+
* <p>A query to be processed on the metric.</p>
|
|
716
|
+
*/
|
|
717
|
+
MetricQuery?: PerformanceInsightsMetricQuery;
|
|
718
|
+
}
|
|
719
|
+
export declare namespace PerformanceInsightsReferenceMetric {
|
|
720
|
+
/**
|
|
721
|
+
* @internal
|
|
722
|
+
*/
|
|
723
|
+
const filterSensitiveLog: (obj: PerformanceInsightsReferenceMetric) => any;
|
|
724
|
+
}
|
|
725
|
+
/**
|
|
726
|
+
* <p>A reference value to compare Performance Insights metrics against to determine if the metrics
|
|
727
|
+
* demonstrate anomalous behavior.</p>
|
|
728
|
+
*/
|
|
729
|
+
export interface PerformanceInsightsReferenceScalar {
|
|
730
|
+
/**
|
|
731
|
+
* <p>The reference value.</p>
|
|
732
|
+
*/
|
|
733
|
+
Value?: number;
|
|
734
|
+
}
|
|
735
|
+
export declare namespace PerformanceInsightsReferenceScalar {
|
|
736
|
+
/**
|
|
737
|
+
* @internal
|
|
738
|
+
*/
|
|
739
|
+
const filterSensitiveLog: (obj: PerformanceInsightsReferenceScalar) => any;
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* <p>Reference scalar values and other metrics that DevOps Guru displays on a graph in its console along with the actual metrics it
|
|
743
|
+
* analyzed. Compare these reference values to your actual metrics to help you understand anomalous behavior that DevOps Guru detected.</p>
|
|
744
|
+
*/
|
|
745
|
+
export interface PerformanceInsightsReferenceComparisonValues {
|
|
746
|
+
/**
|
|
747
|
+
* <p>A scalar value DevOps Guru for a metric that DevOps Guru compares to actual metric values. This reference value is used
|
|
748
|
+
* to determine if an actual metric value should be considered anomalous.</p>
|
|
749
|
+
*/
|
|
750
|
+
ReferenceScalar?: PerformanceInsightsReferenceScalar;
|
|
751
|
+
/**
|
|
752
|
+
* <p>A metric that DevOps Guru compares to actual metric values. This reference metric is used
|
|
753
|
+
* to determine if an actual metric should be considered anomalous.</p>
|
|
754
|
+
*/
|
|
755
|
+
ReferenceMetric?: PerformanceInsightsReferenceMetric;
|
|
756
|
+
}
|
|
757
|
+
export declare namespace PerformanceInsightsReferenceComparisonValues {
|
|
758
|
+
/**
|
|
759
|
+
* @internal
|
|
760
|
+
*/
|
|
761
|
+
const filterSensitiveLog: (obj: PerformanceInsightsReferenceComparisonValues) => any;
|
|
762
|
+
}
|
|
763
|
+
/**
|
|
764
|
+
* <p>Reference data used to evaluate Performance Insights to determine if its performance
|
|
765
|
+
* is anomalous or not.</p>
|
|
766
|
+
*/
|
|
767
|
+
export interface PerformanceInsightsReferenceData {
|
|
768
|
+
/**
|
|
769
|
+
* <p>The name of the reference data.</p>
|
|
770
|
+
*/
|
|
771
|
+
Name?: string;
|
|
772
|
+
/**
|
|
773
|
+
* <p>The specific reference values used to evaluate the Performance Insights. For more information, see
|
|
774
|
+
* <code>
|
|
775
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceComparisonValues.html">PerformanceInsightsReferenceComparisonValues</a>
|
|
776
|
+
* </code>.
|
|
777
|
+
* </p>
|
|
778
|
+
*/
|
|
779
|
+
ComparisonValues?: PerformanceInsightsReferenceComparisonValues;
|
|
780
|
+
}
|
|
781
|
+
export declare namespace PerformanceInsightsReferenceData {
|
|
782
|
+
/**
|
|
783
|
+
* @internal
|
|
784
|
+
*/
|
|
785
|
+
const filterSensitiveLog: (obj: PerformanceInsightsReferenceData) => any;
|
|
786
|
+
}
|
|
787
|
+
/**
|
|
788
|
+
* <p>A statistic in a Performance Insights collection.</p>
|
|
789
|
+
*/
|
|
790
|
+
export interface PerformanceInsightsStat {
|
|
791
|
+
/**
|
|
792
|
+
* <p>The statistic type.</p>
|
|
793
|
+
*/
|
|
794
|
+
Type?: string;
|
|
795
|
+
/**
|
|
796
|
+
* <p>The value of the statistic.</p>
|
|
797
|
+
*/
|
|
798
|
+
Value?: number;
|
|
799
|
+
}
|
|
800
|
+
export declare namespace PerformanceInsightsStat {
|
|
801
|
+
/**
|
|
802
|
+
* @internal
|
|
803
|
+
*/
|
|
804
|
+
const filterSensitiveLog: (obj: PerformanceInsightsStat) => any;
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
* <p>Details about Performance Insights metrics.</p>
|
|
808
|
+
*
|
|
809
|
+
* <p>Amazon RDS Performance Insights enables you to monitor and explore different
|
|
810
|
+
* dimensions of database load based on data captured from a running DB instance.
|
|
811
|
+
* DB load is measured as average active sessions. Performance Insights provides the
|
|
812
|
+
* data to API consumers as a two-dimensional time-series dataset. The time dimension
|
|
813
|
+
* provides DB load data for each time point in the queried time range. Each time point
|
|
814
|
+
* decomposes overall load in relation to the requested dimensions, measured at that
|
|
815
|
+
* time point. Examples include SQL, Wait event, User, and Host. </p>
|
|
816
|
+
*
|
|
817
|
+
* <ul>
|
|
818
|
+
* <li>
|
|
819
|
+
* <p>To learn more about Performance Insights and Amazon Aurora DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html"> Amazon Aurora User Guide</a>.
|
|
820
|
+
* </p>
|
|
821
|
+
* </li>
|
|
822
|
+
* <li>
|
|
823
|
+
* <p>To learn more about Performance Insights and Amazon RDS DB instances, go to the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html"> Amazon RDS User Guide</a>.
|
|
824
|
+
* </p>
|
|
825
|
+
* </li>
|
|
826
|
+
* </ul>
|
|
827
|
+
*/
|
|
828
|
+
export interface PerformanceInsightsMetricsDetail {
|
|
829
|
+
/**
|
|
830
|
+
* <p>The name used for a specific Performance Insights metric.</p>
|
|
831
|
+
*/
|
|
832
|
+
MetricDisplayName?: string;
|
|
833
|
+
/**
|
|
834
|
+
* <p>The unit of measure for a metric. For example, a session or a process.</p>
|
|
835
|
+
*/
|
|
836
|
+
Unit?: string;
|
|
837
|
+
/**
|
|
838
|
+
* <p>A single query to be processed for the metric. For more information, see
|
|
839
|
+
* <code>
|
|
840
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsMetricQuery.html">PerformanceInsightsMetricQuery</a>
|
|
841
|
+
* </code>.</p>
|
|
842
|
+
*/
|
|
843
|
+
MetricQuery?: PerformanceInsightsMetricQuery;
|
|
844
|
+
/**
|
|
845
|
+
* <p>
|
|
846
|
+
* For more information, see
|
|
847
|
+
* <code>
|
|
848
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/APIReference/API_PerformanceInsightsReferenceData.html">PerformanceInsightsReferenceData</a>
|
|
849
|
+
* </code>.
|
|
850
|
+
* </p>
|
|
851
|
+
*/
|
|
852
|
+
ReferenceData?: PerformanceInsightsReferenceData[];
|
|
853
|
+
/**
|
|
854
|
+
* <p>The metric statistics during the anomalous period detected by DevOps Guru;</p>
|
|
855
|
+
*/
|
|
856
|
+
StatsAtAnomaly?: PerformanceInsightsStat[];
|
|
857
|
+
/**
|
|
858
|
+
* <p>Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes
|
|
859
|
+
* metrics, it compares them to <code>StatsAtBaseline</code> to help determine if they are
|
|
860
|
+
* anomalous.</p>
|
|
861
|
+
*/
|
|
862
|
+
StatsAtBaseline?: PerformanceInsightsStat[];
|
|
863
|
+
}
|
|
864
|
+
export declare namespace PerformanceInsightsMetricsDetail {
|
|
865
|
+
/**
|
|
866
|
+
* @internal
|
|
867
|
+
*/
|
|
868
|
+
const filterSensitiveLog: (obj: PerformanceInsightsMetricsDetail) => any;
|
|
869
|
+
}
|
|
870
|
+
/**
|
|
871
|
+
* <p> Details about the source of the anomalous operational data that triggered the
|
|
872
|
+
* anomaly.</p>
|
|
406
873
|
*/
|
|
407
874
|
export interface AnomalySourceDetails {
|
|
408
875
|
/**
|
|
409
|
-
* <p>
|
|
410
|
-
* about
|
|
876
|
+
* <p>An array of <code>CloudWatchMetricsDetail</code> objects that contain information
|
|
877
|
+
* about analyzed CloudWatch metrics that show anomalous behavior. </p>
|
|
411
878
|
*/
|
|
412
879
|
CloudWatchMetrics?: CloudWatchMetricsDetail[];
|
|
880
|
+
/**
|
|
881
|
+
* <p>An array of <code>PerformanceInsightsMetricsDetail</code> objects that contain information
|
|
882
|
+
* about analyzed Performance Insights metrics that show anomalous behavior.</p>
|
|
883
|
+
*/
|
|
884
|
+
PerformanceInsightsMetrics?: PerformanceInsightsMetricsDetail[];
|
|
413
885
|
}
|
|
414
886
|
export declare namespace AnomalySourceDetails {
|
|
415
887
|
/**
|
|
@@ -422,17 +894,13 @@ export declare enum AnomalyStatus {
|
|
|
422
894
|
ONGOING = "ONGOING"
|
|
423
895
|
}
|
|
424
896
|
/**
|
|
425
|
-
* <p>
|
|
426
|
-
*
|
|
427
|
-
*
|
|
428
|
-
* an anomaly.
|
|
429
|
-
* </p>
|
|
897
|
+
* <p> A time range that specifies when the observed unusual behavior in an anomaly started
|
|
898
|
+
* and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies
|
|
899
|
+
* the time range when DevOps Guru opens and then closes an anomaly. </p>
|
|
430
900
|
*/
|
|
431
901
|
export interface AnomalyTimeRange {
|
|
432
902
|
/**
|
|
433
|
-
* <p>
|
|
434
|
-
* The time when the anomalous behavior started.
|
|
435
|
-
* </p>
|
|
903
|
+
* <p> The time when the anomalous behavior started. </p>
|
|
436
904
|
*/
|
|
437
905
|
StartTime: Date | undefined;
|
|
438
906
|
/**
|
|
@@ -446,6 +914,10 @@ export declare namespace AnomalyTimeRange {
|
|
|
446
914
|
*/
|
|
447
915
|
const filterSensitiveLog: (obj: AnomalyTimeRange) => any;
|
|
448
916
|
}
|
|
917
|
+
export declare enum AnomalyType {
|
|
918
|
+
CAUSAL = "CAUSAL",
|
|
919
|
+
CONTEXTUAL = "CONTEXTUAL"
|
|
920
|
+
}
|
|
449
921
|
export interface DescribeAccountHealthRequest {
|
|
450
922
|
}
|
|
451
923
|
export declare namespace DescribeAccountHealthRequest {
|
|
@@ -456,26 +928,23 @@ export declare namespace DescribeAccountHealthRequest {
|
|
|
456
928
|
}
|
|
457
929
|
export interface DescribeAccountHealthResponse {
|
|
458
930
|
/**
|
|
459
|
-
* <p>
|
|
460
|
-
*
|
|
461
|
-
* </p>
|
|
931
|
+
* <p> An integer that specifies the number of open reactive insights in your Amazon Web Services account.
|
|
932
|
+
* </p>
|
|
462
933
|
*/
|
|
463
934
|
OpenReactiveInsights: number | undefined;
|
|
464
935
|
/**
|
|
465
|
-
* <p>
|
|
466
|
-
*
|
|
467
|
-
* </p>
|
|
936
|
+
* <p> An integer that specifies the number of open proactive insights in your Amazon Web Services
|
|
937
|
+
* account. </p>
|
|
468
938
|
*/
|
|
469
939
|
OpenProactiveInsights: number | undefined;
|
|
470
940
|
/**
|
|
471
|
-
* <p>
|
|
472
|
-
*
|
|
473
|
-
* </p>
|
|
941
|
+
* <p> An integer that specifies the number of metrics that have been analyzed in your Amazon Web Services
|
|
942
|
+
* account. </p>
|
|
474
943
|
*/
|
|
475
944
|
MetricsAnalyzed: number | undefined;
|
|
476
945
|
/**
|
|
477
|
-
* <p>The number of Amazon DevOps Guru resource analysis hours billed to the current
|
|
478
|
-
*
|
|
946
|
+
* <p>The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in
|
|
947
|
+
* the last hour. </p>
|
|
479
948
|
*/
|
|
480
949
|
ResourceHours: number | undefined;
|
|
481
950
|
}
|
|
@@ -487,17 +956,15 @@ export declare namespace DescribeAccountHealthResponse {
|
|
|
487
956
|
}
|
|
488
957
|
export interface DescribeAccountOverviewRequest {
|
|
489
958
|
/**
|
|
490
|
-
* <p>
|
|
491
|
-
*
|
|
492
|
-
*
|
|
493
|
-
* </p>
|
|
959
|
+
* <p> The start of the time range passed in. The start time granularity is at the day
|
|
960
|
+
* level. The floor of the start time is used. Returned information occurred after this
|
|
961
|
+
* day. </p>
|
|
494
962
|
*/
|
|
495
963
|
FromTime: Date | undefined;
|
|
496
964
|
/**
|
|
497
|
-
* <p>
|
|
498
|
-
*
|
|
499
|
-
*
|
|
500
|
-
* </p>
|
|
965
|
+
* <p> The end of the time range passed in. The start time granularity is at the day level.
|
|
966
|
+
* The floor of the start time is used. Returned information occurred before this day. If
|
|
967
|
+
* this is not specified, then the current day is used. </p>
|
|
501
968
|
*/
|
|
502
969
|
ToTime?: Date;
|
|
503
970
|
}
|
|
@@ -509,24 +976,18 @@ export declare namespace DescribeAccountOverviewRequest {
|
|
|
509
976
|
}
|
|
510
977
|
export interface DescribeAccountOverviewResponse {
|
|
511
978
|
/**
|
|
512
|
-
* <p>
|
|
513
|
-
*
|
|
514
|
-
* time range passed in.
|
|
515
|
-
* </p>
|
|
979
|
+
* <p> An integer that specifies the number of open reactive insights in your Amazon Web Services account
|
|
980
|
+
* that were created during the time range passed in. </p>
|
|
516
981
|
*/
|
|
517
982
|
ReactiveInsights: number | undefined;
|
|
518
983
|
/**
|
|
519
|
-
* <p>
|
|
520
|
-
*
|
|
521
|
-
* time range passed in.
|
|
522
|
-
* </p>
|
|
984
|
+
* <p> An integer that specifies the number of open proactive insights in your Amazon Web Services account
|
|
985
|
+
* that were created during the time range passed in. </p>
|
|
523
986
|
*/
|
|
524
987
|
ProactiveInsights: number | undefined;
|
|
525
988
|
/**
|
|
526
|
-
* <p>
|
|
527
|
-
*
|
|
528
|
-
* time range passed in.
|
|
529
|
-
* </p>
|
|
989
|
+
* <p> The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed in.
|
|
990
|
+
* </p>
|
|
530
991
|
*/
|
|
531
992
|
MeanTimeToRecoverInMilliseconds: number | undefined;
|
|
532
993
|
}
|
|
@@ -538,11 +999,13 @@ export declare namespace DescribeAccountOverviewResponse {
|
|
|
538
999
|
}
|
|
539
1000
|
export interface DescribeAnomalyRequest {
|
|
540
1001
|
/**
|
|
541
|
-
* <p>
|
|
542
|
-
* The ID of the anomaly.
|
|
543
|
-
* </p>
|
|
1002
|
+
* <p> The ID of the anomaly. </p>
|
|
544
1003
|
*/
|
|
545
1004
|
Id: string | undefined;
|
|
1005
|
+
/**
|
|
1006
|
+
* <p>The ID of the member account.</p>
|
|
1007
|
+
*/
|
|
1008
|
+
AccountId?: string;
|
|
546
1009
|
}
|
|
547
1010
|
export declare namespace DescribeAnomalyRequest {
|
|
548
1011
|
/**
|
|
@@ -551,21 +1014,17 @@ export declare namespace DescribeAnomalyRequest {
|
|
|
551
1014
|
const filterSensitiveLog: (obj: DescribeAnomalyRequest) => any;
|
|
552
1015
|
}
|
|
553
1016
|
/**
|
|
554
|
-
* <p>
|
|
555
|
-
*
|
|
556
|
-
* </p>
|
|
1017
|
+
* <p> The time range during which anomalous behavior in a proactive anomaly or an insight
|
|
1018
|
+
* is expected to occur. </p>
|
|
557
1019
|
*/
|
|
558
1020
|
export interface PredictionTimeRange {
|
|
559
1021
|
/**
|
|
560
|
-
* <p>
|
|
561
|
-
*
|
|
562
|
-
* </p>
|
|
1022
|
+
* <p> The time range during which a metric limit is expected to be exceeded. This applies
|
|
1023
|
+
* to proactive insights only. </p>
|
|
563
1024
|
*/
|
|
564
1025
|
StartTime: Date | undefined;
|
|
565
1026
|
/**
|
|
566
|
-
* <p>
|
|
567
|
-
* The time when the behavior in a proactive insight is expected to end.
|
|
568
|
-
* </p>
|
|
1027
|
+
* <p> The time when the behavior in a proactive insight is expected to end. </p>
|
|
569
1028
|
*/
|
|
570
1029
|
EndTime?: Date;
|
|
571
1030
|
}
|
|
@@ -576,17 +1035,14 @@ export declare namespace PredictionTimeRange {
|
|
|
576
1035
|
const filterSensitiveLog: (obj: PredictionTimeRange) => any;
|
|
577
1036
|
}
|
|
578
1037
|
/**
|
|
579
|
-
* <p>
|
|
580
|
-
*
|
|
581
|
-
*
|
|
582
|
-
*
|
|
583
|
-
* </p>
|
|
1038
|
+
* <p> Information about Amazon Web Services CloudFormation stacks. You can use up to 500
|
|
1039
|
+
* stacks to specify which Amazon Web Services resources in your account to analyze. For more
|
|
1040
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Stacks</a> in the
|
|
1041
|
+
* <i>Amazon Web Services CloudFormation User Guide</i>. </p>
|
|
584
1042
|
*/
|
|
585
1043
|
export interface CloudFormationCollection {
|
|
586
1044
|
/**
|
|
587
|
-
* <p>
|
|
588
|
-
* An array of CloudFormation stack names.
|
|
589
|
-
* </p>
|
|
1045
|
+
* <p> An array of CloudFormation stack names. </p>
|
|
590
1046
|
*/
|
|
591
1047
|
StackNames?: string[];
|
|
592
1048
|
}
|
|
@@ -597,18 +1053,125 @@ export declare namespace CloudFormationCollection {
|
|
|
597
1053
|
const filterSensitiveLog: (obj: CloudFormationCollection) => any;
|
|
598
1054
|
}
|
|
599
1055
|
/**
|
|
600
|
-
* <p>
|
|
601
|
-
*
|
|
602
|
-
*
|
|
603
|
-
*
|
|
1056
|
+
* <p>A collection of Amazon Web Services stags.</p>
|
|
1057
|
+
* <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
|
|
1058
|
+
* tagging, so you can assign the same tag to resources from different services to indicate
|
|
1059
|
+
* that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB
|
|
1060
|
+
* table resource that you assign to an Lambda function. For more information about
|
|
1061
|
+
* using tags, see the <a href="https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf">Tagging
|
|
1062
|
+
* best practices</a> whitepaper. </p>
|
|
1063
|
+
* <p>Each Amazon Web Services tag has two parts. </p>
|
|
1064
|
+
* <ul>
|
|
1065
|
+
* <li>
|
|
1066
|
+
* <p>A tag <i>key</i> (for example, <code>CostCenter</code>,
|
|
1067
|
+
* <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag
|
|
1068
|
+
* <i>keys</i> are case-sensitive.</p>
|
|
1069
|
+
* </li>
|
|
1070
|
+
* <li>
|
|
1071
|
+
* <p>An optional field known as a tag <i>value</i> (for example,
|
|
1072
|
+
* <code>111122223333</code>, <code>Production</code>, or a team
|
|
1073
|
+
* name). Omitting the tag <i>value</i> is the same as using an empty
|
|
1074
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
1075
|
+
* case-sensitive.</p>
|
|
1076
|
+
* </li>
|
|
1077
|
+
* </ul>
|
|
1078
|
+
* <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p>
|
|
1079
|
+
* <important>
|
|
1080
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
1081
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
1082
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
1083
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
1084
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
1085
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
1086
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
1087
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
1088
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
1089
|
+
* </important>
|
|
1090
|
+
*/
|
|
1091
|
+
export interface TagCollection {
|
|
1092
|
+
/**
|
|
1093
|
+
* <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
|
|
1094
|
+
* DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
|
|
1095
|
+
* up your DevOps Guru application and analysis boundary.</p>
|
|
1096
|
+
* <important>
|
|
1097
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
1098
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
1099
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
1100
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
1101
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
1102
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
1103
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
1104
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
1105
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
1106
|
+
* </important>
|
|
1107
|
+
*/
|
|
1108
|
+
AppBoundaryKey: string | undefined;
|
|
1109
|
+
/**
|
|
1110
|
+
* <p>The values in an Amazon Web Services tag collection.</p>
|
|
1111
|
+
* <p>The tag's <i>value</i> is an optional field used to associate a string with
|
|
1112
|
+
* the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
|
|
1113
|
+
* name). The <i>key</i> and <i>value</i> are the tag's <i>key</i> pair.
|
|
1114
|
+
* Omitting the tag <i>value</i> is the same as using an empty
|
|
1115
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
1116
|
+
* case-sensitive. You can specify a maximum of 256 characters for a tag value.</p>
|
|
1117
|
+
*/
|
|
1118
|
+
TagValues: string[] | undefined;
|
|
1119
|
+
}
|
|
1120
|
+
export declare namespace TagCollection {
|
|
1121
|
+
/**
|
|
1122
|
+
* @internal
|
|
1123
|
+
*/
|
|
1124
|
+
const filterSensitiveLog: (obj: TagCollection) => any;
|
|
1125
|
+
}
|
|
1126
|
+
/**
|
|
1127
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
1128
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
1129
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
1130
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
604
1131
|
*/
|
|
605
1132
|
export interface ResourceCollection {
|
|
606
1133
|
/**
|
|
607
|
-
* <p> An array of the names of
|
|
608
|
-
*
|
|
609
|
-
* </p>
|
|
1134
|
+
* <p> An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that
|
|
1135
|
+
* DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
610
1136
|
*/
|
|
611
1137
|
CloudFormation?: CloudFormationCollection;
|
|
1138
|
+
/**
|
|
1139
|
+
* <p>The Amazon Web Services tags that are used by resources in the resource collection.</p>
|
|
1140
|
+
* <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
|
|
1141
|
+
* tagging, so you can assign the same tag to resources from different services to indicate
|
|
1142
|
+
* that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB
|
|
1143
|
+
* table resource that you assign to an Lambda function. For more information about
|
|
1144
|
+
* using tags, see the <a href="https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf">Tagging
|
|
1145
|
+
* best practices</a> whitepaper. </p>
|
|
1146
|
+
* <p>Each Amazon Web Services tag has two parts. </p>
|
|
1147
|
+
* <ul>
|
|
1148
|
+
* <li>
|
|
1149
|
+
* <p>A tag <i>key</i> (for example, <code>CostCenter</code>,
|
|
1150
|
+
* <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag
|
|
1151
|
+
* <i>keys</i> are case-sensitive.</p>
|
|
1152
|
+
* </li>
|
|
1153
|
+
* <li>
|
|
1154
|
+
* <p>An optional field known as a tag <i>value</i> (for example,
|
|
1155
|
+
* <code>111122223333</code>, <code>Production</code>, or a team
|
|
1156
|
+
* name). Omitting the tag <i>value</i> is the same as using an empty
|
|
1157
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
1158
|
+
* case-sensitive.</p>
|
|
1159
|
+
* </li>
|
|
1160
|
+
* </ul>
|
|
1161
|
+
* <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p>
|
|
1162
|
+
* <important>
|
|
1163
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
1164
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
1165
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
1166
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
1167
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
1168
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
1169
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
1170
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
1171
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
1172
|
+
* </important>
|
|
1173
|
+
*/
|
|
1174
|
+
Tags?: TagCollection[];
|
|
612
1175
|
}
|
|
613
1176
|
export declare namespace ResourceCollection {
|
|
614
1177
|
/**
|
|
@@ -617,77 +1180,66 @@ export declare namespace ResourceCollection {
|
|
|
617
1180
|
const filterSensitiveLog: (obj: ResourceCollection) => any;
|
|
618
1181
|
}
|
|
619
1182
|
/**
|
|
620
|
-
* <p>Information about an anomaly. This object is returned by
|
|
1183
|
+
* <p>Information about an anomaly. This object is returned by
|
|
1184
|
+
* <code>ListAnomalies</code>.</p>
|
|
621
1185
|
*/
|
|
622
1186
|
export interface ProactiveAnomaly {
|
|
623
1187
|
/**
|
|
624
|
-
* <p>
|
|
625
|
-
* The ID of a proactive anomaly.
|
|
626
|
-
* </p>
|
|
1188
|
+
* <p> The ID of a proactive anomaly. </p>
|
|
627
1189
|
*/
|
|
628
1190
|
Id?: string;
|
|
629
1191
|
/**
|
|
630
|
-
* <p>
|
|
631
|
-
*
|
|
632
|
-
*
|
|
1192
|
+
* <p>The severity of the anomaly. The severity of anomalies that generate
|
|
1193
|
+
* an insight determine that insight's severity. For more information, see
|
|
1194
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
1195
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
633
1196
|
*/
|
|
634
1197
|
Severity?: AnomalySeverity | string;
|
|
635
1198
|
/**
|
|
636
|
-
* <p>
|
|
637
|
-
* The status of a proactive anomaly.
|
|
638
|
-
* </p>
|
|
1199
|
+
* <p> The status of a proactive anomaly. </p>
|
|
639
1200
|
*/
|
|
640
1201
|
Status?: AnomalyStatus | string;
|
|
641
1202
|
/**
|
|
642
|
-
* <p>
|
|
643
|
-
* The time of the anomaly's most recent update.
|
|
644
|
-
* </p>
|
|
1203
|
+
* <p> The time of the anomaly's most recent update. </p>
|
|
645
1204
|
*/
|
|
646
1205
|
UpdateTime?: Date;
|
|
647
1206
|
/**
|
|
648
|
-
* <p>
|
|
649
|
-
*
|
|
650
|
-
*
|
|
651
|
-
* an anomaly.
|
|
652
|
-
* </p>
|
|
1207
|
+
* <p> A time range that specifies when the observed unusual behavior in an anomaly started
|
|
1208
|
+
* and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies
|
|
1209
|
+
* the time range when DevOps Guru opens and then closes an anomaly. </p>
|
|
653
1210
|
*/
|
|
654
1211
|
AnomalyTimeRange?: AnomalyTimeRange;
|
|
655
1212
|
/**
|
|
656
1213
|
* <p>
|
|
657
|
-
*
|
|
1214
|
+
* An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed.
|
|
658
1215
|
* </p>
|
|
659
1216
|
*/
|
|
660
1217
|
AnomalyReportedTimeRange?: AnomalyReportedTimeRange;
|
|
661
1218
|
/**
|
|
662
|
-
* <p>
|
|
663
|
-
*
|
|
664
|
-
* </p>
|
|
1219
|
+
* <p> The time range during which anomalous behavior in a proactive anomaly or an insight
|
|
1220
|
+
* is expected to occur. </p>
|
|
665
1221
|
*/
|
|
666
1222
|
PredictionTimeRange?: PredictionTimeRange;
|
|
667
1223
|
/**
|
|
668
|
-
* <p>
|
|
669
|
-
*
|
|
670
|
-
* </p>
|
|
1224
|
+
* <p> Details about the source of the analyzed operational data that triggered the anomaly.
|
|
1225
|
+
* The one supported source is Amazon CloudWatch metrics. </p>
|
|
671
1226
|
*/
|
|
672
1227
|
SourceDetails?: AnomalySourceDetails;
|
|
673
1228
|
/**
|
|
674
|
-
* <p>
|
|
675
|
-
*
|
|
676
|
-
* </p>
|
|
1229
|
+
* <p> The ID of the insight that contains this anomaly. An insight is composed of related
|
|
1230
|
+
* anomalies. </p>
|
|
677
1231
|
*/
|
|
678
1232
|
AssociatedInsightId?: string;
|
|
679
1233
|
/**
|
|
680
|
-
* <p>
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
*
|
|
1234
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
1235
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
1236
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
1237
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
684
1238
|
*/
|
|
685
1239
|
ResourceCollection?: ResourceCollection;
|
|
686
1240
|
/**
|
|
687
|
-
* <p>
|
|
688
|
-
*
|
|
689
|
-
* threshold is related to the anomalous behavior that generated this anomaly.
|
|
690
|
-
* </p>
|
|
1241
|
+
* <p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this
|
|
1242
|
+
* threshold is related to the anomalous behavior that generated this anomaly. </p>
|
|
691
1243
|
*/
|
|
692
1244
|
Limit?: number;
|
|
693
1245
|
}
|
|
@@ -698,7 +1250,8 @@ export declare namespace ProactiveAnomaly {
|
|
|
698
1250
|
const filterSensitiveLog: (obj: ProactiveAnomaly) => any;
|
|
699
1251
|
}
|
|
700
1252
|
/**
|
|
701
|
-
* <p>Details about a reactive anomaly.
|
|
1253
|
+
* <p>Details about a reactive anomaly. This object is returned by
|
|
1254
|
+
* <code>ListAnomalies</code>.</p>
|
|
702
1255
|
*/
|
|
703
1256
|
export interface ReactiveAnomaly {
|
|
704
1257
|
/**
|
|
@@ -706,48 +1259,76 @@ export interface ReactiveAnomaly {
|
|
|
706
1259
|
*/
|
|
707
1260
|
Id?: string;
|
|
708
1261
|
/**
|
|
709
|
-
* <p>The severity of the anomaly.
|
|
1262
|
+
* <p>The severity of the anomaly. The severity of anomalies that generate
|
|
1263
|
+
* an insight determine that insight's severity. For more information, see
|
|
1264
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
1265
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
710
1266
|
*/
|
|
711
1267
|
Severity?: AnomalySeverity | string;
|
|
712
1268
|
/**
|
|
713
|
-
* <p>
|
|
714
|
-
* The status of the anomaly.
|
|
715
|
-
* </p>
|
|
1269
|
+
* <p> The status of the anomaly. </p>
|
|
716
1270
|
*/
|
|
717
1271
|
Status?: AnomalyStatus | string;
|
|
718
1272
|
/**
|
|
719
|
-
* <p>
|
|
720
|
-
*
|
|
721
|
-
*
|
|
722
|
-
* an anomaly.
|
|
723
|
-
* </p>
|
|
1273
|
+
* <p> A time range that specifies when the observed unusual behavior in an anomaly started
|
|
1274
|
+
* and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies
|
|
1275
|
+
* the time range when DevOps Guru opens and then closes an anomaly. </p>
|
|
724
1276
|
*/
|
|
725
1277
|
AnomalyTimeRange?: AnomalyTimeRange;
|
|
726
1278
|
/**
|
|
727
1279
|
* <p>
|
|
728
|
-
*
|
|
1280
|
+
* An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed.
|
|
729
1281
|
* </p>
|
|
730
1282
|
*/
|
|
731
1283
|
AnomalyReportedTimeRange?: AnomalyReportedTimeRange;
|
|
732
1284
|
/**
|
|
733
|
-
* <p>
|
|
734
|
-
*
|
|
735
|
-
* </p>
|
|
1285
|
+
* <p> Details about the source of the analyzed operational data that triggered the anomaly.
|
|
1286
|
+
* The one supported source is Amazon CloudWatch metrics. </p>
|
|
736
1287
|
*/
|
|
737
1288
|
SourceDetails?: AnomalySourceDetails;
|
|
738
1289
|
/**
|
|
739
|
-
* <p>
|
|
740
|
-
*
|
|
741
|
-
* </p>
|
|
1290
|
+
* <p> The ID of the insight that contains this anomaly. An insight is composed of related
|
|
1291
|
+
* anomalies. </p>
|
|
742
1292
|
*/
|
|
743
1293
|
AssociatedInsightId?: string;
|
|
744
1294
|
/**
|
|
745
|
-
* <p>
|
|
746
|
-
*
|
|
747
|
-
*
|
|
748
|
-
*
|
|
1295
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
1296
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
1297
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
1298
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
749
1299
|
*/
|
|
750
1300
|
ResourceCollection?: ResourceCollection;
|
|
1301
|
+
/**
|
|
1302
|
+
* <p>The type of the reactive anomaly. It can be one of the following types.</p>
|
|
1303
|
+
* <ul>
|
|
1304
|
+
* <li>
|
|
1305
|
+
* <p>
|
|
1306
|
+
* <code>CAUSAL</code> - the anomaly can cause a new insight.</p>
|
|
1307
|
+
* </li>
|
|
1308
|
+
* <li>
|
|
1309
|
+
* <p>
|
|
1310
|
+
* <code>CONTEXTUAL</code> - the anomaly contains additional information about an insight or its causal anomaly.</p>
|
|
1311
|
+
* </li>
|
|
1312
|
+
* </ul>
|
|
1313
|
+
*/
|
|
1314
|
+
Type?: AnomalyType | string;
|
|
1315
|
+
/**
|
|
1316
|
+
* <p>The name of the reactive anomaly.</p>
|
|
1317
|
+
*/
|
|
1318
|
+
Name?: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* <p>A description of the reactive anomaly.</p>
|
|
1321
|
+
*/
|
|
1322
|
+
Description?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* <p>The ID of the causal anomaly that is associated with this
|
|
1325
|
+
* reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.</p>
|
|
1326
|
+
*/
|
|
1327
|
+
CausalAnomalyId?: string;
|
|
1328
|
+
/**
|
|
1329
|
+
* <p>The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.</p>
|
|
1330
|
+
*/
|
|
1331
|
+
AnomalyResources?: AnomalyResource[];
|
|
751
1332
|
}
|
|
752
1333
|
export declare namespace ReactiveAnomaly {
|
|
753
1334
|
/**
|
|
@@ -757,15 +1338,11 @@ export declare namespace ReactiveAnomaly {
|
|
|
757
1338
|
}
|
|
758
1339
|
export interface DescribeAnomalyResponse {
|
|
759
1340
|
/**
|
|
760
|
-
* <p>
|
|
761
|
-
* A <code>ReactiveAnomaly</code> object that represents the requested anomaly.
|
|
762
|
-
* </p>
|
|
1341
|
+
* <p> A <code>ProactiveAnomaly</code> object that represents the requested anomaly. </p>
|
|
763
1342
|
*/
|
|
764
1343
|
ProactiveAnomaly?: ProactiveAnomaly;
|
|
765
1344
|
/**
|
|
766
|
-
* <p>
|
|
767
|
-
* A <code>ProactiveAnomaly</code> object that represents the requested anomaly.
|
|
768
|
-
* </p>
|
|
1345
|
+
* <p> A <code>ReactiveAnomaly</code> object that represents the requested anomaly. </p>
|
|
769
1346
|
*/
|
|
770
1347
|
ReactiveAnomaly?: ReactiveAnomaly;
|
|
771
1348
|
}
|
|
@@ -777,9 +1354,7 @@ export declare namespace DescribeAnomalyResponse {
|
|
|
777
1354
|
}
|
|
778
1355
|
export interface DescribeFeedbackRequest {
|
|
779
1356
|
/**
|
|
780
|
-
* <p>
|
|
781
|
-
* The ID of the insight for which the feedback was provided.
|
|
782
|
-
* </p>
|
|
1357
|
+
* <p> The ID of the insight for which the feedback was provided. </p>
|
|
783
1358
|
*/
|
|
784
1359
|
InsightId?: string;
|
|
785
1360
|
}
|
|
@@ -797,21 +1372,15 @@ export declare enum InsightFeedbackOption {
|
|
|
797
1372
|
VALID_COLLECTION = "VALID_COLLECTION"
|
|
798
1373
|
}
|
|
799
1374
|
/**
|
|
800
|
-
* <p>
|
|
801
|
-
* Information about insight feedback received from a customer.
|
|
802
|
-
* </p>
|
|
1375
|
+
* <p> Information about insight feedback received from a customer. </p>
|
|
803
1376
|
*/
|
|
804
1377
|
export interface InsightFeedback {
|
|
805
1378
|
/**
|
|
806
|
-
* <p>
|
|
807
|
-
* The insight feedback ID.
|
|
808
|
-
* </p>
|
|
1379
|
+
* <p> The insight feedback ID. </p>
|
|
809
1380
|
*/
|
|
810
1381
|
Id?: string;
|
|
811
1382
|
/**
|
|
812
|
-
* <p>
|
|
813
|
-
* The feedback provided by the customer.
|
|
814
|
-
* </p>
|
|
1383
|
+
* <p> The feedback provided by the customer. </p>
|
|
815
1384
|
*/
|
|
816
1385
|
Feedback?: InsightFeedbackOption | string;
|
|
817
1386
|
}
|
|
@@ -823,9 +1392,7 @@ export declare namespace InsightFeedback {
|
|
|
823
1392
|
}
|
|
824
1393
|
export interface DescribeFeedbackResponse {
|
|
825
1394
|
/**
|
|
826
|
-
* <p>
|
|
827
|
-
* Information about insight feedback received from a customer.
|
|
828
|
-
* </p>
|
|
1395
|
+
* <p> Information about insight feedback received from a customer. </p>
|
|
829
1396
|
*/
|
|
830
1397
|
InsightFeedback?: InsightFeedback;
|
|
831
1398
|
}
|
|
@@ -837,11 +1404,13 @@ export declare namespace DescribeFeedbackResponse {
|
|
|
837
1404
|
}
|
|
838
1405
|
export interface DescribeInsightRequest {
|
|
839
1406
|
/**
|
|
840
|
-
* <p>
|
|
841
|
-
* The ID of the insight.
|
|
842
|
-
* </p>
|
|
1407
|
+
* <p> The ID of the insight. </p>
|
|
843
1408
|
*/
|
|
844
1409
|
Id: string | undefined;
|
|
1410
|
+
/**
|
|
1411
|
+
* <p>The ID of the member account in the organization.</p>
|
|
1412
|
+
*/
|
|
1413
|
+
AccountId?: string;
|
|
845
1414
|
}
|
|
846
1415
|
export declare namespace DescribeInsightRequest {
|
|
847
1416
|
/**
|
|
@@ -855,15 +1424,11 @@ export declare namespace DescribeInsightRequest {
|
|
|
855
1424
|
*/
|
|
856
1425
|
export interface InsightTimeRange {
|
|
857
1426
|
/**
|
|
858
|
-
* <p>
|
|
859
|
-
* The time when the behavior described in an insight started.
|
|
860
|
-
* </p>
|
|
1427
|
+
* <p> The time when the behavior described in an insight started. </p>
|
|
861
1428
|
*/
|
|
862
1429
|
StartTime: Date | undefined;
|
|
863
1430
|
/**
|
|
864
|
-
* <p>
|
|
865
|
-
* The time when the behavior described in an insight ended.
|
|
866
|
-
* </p>
|
|
1431
|
+
* <p> The time when the behavior described in an insight ended. </p>
|
|
867
1432
|
*/
|
|
868
1433
|
EndTime?: Date;
|
|
869
1434
|
}
|
|
@@ -883,7 +1448,8 @@ export declare enum InsightStatus {
|
|
|
883
1448
|
ONGOING = "ONGOING"
|
|
884
1449
|
}
|
|
885
1450
|
/**
|
|
886
|
-
* <p>Details about a proactive insight. This object is returned by
|
|
1451
|
+
* <p>Details about a proactive insight. This object is returned by
|
|
1452
|
+
* <code>ListInsights</code>.</p>
|
|
887
1453
|
*/
|
|
888
1454
|
export interface ProactiveInsight {
|
|
889
1455
|
/**
|
|
@@ -895,7 +1461,9 @@ export interface ProactiveInsight {
|
|
|
895
1461
|
*/
|
|
896
1462
|
Name?: string;
|
|
897
1463
|
/**
|
|
898
|
-
* <p>The severity of the
|
|
1464
|
+
* <p>The severity of the insight. For more information, see
|
|
1465
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
1466
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
899
1467
|
*/
|
|
900
1468
|
Severity?: InsightSeverity | string;
|
|
901
1469
|
/**
|
|
@@ -908,23 +1476,20 @@ export interface ProactiveInsight {
|
|
|
908
1476
|
*/
|
|
909
1477
|
InsightTimeRange?: InsightTimeRange;
|
|
910
1478
|
/**
|
|
911
|
-
* <p>
|
|
912
|
-
*
|
|
913
|
-
* </p>
|
|
1479
|
+
* <p> The time range during which anomalous behavior in a proactive anomaly or an insight
|
|
1480
|
+
* is expected to occur. </p>
|
|
914
1481
|
*/
|
|
915
1482
|
PredictionTimeRange?: PredictionTimeRange;
|
|
916
1483
|
/**
|
|
917
|
-
* <p>
|
|
918
|
-
*
|
|
919
|
-
*
|
|
920
|
-
*
|
|
1484
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
1485
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
1486
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
1487
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
921
1488
|
*/
|
|
922
1489
|
ResourceCollection?: ResourceCollection;
|
|
923
1490
|
/**
|
|
924
|
-
* <p>
|
|
925
|
-
*
|
|
926
|
-
* the creation of OpstItems insights before they are created for each insight.
|
|
927
|
-
* </p>
|
|
1491
|
+
* <p> The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable
|
|
1492
|
+
* the creation of OpstItems insights before they are created for each insight. </p>
|
|
928
1493
|
*/
|
|
929
1494
|
SsmOpsItemId?: string;
|
|
930
1495
|
}
|
|
@@ -935,33 +1500,26 @@ export declare namespace ProactiveInsight {
|
|
|
935
1500
|
const filterSensitiveLog: (obj: ProactiveInsight) => any;
|
|
936
1501
|
}
|
|
937
1502
|
/**
|
|
938
|
-
* <p>
|
|
939
|
-
*
|
|
940
|
-
* </p>
|
|
1503
|
+
* <p> Information about a reactive insight. This object is returned by
|
|
1504
|
+
* <code>ListInsights</code>. </p>
|
|
941
1505
|
*/
|
|
942
1506
|
export interface ReactiveInsight {
|
|
943
1507
|
/**
|
|
944
|
-
* <p>
|
|
945
|
-
* The ID of a reactive insight.
|
|
946
|
-
* </p>
|
|
1508
|
+
* <p> The ID of a reactive insight. </p>
|
|
947
1509
|
*/
|
|
948
1510
|
Id?: string;
|
|
949
1511
|
/**
|
|
950
|
-
* <p>
|
|
951
|
-
* The name of a reactive insight.
|
|
952
|
-
* </p>
|
|
1512
|
+
* <p> The name of a reactive insight. </p>
|
|
953
1513
|
*/
|
|
954
1514
|
Name?: string;
|
|
955
1515
|
/**
|
|
956
|
-
* <p>
|
|
957
|
-
*
|
|
958
|
-
*
|
|
1516
|
+
* <p>The severity of the insight. For more information, see
|
|
1517
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
1518
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
959
1519
|
*/
|
|
960
1520
|
Severity?: InsightSeverity | string;
|
|
961
1521
|
/**
|
|
962
|
-
* <p>
|
|
963
|
-
* The status of a reactive insight.
|
|
964
|
-
* </p>
|
|
1522
|
+
* <p> The status of a reactive insight. </p>
|
|
965
1523
|
*/
|
|
966
1524
|
Status?: InsightStatus | string;
|
|
967
1525
|
/**
|
|
@@ -970,17 +1528,15 @@ export interface ReactiveInsight {
|
|
|
970
1528
|
*/
|
|
971
1529
|
InsightTimeRange?: InsightTimeRange;
|
|
972
1530
|
/**
|
|
973
|
-
* <p>
|
|
974
|
-
*
|
|
975
|
-
*
|
|
976
|
-
*
|
|
1531
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
1532
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
1533
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
1534
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
977
1535
|
*/
|
|
978
1536
|
ResourceCollection?: ResourceCollection;
|
|
979
1537
|
/**
|
|
980
|
-
* <p>
|
|
981
|
-
*
|
|
982
|
-
* the creation of OpstItems insights before they are created for each insight.
|
|
983
|
-
* </p>
|
|
1538
|
+
* <p> The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable
|
|
1539
|
+
* the creation of OpstItems insights before they are created for each insight. </p>
|
|
984
1540
|
*/
|
|
985
1541
|
SsmOpsItemId?: string;
|
|
986
1542
|
}
|
|
@@ -992,15 +1548,11 @@ export declare namespace ReactiveInsight {
|
|
|
992
1548
|
}
|
|
993
1549
|
export interface DescribeInsightResponse {
|
|
994
1550
|
/**
|
|
995
|
-
* <p>
|
|
996
|
-
* A <code>ProactiveInsight</code> object that represents the requested insight.
|
|
997
|
-
* </p>
|
|
1551
|
+
* <p> A <code>ProactiveInsight</code> object that represents the requested insight. </p>
|
|
998
1552
|
*/
|
|
999
1553
|
ProactiveInsight?: ProactiveInsight;
|
|
1000
1554
|
/**
|
|
1001
|
-
* <p>
|
|
1002
|
-
* A <code>ReactiveInsight</code> object that represents the requested insight.
|
|
1003
|
-
* </p>
|
|
1555
|
+
* <p> A <code>ReactiveInsight</code> object that represents the requested insight. </p>
|
|
1004
1556
|
*/
|
|
1005
1557
|
ReactiveInsight?: ReactiveInsight;
|
|
1006
1558
|
}
|
|
@@ -1010,53 +1562,150 @@ export declare namespace DescribeInsightResponse {
|
|
|
1010
1562
|
*/
|
|
1011
1563
|
const filterSensitiveLog: (obj: DescribeInsightResponse) => any;
|
|
1012
1564
|
}
|
|
1013
|
-
export
|
|
1565
|
+
export interface DescribeOrganizationHealthRequest {
|
|
1566
|
+
/**
|
|
1567
|
+
* <p>The ID of the Amazon Web Services account.</p>
|
|
1568
|
+
*/
|
|
1569
|
+
AccountIds?: string[];
|
|
1570
|
+
/**
|
|
1571
|
+
* <p>The ID of the organizational unit.</p>
|
|
1572
|
+
*/
|
|
1573
|
+
OrganizationalUnitIds?: string[];
|
|
1574
|
+
}
|
|
1575
|
+
export declare namespace DescribeOrganizationHealthRequest {
|
|
1576
|
+
/**
|
|
1577
|
+
* @internal
|
|
1578
|
+
*/
|
|
1579
|
+
const filterSensitiveLog: (obj: DescribeOrganizationHealthRequest) => any;
|
|
1580
|
+
}
|
|
1581
|
+
export interface DescribeOrganizationHealthResponse {
|
|
1582
|
+
/**
|
|
1583
|
+
* <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
|
|
1584
|
+
* account.</p>
|
|
1585
|
+
*/
|
|
1586
|
+
OpenReactiveInsights: number | undefined;
|
|
1587
|
+
/**
|
|
1588
|
+
* <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
|
|
1589
|
+
* account.</p>
|
|
1590
|
+
*/
|
|
1591
|
+
OpenProactiveInsights: number | undefined;
|
|
1592
|
+
/**
|
|
1593
|
+
* <p>An integer that specifies the number of metrics that have been analyzed in your
|
|
1594
|
+
* organization.</p>
|
|
1595
|
+
*/
|
|
1596
|
+
MetricsAnalyzed: number | undefined;
|
|
1597
|
+
/**
|
|
1598
|
+
* <p>The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in
|
|
1599
|
+
* the last hour. </p>
|
|
1600
|
+
*/
|
|
1601
|
+
ResourceHours: number | undefined;
|
|
1602
|
+
}
|
|
1603
|
+
export declare namespace DescribeOrganizationHealthResponse {
|
|
1604
|
+
/**
|
|
1605
|
+
* @internal
|
|
1606
|
+
*/
|
|
1607
|
+
const filterSensitiveLog: (obj: DescribeOrganizationHealthResponse) => any;
|
|
1608
|
+
}
|
|
1609
|
+
export interface DescribeOrganizationOverviewRequest {
|
|
1610
|
+
/**
|
|
1611
|
+
* <p> The start of the time range passed in. The start time granularity is at the day
|
|
1612
|
+
* level. The floor of the start time is used. Returned information occurred after this
|
|
1613
|
+
* day. </p>
|
|
1614
|
+
*/
|
|
1615
|
+
FromTime: Date | undefined;
|
|
1616
|
+
/**
|
|
1617
|
+
* <p> The end of the time range passed in. The start time granularity is at the day level.
|
|
1618
|
+
* The floor of the start time is used. Returned information occurred before this day. If
|
|
1619
|
+
* this is not specified, then the current day is used. </p>
|
|
1620
|
+
*/
|
|
1621
|
+
ToTime?: Date;
|
|
1622
|
+
/**
|
|
1623
|
+
* <p>The ID of the Amazon Web Services account.</p>
|
|
1624
|
+
*/
|
|
1625
|
+
AccountIds?: string[];
|
|
1626
|
+
/**
|
|
1627
|
+
* <p>The ID of the organizational unit.</p>
|
|
1628
|
+
*/
|
|
1629
|
+
OrganizationalUnitIds?: string[];
|
|
1630
|
+
}
|
|
1631
|
+
export declare namespace DescribeOrganizationOverviewRequest {
|
|
1632
|
+
/**
|
|
1633
|
+
* @internal
|
|
1634
|
+
*/
|
|
1635
|
+
const filterSensitiveLog: (obj: DescribeOrganizationOverviewRequest) => any;
|
|
1636
|
+
}
|
|
1637
|
+
export interface DescribeOrganizationOverviewResponse {
|
|
1638
|
+
/**
|
|
1639
|
+
* <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
|
|
1640
|
+
* account.</p>
|
|
1641
|
+
*/
|
|
1642
|
+
ReactiveInsights: number | undefined;
|
|
1643
|
+
/**
|
|
1644
|
+
* <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
|
|
1645
|
+
* account.</p>
|
|
1646
|
+
*/
|
|
1647
|
+
ProactiveInsights: number | undefined;
|
|
1648
|
+
}
|
|
1649
|
+
export declare namespace DescribeOrganizationOverviewResponse {
|
|
1650
|
+
/**
|
|
1651
|
+
* @internal
|
|
1652
|
+
*/
|
|
1653
|
+
const filterSensitiveLog: (obj: DescribeOrganizationOverviewResponse) => any;
|
|
1654
|
+
}
|
|
1655
|
+
export declare enum OrganizationResourceCollectionType {
|
|
1656
|
+
AWS_ACCOUNT = "AWS_ACCOUNT",
|
|
1014
1657
|
AWS_CLOUD_FORMATION = "AWS_CLOUD_FORMATION",
|
|
1015
|
-
AWS_SERVICE = "AWS_SERVICE"
|
|
1658
|
+
AWS_SERVICE = "AWS_SERVICE",
|
|
1659
|
+
AWS_TAGS = "AWS_TAGS"
|
|
1016
1660
|
}
|
|
1017
|
-
export interface
|
|
1661
|
+
export interface DescribeOrganizationResourceCollectionHealthRequest {
|
|
1018
1662
|
/**
|
|
1019
|
-
* <p>
|
|
1020
|
-
*
|
|
1021
|
-
*
|
|
1022
|
-
*
|
|
1663
|
+
* <p> An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources
|
|
1664
|
+
* are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
1665
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
1666
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
1023
1667
|
*/
|
|
1024
|
-
|
|
1668
|
+
OrganizationResourceCollectionType: OrganizationResourceCollectionType | string | undefined;
|
|
1669
|
+
/**
|
|
1670
|
+
* <p>The ID of the Amazon Web Services account.</p>
|
|
1671
|
+
*/
|
|
1672
|
+
AccountIds?: string[];
|
|
1673
|
+
/**
|
|
1674
|
+
* <p>The ID of the organizational unit.</p>
|
|
1675
|
+
*/
|
|
1676
|
+
OrganizationalUnitIds?: string[];
|
|
1025
1677
|
/**
|
|
1026
1678
|
* <p>The pagination token to use to retrieve
|
|
1027
1679
|
* the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
1028
1680
|
*/
|
|
1029
1681
|
NextToken?: string;
|
|
1682
|
+
/**
|
|
1683
|
+
* <p>The maximum number of results to return with a single call.
|
|
1684
|
+
* To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
|
|
1685
|
+
*/
|
|
1686
|
+
MaxResults?: number;
|
|
1030
1687
|
}
|
|
1031
|
-
export declare namespace
|
|
1688
|
+
export declare namespace DescribeOrganizationResourceCollectionHealthRequest {
|
|
1032
1689
|
/**
|
|
1033
1690
|
* @internal
|
|
1034
1691
|
*/
|
|
1035
|
-
const filterSensitiveLog: (obj:
|
|
1692
|
+
const filterSensitiveLog: (obj: DescribeOrganizationResourceCollectionHealthRequest) => any;
|
|
1036
1693
|
}
|
|
1037
1694
|
/**
|
|
1038
|
-
* <p>
|
|
1039
|
-
*
|
|
1040
|
-
* used to gauge the health of your system.
|
|
1041
|
-
* </p>
|
|
1695
|
+
* <p> Information about the number of open reactive and proactive insights that can be used
|
|
1696
|
+
* to gauge the health of your system. </p>
|
|
1042
1697
|
*/
|
|
1043
1698
|
export interface InsightHealth {
|
|
1044
1699
|
/**
|
|
1045
|
-
* <p>
|
|
1046
|
-
* The number of open proactive insights.
|
|
1047
|
-
* </p>
|
|
1700
|
+
* <p> The number of open proactive insights. </p>
|
|
1048
1701
|
*/
|
|
1049
1702
|
OpenProactiveInsights?: number;
|
|
1050
1703
|
/**
|
|
1051
|
-
* <p>
|
|
1052
|
-
* The number of open reactive insights.
|
|
1053
|
-
* </p>
|
|
1704
|
+
* <p> The number of open reactive insights. </p>
|
|
1054
1705
|
*/
|
|
1055
1706
|
OpenReactiveInsights?: number;
|
|
1056
1707
|
/**
|
|
1057
|
-
* <p>
|
|
1058
|
-
* The Meant Time to Recover (MTTR) for the insight.
|
|
1059
|
-
* </p>
|
|
1708
|
+
* <p> The Meant Time to Recover (MTTR) for the insight. </p>
|
|
1060
1709
|
*/
|
|
1061
1710
|
MeanTimeToRecoverInMilliseconds?: number;
|
|
1062
1711
|
}
|
|
@@ -1067,22 +1716,18 @@ export declare namespace InsightHealth {
|
|
|
1067
1716
|
const filterSensitiveLog: (obj: InsightHealth) => any;
|
|
1068
1717
|
}
|
|
1069
1718
|
/**
|
|
1070
|
-
* <p>
|
|
1071
|
-
*
|
|
1072
|
-
* </p>
|
|
1719
|
+
* <p> Information about the health of Amazon Web Services resources in your account that are specified by
|
|
1720
|
+
* an Amazon Web Services CloudFormation stack. </p>
|
|
1073
1721
|
*/
|
|
1074
1722
|
export interface CloudFormationHealth {
|
|
1075
1723
|
/**
|
|
1076
|
-
* <p>
|
|
1077
|
-
* The name of the CloudFormation stack.
|
|
1078
|
-
* </p>
|
|
1724
|
+
* <p> The name of the CloudFormation stack. </p>
|
|
1079
1725
|
*/
|
|
1080
1726
|
StackName?: string;
|
|
1081
1727
|
/**
|
|
1082
|
-
* <p>
|
|
1083
|
-
*
|
|
1084
|
-
*
|
|
1085
|
-
* </p>
|
|
1728
|
+
* <p> Information about the health of the Amazon Web Services resources in your account that are
|
|
1729
|
+
* specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive
|
|
1730
|
+
* insights, and the Mean Time to Recover (MTTR) of closed insights. </p>
|
|
1086
1731
|
*/
|
|
1087
1732
|
Insight?: InsightHealth;
|
|
1088
1733
|
}
|
|
@@ -1093,15 +1738,16 @@ export declare namespace CloudFormationHealth {
|
|
|
1093
1738
|
const filterSensitiveLog: (obj: CloudFormationHealth) => any;
|
|
1094
1739
|
}
|
|
1095
1740
|
/**
|
|
1096
|
-
* <p>Contains the number of open proactive and reactive insights in an analyzed
|
|
1741
|
+
* <p>Contains the number of open proactive and reactive insights in an analyzed Amazon Web Services
|
|
1742
|
+
* service.</p>
|
|
1097
1743
|
*/
|
|
1098
1744
|
export interface ServiceInsightHealth {
|
|
1099
1745
|
/**
|
|
1100
|
-
* <p>The number of open proactive insights in the
|
|
1746
|
+
* <p>The number of open proactive insights in the Amazon Web Services service</p>
|
|
1101
1747
|
*/
|
|
1102
1748
|
OpenProactiveInsights?: number;
|
|
1103
1749
|
/**
|
|
1104
|
-
* <p>The number of open reactive insights in the
|
|
1750
|
+
* <p>The number of open reactive insights in the Amazon Web Services service</p>
|
|
1105
1751
|
*/
|
|
1106
1752
|
OpenReactiveInsights?: number;
|
|
1107
1753
|
}
|
|
@@ -1139,16 +1785,17 @@ export declare enum ServiceName {
|
|
|
1139
1785
|
SWF = "SWF"
|
|
1140
1786
|
}
|
|
1141
1787
|
/**
|
|
1142
|
-
* <p>Represents the health of an
|
|
1788
|
+
* <p>Represents the health of an Amazon Web Services service.</p>
|
|
1143
1789
|
*/
|
|
1144
1790
|
export interface ServiceHealth {
|
|
1145
1791
|
/**
|
|
1146
|
-
* <p>The name of the
|
|
1792
|
+
* <p>The name of the Amazon Web Services service.</p>
|
|
1147
1793
|
*/
|
|
1148
1794
|
ServiceName?: ServiceName | string;
|
|
1149
1795
|
/**
|
|
1150
|
-
* <p>Represents the health of an
|
|
1151
|
-
*
|
|
1796
|
+
* <p>Represents the health of an Amazon Web Services service. This is a <code>ServiceInsightHealth</code>
|
|
1797
|
+
* that contains the number of open proactive and reactive insights for this
|
|
1798
|
+
* service.</p>
|
|
1152
1799
|
*/
|
|
1153
1800
|
Insight?: ServiceInsightHealth;
|
|
1154
1801
|
}
|
|
@@ -1158,17 +1805,150 @@ export declare namespace ServiceHealth {
|
|
|
1158
1805
|
*/
|
|
1159
1806
|
const filterSensitiveLog: (obj: ServiceHealth) => any;
|
|
1160
1807
|
}
|
|
1808
|
+
/**
|
|
1809
|
+
* <p> Information about the health of Amazon Web Services resources in your account that are specified by
|
|
1810
|
+
* an Amazon Web Services tag <i>key</i>. </p>
|
|
1811
|
+
*/
|
|
1812
|
+
export interface TagHealth {
|
|
1813
|
+
/**
|
|
1814
|
+
* <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
|
|
1815
|
+
* DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
|
|
1816
|
+
* up your DevOps Guru application and analysis boundary.</p>
|
|
1817
|
+
* <important>
|
|
1818
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
1819
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
1820
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
1821
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
1822
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
1823
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
1824
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
1825
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
1826
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
1827
|
+
* </important>
|
|
1828
|
+
*/
|
|
1829
|
+
AppBoundaryKey?: string;
|
|
1830
|
+
/**
|
|
1831
|
+
* <p>The value in an Amazon Web Services tag.</p>
|
|
1832
|
+
* <p>The tag's <i>value</i> is an optional field used to associate a string with
|
|
1833
|
+
* the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
|
|
1834
|
+
* name). The <i>key</i> and <i>value</i> are the tag's <i>key</i> pair.
|
|
1835
|
+
* Omitting the tag <i>value</i> is the same as using an empty
|
|
1836
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
1837
|
+
* case-sensitive. You can specify a maximum of 256 characters for a tag value.</p>
|
|
1838
|
+
*/
|
|
1839
|
+
TagValue?: string;
|
|
1840
|
+
/**
|
|
1841
|
+
* <p>Information about the health of the Amazon Web Services resources in your account that are
|
|
1842
|
+
* specified by an Amazon Web Services tag, including the number of open proactive, open reactive
|
|
1843
|
+
* insights, and the Mean Time to Recover (MTTR) of closed insights. </p>
|
|
1844
|
+
*/
|
|
1845
|
+
Insight?: InsightHealth;
|
|
1846
|
+
}
|
|
1847
|
+
export declare namespace TagHealth {
|
|
1848
|
+
/**
|
|
1849
|
+
* @internal
|
|
1850
|
+
*/
|
|
1851
|
+
const filterSensitiveLog: (obj: TagHealth) => any;
|
|
1852
|
+
}
|
|
1853
|
+
export interface DescribeOrganizationResourceCollectionHealthResponse {
|
|
1854
|
+
/**
|
|
1855
|
+
* <p>The returned <code>CloudFormationHealthOverview</code> object that contains an
|
|
1856
|
+
* <code>InsightHealthOverview</code> object with the requested system health
|
|
1857
|
+
* information.</p>
|
|
1858
|
+
*/
|
|
1859
|
+
CloudFormation?: CloudFormationHealth[];
|
|
1860
|
+
/**
|
|
1861
|
+
* <p>An array of <code>ServiceHealth</code> objects that describes the health of the Amazon Web Services
|
|
1862
|
+
* services associated with the resources in the collection.</p>
|
|
1863
|
+
*/
|
|
1864
|
+
Service?: ServiceHealth[];
|
|
1865
|
+
/**
|
|
1866
|
+
* <p>The name of the organization's account.</p>
|
|
1867
|
+
*/
|
|
1868
|
+
Account?: AccountHealth[];
|
|
1869
|
+
/**
|
|
1870
|
+
* <p>The pagination token to use to retrieve
|
|
1871
|
+
* the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
1872
|
+
*/
|
|
1873
|
+
NextToken?: string;
|
|
1874
|
+
/**
|
|
1875
|
+
* <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
|
|
1876
|
+
* tagging, so you can assign the same tag to resources from different services to indicate
|
|
1877
|
+
* that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB
|
|
1878
|
+
* table resource that you assign to an Lambda function. For more information about
|
|
1879
|
+
* using tags, see the <a href="https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf">Tagging
|
|
1880
|
+
* best practices</a> whitepaper. </p>
|
|
1881
|
+
* <p>Each Amazon Web Services tag has two parts. </p>
|
|
1882
|
+
* <ul>
|
|
1883
|
+
* <li>
|
|
1884
|
+
* <p>A tag <i>key</i> (for example, <code>CostCenter</code>,
|
|
1885
|
+
* <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag
|
|
1886
|
+
* <i>keys</i> are case-sensitive.</p>
|
|
1887
|
+
* </li>
|
|
1888
|
+
* <li>
|
|
1889
|
+
* <p>An optional field known as a tag <i>value</i> (for example,
|
|
1890
|
+
* <code>111122223333</code>, <code>Production</code>, or a team
|
|
1891
|
+
* name). Omitting the tag <i>value</i> is the same as using an empty
|
|
1892
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
1893
|
+
* case-sensitive.</p>
|
|
1894
|
+
* </li>
|
|
1895
|
+
* </ul>
|
|
1896
|
+
* <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p>
|
|
1897
|
+
* <important>
|
|
1898
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
1899
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
1900
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
1901
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
1902
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
1903
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
1904
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
1905
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
1906
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
1907
|
+
* </important>
|
|
1908
|
+
*/
|
|
1909
|
+
Tags?: TagHealth[];
|
|
1910
|
+
}
|
|
1911
|
+
export declare namespace DescribeOrganizationResourceCollectionHealthResponse {
|
|
1912
|
+
/**
|
|
1913
|
+
* @internal
|
|
1914
|
+
*/
|
|
1915
|
+
const filterSensitiveLog: (obj: DescribeOrganizationResourceCollectionHealthResponse) => any;
|
|
1916
|
+
}
|
|
1917
|
+
export declare enum ResourceCollectionType {
|
|
1918
|
+
AWS_CLOUD_FORMATION = "AWS_CLOUD_FORMATION",
|
|
1919
|
+
AWS_SERVICE = "AWS_SERVICE",
|
|
1920
|
+
AWS_TAGS = "AWS_TAGS"
|
|
1921
|
+
}
|
|
1922
|
+
export interface DescribeResourceCollectionHealthRequest {
|
|
1923
|
+
/**
|
|
1924
|
+
* <p> An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources
|
|
1925
|
+
* are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
1926
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
1927
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
1928
|
+
*/
|
|
1929
|
+
ResourceCollectionType: ResourceCollectionType | string | undefined;
|
|
1930
|
+
/**
|
|
1931
|
+
* <p>The pagination token to use to retrieve
|
|
1932
|
+
* the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
1933
|
+
*/
|
|
1934
|
+
NextToken?: string;
|
|
1935
|
+
}
|
|
1936
|
+
export declare namespace DescribeResourceCollectionHealthRequest {
|
|
1937
|
+
/**
|
|
1938
|
+
* @internal
|
|
1939
|
+
*/
|
|
1940
|
+
const filterSensitiveLog: (obj: DescribeResourceCollectionHealthRequest) => any;
|
|
1941
|
+
}
|
|
1161
1942
|
export interface DescribeResourceCollectionHealthResponse {
|
|
1162
1943
|
/**
|
|
1163
|
-
* <p>
|
|
1164
|
-
*
|
|
1165
|
-
*
|
|
1166
|
-
* </p>
|
|
1944
|
+
* <p> The returned <code>CloudFormationHealthOverview</code> object that contains an
|
|
1945
|
+
* <code>InsightHealthOverview</code> object with the requested system health
|
|
1946
|
+
* information. </p>
|
|
1167
1947
|
*/
|
|
1168
|
-
CloudFormation
|
|
1948
|
+
CloudFormation?: CloudFormationHealth[];
|
|
1169
1949
|
/**
|
|
1170
|
-
* <p>An array of <code>ServiceHealth</code> objects that describes the health of the
|
|
1171
|
-
*
|
|
1950
|
+
* <p>An array of <code>ServiceHealth</code> objects that describes the health of the Amazon Web Services
|
|
1951
|
+
* services associated with the resources in the collection.</p>
|
|
1172
1952
|
*/
|
|
1173
1953
|
Service?: ServiceHealth[];
|
|
1174
1954
|
/**
|
|
@@ -1176,6 +1956,43 @@ export interface DescribeResourceCollectionHealthResponse {
|
|
|
1176
1956
|
* the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
1177
1957
|
*/
|
|
1178
1958
|
NextToken?: string;
|
|
1959
|
+
/**
|
|
1960
|
+
* <p>The Amazon Web Services tags that are used by resources in the resource collection.</p>
|
|
1961
|
+
* <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
|
|
1962
|
+
* tagging, so you can assign the same tag to resources from different services to indicate
|
|
1963
|
+
* that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB
|
|
1964
|
+
* table resource that you assign to an Lambda function. For more information about
|
|
1965
|
+
* using tags, see the <a href="https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf">Tagging
|
|
1966
|
+
* best practices</a> whitepaper. </p>
|
|
1967
|
+
* <p>Each Amazon Web Services tag has two parts. </p>
|
|
1968
|
+
* <ul>
|
|
1969
|
+
* <li>
|
|
1970
|
+
* <p>A tag <i>key</i> (for example, <code>CostCenter</code>,
|
|
1971
|
+
* <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag
|
|
1972
|
+
* <i>keys</i> are case-sensitive.</p>
|
|
1973
|
+
* </li>
|
|
1974
|
+
* <li>
|
|
1975
|
+
* <p>An optional field known as a tag <i>value</i> (for example,
|
|
1976
|
+
* <code>111122223333</code>, <code>Production</code>, or a team
|
|
1977
|
+
* name). Omitting the tag <i>value</i> is the same as using an empty
|
|
1978
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
1979
|
+
* case-sensitive.</p>
|
|
1980
|
+
* </li>
|
|
1981
|
+
* </ul>
|
|
1982
|
+
* <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p>
|
|
1983
|
+
* <important>
|
|
1984
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
1985
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
1986
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
1987
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
1988
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
1989
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
1990
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
1991
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
1992
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
1993
|
+
* </important>
|
|
1994
|
+
*/
|
|
1995
|
+
Tags?: TagHealth[];
|
|
1179
1996
|
}
|
|
1180
1997
|
export declare namespace DescribeResourceCollectionHealthResponse {
|
|
1181
1998
|
/**
|
|
@@ -1196,15 +2013,13 @@ export declare enum OptInStatus {
|
|
|
1196
2013
|
ENABLED = "ENABLED"
|
|
1197
2014
|
}
|
|
1198
2015
|
/**
|
|
1199
|
-
* <p>
|
|
1200
|
-
*
|
|
1201
|
-
* </p>
|
|
2016
|
+
* <p> Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager
|
|
2017
|
+
* OpsCenter for each created insight. </p>
|
|
1202
2018
|
*/
|
|
1203
2019
|
export interface OpsCenterIntegration {
|
|
1204
2020
|
/**
|
|
1205
|
-
* <p>
|
|
1206
|
-
*
|
|
1207
|
-
* </p>
|
|
2021
|
+
* <p> Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created
|
|
2022
|
+
* insight. </p>
|
|
1208
2023
|
*/
|
|
1209
2024
|
OptInStatus?: OptInStatus | string;
|
|
1210
2025
|
}
|
|
@@ -1215,15 +2030,13 @@ export declare namespace OpsCenterIntegration {
|
|
|
1215
2030
|
const filterSensitiveLog: (obj: OpsCenterIntegration) => any;
|
|
1216
2031
|
}
|
|
1217
2032
|
/**
|
|
1218
|
-
* <p>
|
|
1219
|
-
*
|
|
1220
|
-
* </p>
|
|
2033
|
+
* <p> Information about the integration of DevOps Guru with another Amazon Web Services service, such as
|
|
2034
|
+
* Amazon Web Services Systems Manager. </p>
|
|
1221
2035
|
*/
|
|
1222
2036
|
export interface ServiceIntegrationConfig {
|
|
1223
2037
|
/**
|
|
1224
|
-
* <p>
|
|
1225
|
-
*
|
|
1226
|
-
* </p>
|
|
2038
|
+
* <p> Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager
|
|
2039
|
+
* OpsCenter for each created insight. </p>
|
|
1227
2040
|
*/
|
|
1228
2041
|
OpsCenter?: OpsCenterIntegration;
|
|
1229
2042
|
}
|
|
@@ -1235,9 +2048,8 @@ export declare namespace ServiceIntegrationConfig {
|
|
|
1235
2048
|
}
|
|
1236
2049
|
export interface DescribeServiceIntegrationResponse {
|
|
1237
2050
|
/**
|
|
1238
|
-
* <p>
|
|
1239
|
-
*
|
|
1240
|
-
* </p>
|
|
2051
|
+
* <p> Information about the integration of DevOps Guru with another Amazon Web Services service, such as
|
|
2052
|
+
* Amazon Web Services Systems Manager. </p>
|
|
1241
2053
|
*/
|
|
1242
2054
|
ServiceIntegration?: ServiceIntegrationConfig;
|
|
1243
2055
|
}
|
|
@@ -1265,23 +2077,22 @@ export declare enum CostEstimationServiceResourceState {
|
|
|
1265
2077
|
INACTIVE = "INACTIVE"
|
|
1266
2078
|
}
|
|
1267
2079
|
/**
|
|
1268
|
-
* <p>An object that contains information about the estimated monthly cost to
|
|
1269
|
-
*
|
|
2080
|
+
* <p>An object that contains information about the estimated monthly cost to analyze an
|
|
2081
|
+
* Amazon Web Services resource. For more information,
|
|
1270
2082
|
* see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html">Estimate your
|
|
1271
2083
|
* Amazon DevOps Guru costs</a> and
|
|
1272
2084
|
* <a href="http://aws.amazon.com/devops-guru/pricing/">Amazon DevOps Guru pricing</a>.</p>
|
|
1273
2085
|
*/
|
|
1274
2086
|
export interface ServiceResourceCost {
|
|
1275
2087
|
/**
|
|
1276
|
-
* <p>The type of the
|
|
2088
|
+
* <p>The type of the Amazon Web Services resource.</p>
|
|
1277
2089
|
*/
|
|
1278
2090
|
Type?: string;
|
|
1279
2091
|
/**
|
|
1280
2092
|
* <p>The state of the resource. The resource is <code>ACTIVE</code> if it produces metrics,
|
|
1281
|
-
* events, or logs within an hour, otherwise it is <code>INACTIVE</code>. You pay for
|
|
1282
|
-
*
|
|
1283
|
-
* not charged.
|
|
1284
|
-
* </p>
|
|
2093
|
+
* events, or logs within an hour, otherwise it is <code>INACTIVE</code>. You pay for the
|
|
2094
|
+
* number of active Amazon Web Services resource hours analyzed for each resource. Inactive resources are
|
|
2095
|
+
* not charged. </p>
|
|
1285
2096
|
*/
|
|
1286
2097
|
State?: CostEstimationServiceResourceState | string;
|
|
1287
2098
|
/**
|
|
@@ -1298,7 +2109,8 @@ export interface ServiceResourceCost {
|
|
|
1298
2109
|
*/
|
|
1299
2110
|
UnitCost?: number;
|
|
1300
2111
|
/**
|
|
1301
|
-
* <p>The total estimated monthly cost to analyze the active resources for this
|
|
2112
|
+
* <p>The total estimated monthly cost to analyze the active resources for this
|
|
2113
|
+
* resource.</p>
|
|
1302
2114
|
*/
|
|
1303
2115
|
Cost?: number;
|
|
1304
2116
|
}
|
|
@@ -1309,10 +2121,11 @@ export declare namespace ServiceResourceCost {
|
|
|
1309
2121
|
const filterSensitiveLog: (obj: ServiceResourceCost) => any;
|
|
1310
2122
|
}
|
|
1311
2123
|
/**
|
|
1312
|
-
* <p>Information about an
|
|
1313
|
-
*
|
|
1314
|
-
*
|
|
1315
|
-
*
|
|
2124
|
+
* <p>Information about an Amazon Web Services CloudFormation stack used to create a monthly cost estimate
|
|
2125
|
+
* for DevOps Guru to analyze Amazon Web Services resources. The maximum number of stacks you can specify for a
|
|
2126
|
+
* cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services
|
|
2127
|
+
* resources defined by the stack. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Stacks</a> in the
|
|
2128
|
+
* <i>Amazon Web Services CloudFormation User Guide</i>.</p>
|
|
1316
2129
|
*/
|
|
1317
2130
|
export interface CloudFormationCostEstimationResourceCollectionFilter {
|
|
1318
2131
|
/**
|
|
@@ -1327,19 +2140,99 @@ export declare namespace CloudFormationCostEstimationResourceCollectionFilter {
|
|
|
1327
2140
|
const filterSensitiveLog: (obj: CloudFormationCostEstimationResourceCollectionFilter) => any;
|
|
1328
2141
|
}
|
|
1329
2142
|
/**
|
|
1330
|
-
* <p>Information about a
|
|
1331
|
-
*
|
|
2143
|
+
* <p>Information about a collection of Amazon Web Services resources that are identified by an
|
|
2144
|
+
* Amazon Web Services tag. This collection of resources is used to create a monthly cost estimate
|
|
2145
|
+
* for DevOps Guru to analyze Amazon Web Services resources. The maximum number of tags you can specify for a
|
|
2146
|
+
* cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services
|
|
2147
|
+
* resources defined by the tag. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Stacks</a> in the
|
|
2148
|
+
* <i>Amazon Web Services CloudFormation User Guide</i>.</p>
|
|
2149
|
+
*/
|
|
2150
|
+
export interface TagCostEstimationResourceCollectionFilter {
|
|
2151
|
+
/**
|
|
2152
|
+
* <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
|
|
2153
|
+
* DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
|
|
2154
|
+
* up your DevOps Guru application and analysis boundary.</p>
|
|
2155
|
+
* <important>
|
|
2156
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
2157
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
2158
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
2159
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
2160
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
2161
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
2162
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
2163
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
2164
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
2165
|
+
* </important>
|
|
2166
|
+
*/
|
|
2167
|
+
AppBoundaryKey: string | undefined;
|
|
2168
|
+
/**
|
|
2169
|
+
* <p>The values in an Amazon Web Services tag collection.</p>
|
|
2170
|
+
* <p>The tag's <i>value</i> is an optional field used to associate a string with
|
|
2171
|
+
* the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
|
|
2172
|
+
* name). The <i>key</i> and <i>value</i> are the tag's <i>key</i> pair.
|
|
2173
|
+
* Omitting the tag <i>value</i> is the same as using an empty
|
|
2174
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
2175
|
+
* case-sensitive. You can specify a maximum of 256 characters for a tag value.</p>
|
|
2176
|
+
*/
|
|
2177
|
+
TagValues: string[] | undefined;
|
|
2178
|
+
}
|
|
2179
|
+
export declare namespace TagCostEstimationResourceCollectionFilter {
|
|
2180
|
+
/**
|
|
2181
|
+
* @internal
|
|
2182
|
+
*/
|
|
2183
|
+
const filterSensitiveLog: (obj: TagCostEstimationResourceCollectionFilter) => any;
|
|
2184
|
+
}
|
|
2185
|
+
/**
|
|
2186
|
+
* <p>Information about a filter used to specify which Amazon Web Services resources are analyzed to
|
|
2187
|
+
* create a monthly DevOps Guru cost estimate. For more information,
|
|
1332
2188
|
* see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/cost-estimate.html">Estimate your
|
|
1333
2189
|
* Amazon DevOps Guru costs</a> and
|
|
1334
|
-
* <a href="http://aws.amazon.com/devops-guru/pricing/">Amazon DevOps Guru pricing</a>.
|
|
1335
|
-
* </p>
|
|
2190
|
+
* <a href="http://aws.amazon.com/devops-guru/pricing/">Amazon DevOps Guru pricing</a>. </p>
|
|
1336
2191
|
*/
|
|
1337
2192
|
export interface CostEstimationResourceCollectionFilter {
|
|
1338
2193
|
/**
|
|
1339
|
-
* <p>An object that specifies the CloudFormation stack that defines the
|
|
2194
|
+
* <p>An object that specifies the CloudFormation stack that defines the Amazon Web Services resources
|
|
1340
2195
|
* used to create a monthly estimate for DevOps Guru.</p>
|
|
1341
2196
|
*/
|
|
1342
2197
|
CloudFormation?: CloudFormationCostEstimationResourceCollectionFilter;
|
|
2198
|
+
/**
|
|
2199
|
+
* <p>The Amazon Web Services tags used to filter the resource collection that is used for
|
|
2200
|
+
* a cost estimate.</p>
|
|
2201
|
+
* <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
|
|
2202
|
+
* tagging, so you can assign the same tag to resources from different services to indicate
|
|
2203
|
+
* that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB
|
|
2204
|
+
* table resource that you assign to an Lambda function. For more information about
|
|
2205
|
+
* using tags, see the <a href="https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf">Tagging
|
|
2206
|
+
* best practices</a> whitepaper. </p>
|
|
2207
|
+
* <p>Each Amazon Web Services tag has two parts. </p>
|
|
2208
|
+
* <ul>
|
|
2209
|
+
* <li>
|
|
2210
|
+
* <p>A tag <i>key</i> (for example, <code>CostCenter</code>,
|
|
2211
|
+
* <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag
|
|
2212
|
+
* <i>keys</i> are case-sensitive.</p>
|
|
2213
|
+
* </li>
|
|
2214
|
+
* <li>
|
|
2215
|
+
* <p>An optional field known as a tag <i>value</i> (for example,
|
|
2216
|
+
* <code>111122223333</code>, <code>Production</code>, or a team
|
|
2217
|
+
* name). Omitting the tag <i>value</i> is the same as using an empty
|
|
2218
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
2219
|
+
* case-sensitive.</p>
|
|
2220
|
+
* </li>
|
|
2221
|
+
* </ul>
|
|
2222
|
+
* <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p>
|
|
2223
|
+
* <important>
|
|
2224
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
2225
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
2226
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
2227
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
2228
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
2229
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
2230
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
2231
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
2232
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
2233
|
+
* </important>
|
|
2234
|
+
*/
|
|
2235
|
+
Tags?: TagCostEstimationResourceCollectionFilter[];
|
|
1343
2236
|
}
|
|
1344
2237
|
export declare namespace CostEstimationResourceCollectionFilter {
|
|
1345
2238
|
/**
|
|
@@ -1372,17 +2265,19 @@ export declare namespace CostEstimationTimeRange {
|
|
|
1372
2265
|
}
|
|
1373
2266
|
export interface GetCostEstimationResponse {
|
|
1374
2267
|
/**
|
|
1375
|
-
* <p>The collection of the
|
|
2268
|
+
* <p>The collection of the Amazon Web Services resources used to create your monthly DevOps Guru cost
|
|
2269
|
+
* estimate.</p>
|
|
1376
2270
|
*/
|
|
1377
2271
|
ResourceCollection?: CostEstimationResourceCollectionFilter;
|
|
1378
2272
|
/**
|
|
1379
2273
|
* <p>The status of creating this cost estimate. If it's still in progress, the status
|
|
1380
|
-
*
|
|
2274
|
+
* <code>ONGOING</code> is returned. If it is finished, the status
|
|
2275
|
+
* <code>COMPLETED</code> is returned.</p>
|
|
1381
2276
|
*/
|
|
1382
2277
|
Status?: CostEstimationStatus | string;
|
|
1383
2278
|
/**
|
|
1384
|
-
* <p>An array of <code>ResourceCost</code> objects that each contains details
|
|
1385
|
-
*
|
|
2279
|
+
* <p>An array of <code>ResourceCost</code> objects that each contains details about the
|
|
2280
|
+
* monthly cost estimate to analyze one of your Amazon Web Services resources.</p>
|
|
1386
2281
|
*/
|
|
1387
2282
|
Costs?: ServiceResourceCost[];
|
|
1388
2283
|
/**
|
|
@@ -1390,9 +2285,9 @@ export interface GetCostEstimationResponse {
|
|
|
1390
2285
|
*/
|
|
1391
2286
|
TimeRange?: CostEstimationTimeRange;
|
|
1392
2287
|
/**
|
|
1393
|
-
* <p>The estimated monthly cost to analyze the
|
|
1394
|
-
*
|
|
1395
|
-
*
|
|
2288
|
+
* <p>The estimated monthly cost to analyze the Amazon Web Services resources. This value is the sum of
|
|
2289
|
+
* the estimated costs to analyze each resource in the <code>Costs</code> object in this
|
|
2290
|
+
* response.</p>
|
|
1396
2291
|
*/
|
|
1397
2292
|
TotalCost?: number;
|
|
1398
2293
|
/**
|
|
@@ -1409,10 +2304,8 @@ export declare namespace GetCostEstimationResponse {
|
|
|
1409
2304
|
}
|
|
1410
2305
|
export interface GetResourceCollectionRequest {
|
|
1411
2306
|
/**
|
|
1412
|
-
* <p>
|
|
1413
|
-
*
|
|
1414
|
-
* AWS CloudFormation stacks.
|
|
1415
|
-
* </p>
|
|
2307
|
+
* <p> The type of Amazon Web Services resource collections to return. The one valid value is
|
|
2308
|
+
* <code>CLOUD_FORMATION</code> for Amazon Web Services CloudFormation stacks. </p>
|
|
1416
2309
|
*/
|
|
1417
2310
|
ResourceCollectionType: ResourceCollectionType | string | undefined;
|
|
1418
2311
|
/**
|
|
@@ -1428,17 +2321,14 @@ export declare namespace GetResourceCollectionRequest {
|
|
|
1428
2321
|
const filterSensitiveLog: (obj: GetResourceCollectionRequest) => any;
|
|
1429
2322
|
}
|
|
1430
2323
|
/**
|
|
1431
|
-
* <p>
|
|
1432
|
-
*
|
|
1433
|
-
*
|
|
1434
|
-
*
|
|
1435
|
-
* </p>
|
|
2324
|
+
* <p> Information about Amazon Web Services CloudFormation stacks. You can use up to 500
|
|
2325
|
+
* stacks to specify which Amazon Web Services resources in your account to analyze. For more
|
|
2326
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Stacks</a> in the
|
|
2327
|
+
* <i>Amazon Web Services CloudFormation User Guide</i>. </p>
|
|
1436
2328
|
*/
|
|
1437
2329
|
export interface CloudFormationCollectionFilter {
|
|
1438
2330
|
/**
|
|
1439
|
-
* <p>
|
|
1440
|
-
* An array of CloudFormation stack names.
|
|
1441
|
-
* </p>
|
|
2331
|
+
* <p> An array of CloudFormation stack names. </p>
|
|
1442
2332
|
*/
|
|
1443
2333
|
StackNames?: string[];
|
|
1444
2334
|
}
|
|
@@ -1449,19 +2339,93 @@ export declare namespace CloudFormationCollectionFilter {
|
|
|
1449
2339
|
const filterSensitiveLog: (obj: CloudFormationCollectionFilter) => any;
|
|
1450
2340
|
}
|
|
1451
2341
|
/**
|
|
1452
|
-
* <p>
|
|
1453
|
-
*
|
|
1454
|
-
|
|
2342
|
+
* <p>A collection of Amazon Web Services tags used to filter insights. This is used to return insights generated from
|
|
2343
|
+
* only resources that contain the tags in the tag collection.</p>
|
|
2344
|
+
*/
|
|
2345
|
+
export interface TagCollectionFilter {
|
|
2346
|
+
/**
|
|
2347
|
+
* <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
|
|
2348
|
+
* DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
|
|
2349
|
+
* up your DevOps Guru application and analysis boundary.</p>
|
|
2350
|
+
* <important>
|
|
2351
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
2352
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
2353
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
2354
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
2355
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
2356
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
2357
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
2358
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
2359
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
2360
|
+
* </important>
|
|
2361
|
+
*/
|
|
2362
|
+
AppBoundaryKey: string | undefined;
|
|
2363
|
+
/**
|
|
2364
|
+
* <p>The values in an Amazon Web Services tag collection.</p>
|
|
2365
|
+
* <p>The tag's <i>value</i> is an optional field used to associate a string with
|
|
2366
|
+
* the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
|
|
2367
|
+
* name). The <i>key</i> and <i>value</i> are the tag's <i>key</i> pair.
|
|
2368
|
+
* Omitting the tag <i>value</i> is the same as using an empty
|
|
2369
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
2370
|
+
* case-sensitive. You can specify a maximum of 256 characters for a tag value.</p>
|
|
2371
|
+
*/
|
|
2372
|
+
TagValues: string[] | undefined;
|
|
2373
|
+
}
|
|
2374
|
+
export declare namespace TagCollectionFilter {
|
|
2375
|
+
/**
|
|
2376
|
+
* @internal
|
|
2377
|
+
*/
|
|
2378
|
+
const filterSensitiveLog: (obj: TagCollectionFilter) => any;
|
|
2379
|
+
}
|
|
2380
|
+
/**
|
|
2381
|
+
* <p> Information about a filter used to specify which Amazon Web Services resources are analyzed for
|
|
2382
|
+
* anomalous behavior by DevOps Guru. </p>
|
|
1455
2383
|
*/
|
|
1456
2384
|
export interface ResourceCollectionFilter {
|
|
1457
2385
|
/**
|
|
1458
|
-
* <p>
|
|
1459
|
-
*
|
|
1460
|
-
*
|
|
1461
|
-
*
|
|
1462
|
-
* </p>
|
|
2386
|
+
* <p> Information about Amazon Web Services CloudFormation stacks. You can use up to 500
|
|
2387
|
+
* stacks to specify which Amazon Web Services resources in your account to analyze. For more
|
|
2388
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacks.html">Stacks</a> in the
|
|
2389
|
+
* <i>Amazon Web Services CloudFormation User Guide</i>. </p>
|
|
1463
2390
|
*/
|
|
1464
2391
|
CloudFormation?: CloudFormationCollectionFilter;
|
|
2392
|
+
/**
|
|
2393
|
+
* <p>The Amazon Web Services tags used to filter the resources in the resource collection.</p>
|
|
2394
|
+
* <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
|
|
2395
|
+
* tagging, so you can assign the same tag to resources from different services to indicate
|
|
2396
|
+
* that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB
|
|
2397
|
+
* table resource that you assign to an Lambda function. For more information about
|
|
2398
|
+
* using tags, see the <a href="https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf">Tagging
|
|
2399
|
+
* best practices</a> whitepaper. </p>
|
|
2400
|
+
* <p>Each Amazon Web Services tag has two parts. </p>
|
|
2401
|
+
* <ul>
|
|
2402
|
+
* <li>
|
|
2403
|
+
* <p>A tag <i>key</i> (for example, <code>CostCenter</code>,
|
|
2404
|
+
* <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag
|
|
2405
|
+
* <i>keys</i> are case-sensitive.</p>
|
|
2406
|
+
* </li>
|
|
2407
|
+
* <li>
|
|
2408
|
+
* <p>An optional field known as a tag <i>value</i> (for example,
|
|
2409
|
+
* <code>111122223333</code>, <code>Production</code>, or a team
|
|
2410
|
+
* name). Omitting the tag <i>value</i> is the same as using an empty
|
|
2411
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
2412
|
+
* case-sensitive.</p>
|
|
2413
|
+
* </li>
|
|
2414
|
+
* </ul>
|
|
2415
|
+
* <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p>
|
|
2416
|
+
* <important>
|
|
2417
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
2418
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
2419
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
2420
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
2421
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
2422
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
2423
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
2424
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
2425
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
2426
|
+
* </important>
|
|
2427
|
+
*/
|
|
2428
|
+
Tags?: TagCollectionFilter[];
|
|
1465
2429
|
}
|
|
1466
2430
|
export declare namespace ResourceCollectionFilter {
|
|
1467
2431
|
/**
|
|
@@ -1471,10 +2435,10 @@ export declare namespace ResourceCollectionFilter {
|
|
|
1471
2435
|
}
|
|
1472
2436
|
export interface GetResourceCollectionResponse {
|
|
1473
2437
|
/**
|
|
1474
|
-
* <p>
|
|
1475
|
-
*
|
|
1476
|
-
*
|
|
1477
|
-
*
|
|
2438
|
+
* <p> The requested list of Amazon Web Services resource collections.
|
|
2439
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
2440
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
2441
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
1478
2442
|
*/
|
|
1479
2443
|
ResourceCollection?: ResourceCollectionFilter;
|
|
1480
2444
|
/**
|
|
@@ -1490,21 +2454,16 @@ export declare namespace GetResourceCollectionResponse {
|
|
|
1490
2454
|
const filterSensitiveLog: (obj: GetResourceCollectionResponse) => any;
|
|
1491
2455
|
}
|
|
1492
2456
|
/**
|
|
1493
|
-
* <p>
|
|
1494
|
-
* A time range used to specify when the behavior of an insight or anomaly started.
|
|
2457
|
+
* <p> A time range used to specify when the behavior of an insight or anomaly started.
|
|
1495
2458
|
* </p>
|
|
1496
2459
|
*/
|
|
1497
2460
|
export interface StartTimeRange {
|
|
1498
2461
|
/**
|
|
1499
|
-
* <p>
|
|
1500
|
-
* The start time of the time range.
|
|
1501
|
-
* </p>
|
|
2462
|
+
* <p> The start time of the time range. </p>
|
|
1502
2463
|
*/
|
|
1503
2464
|
FromTime?: Date;
|
|
1504
2465
|
/**
|
|
1505
|
-
* <p>
|
|
1506
|
-
* The end time of the time range.
|
|
1507
|
-
* </p>
|
|
2466
|
+
* <p> The end time of the time range. </p>
|
|
1508
2467
|
*/
|
|
1509
2468
|
ToTime?: Date;
|
|
1510
2469
|
}
|
|
@@ -1516,16 +2475,12 @@ export declare namespace StartTimeRange {
|
|
|
1516
2475
|
}
|
|
1517
2476
|
export interface ListAnomaliesForInsightRequest {
|
|
1518
2477
|
/**
|
|
1519
|
-
* <p>
|
|
1520
|
-
* The ID of the insight. The returned anomalies belong to this insight.
|
|
1521
|
-
* </p>
|
|
2478
|
+
* <p> The ID of the insight. The returned anomalies belong to this insight. </p>
|
|
1522
2479
|
*/
|
|
1523
2480
|
InsightId: string | undefined;
|
|
1524
2481
|
/**
|
|
1525
|
-
* <p>
|
|
1526
|
-
*
|
|
1527
|
-
* during this time range.
|
|
1528
|
-
* </p>
|
|
2482
|
+
* <p> A time range used to specify when the requested anomalies started. All returned
|
|
2483
|
+
* anomalies started during this time range. </p>
|
|
1529
2484
|
*/
|
|
1530
2485
|
StartTimeRange?: StartTimeRange;
|
|
1531
2486
|
/**
|
|
@@ -1538,6 +2493,10 @@ export interface ListAnomaliesForInsightRequest {
|
|
|
1538
2493
|
* the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
1539
2494
|
*/
|
|
1540
2495
|
NextToken?: string;
|
|
2496
|
+
/**
|
|
2497
|
+
* <p>The ID of the Amazon Web Services account. </p>
|
|
2498
|
+
*/
|
|
2499
|
+
AccountId?: string;
|
|
1541
2500
|
}
|
|
1542
2501
|
export declare namespace ListAnomaliesForInsightRequest {
|
|
1543
2502
|
/**
|
|
@@ -1547,7 +2506,7 @@ export declare namespace ListAnomaliesForInsightRequest {
|
|
|
1547
2506
|
}
|
|
1548
2507
|
/**
|
|
1549
2508
|
* <p>Details about a proactive anomaly. This object is returned by
|
|
1550
|
-
*
|
|
2509
|
+
* <code>DescribeAnomaly.</code>
|
|
1551
2510
|
* </p>
|
|
1552
2511
|
*/
|
|
1553
2512
|
export interface ProactiveAnomalySummary {
|
|
@@ -1556,7 +2515,10 @@ export interface ProactiveAnomalySummary {
|
|
|
1556
2515
|
*/
|
|
1557
2516
|
Id?: string;
|
|
1558
2517
|
/**
|
|
1559
|
-
* <p>The severity of the anomaly
|
|
2518
|
+
* <p>The severity of the anomaly. The severity of anomalies that generate
|
|
2519
|
+
* an insight determine that insight's severity. For more information, see
|
|
2520
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
2521
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
1560
2522
|
*/
|
|
1561
2523
|
Severity?: AnomalySeverity | string;
|
|
1562
2524
|
/**
|
|
@@ -1564,55 +2526,46 @@ export interface ProactiveAnomalySummary {
|
|
|
1564
2526
|
*/
|
|
1565
2527
|
Status?: AnomalyStatus | string;
|
|
1566
2528
|
/**
|
|
1567
|
-
* <p>
|
|
1568
|
-
* The time of the anomaly's most recent update.
|
|
1569
|
-
* </p>
|
|
2529
|
+
* <p> The time of the anomaly's most recent update. </p>
|
|
1570
2530
|
*/
|
|
1571
2531
|
UpdateTime?: Date;
|
|
1572
2532
|
/**
|
|
1573
|
-
* <p>
|
|
1574
|
-
*
|
|
1575
|
-
*
|
|
1576
|
-
* an anomaly.
|
|
1577
|
-
* </p>
|
|
2533
|
+
* <p> A time range that specifies when the observed unusual behavior in an anomaly started
|
|
2534
|
+
* and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies
|
|
2535
|
+
* the time range when DevOps Guru opens and then closes an anomaly. </p>
|
|
1578
2536
|
*/
|
|
1579
2537
|
AnomalyTimeRange?: AnomalyTimeRange;
|
|
1580
2538
|
/**
|
|
1581
2539
|
* <p>
|
|
1582
|
-
*
|
|
2540
|
+
* An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed.
|
|
1583
2541
|
* </p>
|
|
1584
2542
|
*/
|
|
1585
2543
|
AnomalyReportedTimeRange?: AnomalyReportedTimeRange;
|
|
1586
2544
|
/**
|
|
1587
|
-
* <p>
|
|
1588
|
-
*
|
|
1589
|
-
* </p>
|
|
2545
|
+
* <p> The time range during which anomalous behavior in a proactive anomaly or an insight
|
|
2546
|
+
* is expected to occur. </p>
|
|
1590
2547
|
*/
|
|
1591
2548
|
PredictionTimeRange?: PredictionTimeRange;
|
|
1592
2549
|
/**
|
|
1593
|
-
* <p>
|
|
1594
|
-
*
|
|
1595
|
-
* </p>
|
|
2550
|
+
* <p> Details about the source of the analyzed operational data that triggered the anomaly.
|
|
2551
|
+
* The one supported source is Amazon CloudWatch metrics. </p>
|
|
1596
2552
|
*/
|
|
1597
2553
|
SourceDetails?: AnomalySourceDetails;
|
|
1598
2554
|
/**
|
|
1599
|
-
* <p>
|
|
1600
|
-
*
|
|
1601
|
-
* </p>
|
|
2555
|
+
* <p> The ID of the insight that contains this anomaly. An insight is composed of related
|
|
2556
|
+
* anomalies. </p>
|
|
1602
2557
|
*/
|
|
1603
2558
|
AssociatedInsightId?: string;
|
|
1604
2559
|
/**
|
|
1605
|
-
* <p>
|
|
1606
|
-
*
|
|
1607
|
-
*
|
|
1608
|
-
*
|
|
2560
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
2561
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
2562
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
2563
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
1609
2564
|
*/
|
|
1610
2565
|
ResourceCollection?: ResourceCollection;
|
|
1611
2566
|
/**
|
|
1612
|
-
* <p>
|
|
1613
|
-
*
|
|
1614
|
-
* threshold is related to the anomalous behavior that generated this anomaly.
|
|
1615
|
-
* </p>
|
|
2567
|
+
* <p> A threshold that was exceeded by behavior in analyzed resources. Exceeding this
|
|
2568
|
+
* threshold is related to the anomalous behavior that generated this anomaly. </p>
|
|
1616
2569
|
*/
|
|
1617
2570
|
Limit?: number;
|
|
1618
2571
|
}
|
|
@@ -1624,61 +2577,85 @@ export declare namespace ProactiveAnomalySummary {
|
|
|
1624
2577
|
}
|
|
1625
2578
|
/**
|
|
1626
2579
|
* <p>Details about a reactive anomaly. This object is returned by
|
|
1627
|
-
*
|
|
2580
|
+
* <code>DescribeAnomaly.</code>
|
|
1628
2581
|
* </p>
|
|
1629
2582
|
*/
|
|
1630
2583
|
export interface ReactiveAnomalySummary {
|
|
1631
2584
|
/**
|
|
1632
|
-
* <p>
|
|
1633
|
-
* The ID of the reactive anomaly.
|
|
1634
|
-
* </p>
|
|
2585
|
+
* <p> The ID of the reactive anomaly. </p>
|
|
1635
2586
|
*/
|
|
1636
2587
|
Id?: string;
|
|
1637
2588
|
/**
|
|
1638
|
-
* <p>
|
|
1639
|
-
*
|
|
1640
|
-
*
|
|
2589
|
+
* <p>The severity of the anomaly. The severity of anomalies that generate
|
|
2590
|
+
* an insight determine that insight's severity. For more information, see
|
|
2591
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
2592
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
1641
2593
|
*/
|
|
1642
2594
|
Severity?: AnomalySeverity | string;
|
|
1643
2595
|
/**
|
|
1644
|
-
* <p>
|
|
1645
|
-
* The status of the reactive anomaly.
|
|
1646
|
-
* </p>
|
|
2596
|
+
* <p> The status of the reactive anomaly. </p>
|
|
1647
2597
|
*/
|
|
1648
2598
|
Status?: AnomalyStatus | string;
|
|
1649
2599
|
/**
|
|
1650
|
-
* <p>
|
|
1651
|
-
*
|
|
1652
|
-
*
|
|
1653
|
-
* an anomaly.
|
|
1654
|
-
* </p>
|
|
2600
|
+
* <p> A time range that specifies when the observed unusual behavior in an anomaly started
|
|
2601
|
+
* and ended. This is different from <code>AnomalyReportedTimeRange</code>, which specifies
|
|
2602
|
+
* the time range when DevOps Guru opens and then closes an anomaly. </p>
|
|
1655
2603
|
*/
|
|
1656
2604
|
AnomalyTimeRange?: AnomalyTimeRange;
|
|
1657
2605
|
/**
|
|
1658
2606
|
* <p>
|
|
1659
|
-
*
|
|
2607
|
+
* An <code>AnomalyReportedTimeRange</code> object that specifies the time range between when the anomaly is opened and the time when it is closed.
|
|
1660
2608
|
* </p>
|
|
1661
2609
|
*/
|
|
1662
2610
|
AnomalyReportedTimeRange?: AnomalyReportedTimeRange;
|
|
1663
2611
|
/**
|
|
1664
|
-
* <p>
|
|
1665
|
-
*
|
|
1666
|
-
* </p>
|
|
2612
|
+
* <p> Details about the source of the analyzed operational data that triggered the anomaly.
|
|
2613
|
+
* The one supported source is Amazon CloudWatch metrics. </p>
|
|
1667
2614
|
*/
|
|
1668
2615
|
SourceDetails?: AnomalySourceDetails;
|
|
1669
2616
|
/**
|
|
1670
|
-
* <p>
|
|
1671
|
-
*
|
|
1672
|
-
* </p>
|
|
2617
|
+
* <p> The ID of the insight that contains this anomaly. An insight is composed of related
|
|
2618
|
+
* anomalies. </p>
|
|
1673
2619
|
*/
|
|
1674
2620
|
AssociatedInsightId?: string;
|
|
1675
2621
|
/**
|
|
1676
|
-
* <p>
|
|
1677
|
-
*
|
|
1678
|
-
*
|
|
1679
|
-
*
|
|
2622
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
2623
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
2624
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
2625
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
1680
2626
|
*/
|
|
1681
2627
|
ResourceCollection?: ResourceCollection;
|
|
2628
|
+
/**
|
|
2629
|
+
* <p>The type of the reactive anomaly. It can be one of the following types.</p>
|
|
2630
|
+
* <ul>
|
|
2631
|
+
* <li>
|
|
2632
|
+
* <p>
|
|
2633
|
+
* <code>CAUSAL</code> - the anomaly can cause a new insight.</p>
|
|
2634
|
+
* </li>
|
|
2635
|
+
* <li>
|
|
2636
|
+
* <p>
|
|
2637
|
+
* <code>CONTEXTUAL</code> - the anomaly contains additional information about an insight or its causal anomaly.</p>
|
|
2638
|
+
* </li>
|
|
2639
|
+
* </ul>
|
|
2640
|
+
*/
|
|
2641
|
+
Type?: AnomalyType | string;
|
|
2642
|
+
/**
|
|
2643
|
+
* <p>The name of the reactive anomaly.</p>
|
|
2644
|
+
*/
|
|
2645
|
+
Name?: string;
|
|
2646
|
+
/**
|
|
2647
|
+
* <p>A description of the reactive anomaly.</p>
|
|
2648
|
+
*/
|
|
2649
|
+
Description?: string;
|
|
2650
|
+
/**
|
|
2651
|
+
* <p>The ID of the causal anomaly that is associated with this
|
|
2652
|
+
* reactive anomaly. The ID of a `CAUSAL` anomaly is always `NULL`.</p>
|
|
2653
|
+
*/
|
|
2654
|
+
CausalAnomalyId?: string;
|
|
2655
|
+
/**
|
|
2656
|
+
* <p>The Amazon Web Services resources in which anomalous behavior was detected by DevOps Guru.</p>
|
|
2657
|
+
*/
|
|
2658
|
+
AnomalyResources?: AnomalyResource[];
|
|
1682
2659
|
}
|
|
1683
2660
|
export declare namespace ReactiveAnomalySummary {
|
|
1684
2661
|
/**
|
|
@@ -1688,15 +2665,13 @@ export declare namespace ReactiveAnomalySummary {
|
|
|
1688
2665
|
}
|
|
1689
2666
|
export interface ListAnomaliesForInsightResponse {
|
|
1690
2667
|
/**
|
|
1691
|
-
* <p>
|
|
1692
|
-
*
|
|
1693
|
-
* </p>
|
|
2668
|
+
* <p> An array of <code>ProactiveAnomalySummary</code> objects that represent the requested
|
|
2669
|
+
* anomalies </p>
|
|
1694
2670
|
*/
|
|
1695
2671
|
ProactiveAnomalies?: ProactiveAnomalySummary[];
|
|
1696
2672
|
/**
|
|
1697
|
-
* <p>
|
|
1698
|
-
*
|
|
1699
|
-
* </p>
|
|
2673
|
+
* <p> An array of <code>ReactiveAnomalySummary</code> objects that represent the requested
|
|
2674
|
+
* anomalies </p>
|
|
1700
2675
|
*/
|
|
1701
2676
|
ReactiveAnomalies?: ReactiveAnomalySummary[];
|
|
1702
2677
|
/**
|
|
@@ -1723,22 +2698,17 @@ export declare enum EventClass {
|
|
|
1723
2698
|
SECURITY_CHANGE = "SECURITY_CHANGE"
|
|
1724
2699
|
}
|
|
1725
2700
|
/**
|
|
1726
|
-
* <p>
|
|
1727
|
-
*
|
|
1728
|
-
*
|
|
1729
|
-
* </p>
|
|
2701
|
+
* <p> The time range during which an Amazon Web Services event occurred. Amazon Web Services resource events and
|
|
2702
|
+
* metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to
|
|
2703
|
+
* improve your operational solutions. </p>
|
|
1730
2704
|
*/
|
|
1731
2705
|
export interface EventTimeRange {
|
|
1732
2706
|
/**
|
|
1733
|
-
* <p>
|
|
1734
|
-
* The time when the event started.
|
|
1735
|
-
* </p>
|
|
2707
|
+
* <p> The time when the event started. </p>
|
|
1736
2708
|
*/
|
|
1737
2709
|
FromTime: Date | undefined;
|
|
1738
2710
|
/**
|
|
1739
|
-
* <p>
|
|
1740
|
-
* The time when the event ended.
|
|
1741
|
-
* </p>
|
|
2711
|
+
* <p> The time when the event ended. </p>
|
|
1742
2712
|
*/
|
|
1743
2713
|
ToTime: Date | undefined;
|
|
1744
2714
|
}
|
|
@@ -1749,15 +2719,12 @@ export declare namespace EventTimeRange {
|
|
|
1749
2719
|
const filterSensitiveLog: (obj: EventTimeRange) => any;
|
|
1750
2720
|
}
|
|
1751
2721
|
/**
|
|
1752
|
-
* <p>
|
|
1753
|
-
*
|
|
1754
|
-
* </p>
|
|
2722
|
+
* <p> Filters you can use to specify which events are returned when <code>ListEvents</code>
|
|
2723
|
+
* is called. </p>
|
|
1755
2724
|
*/
|
|
1756
2725
|
export interface ListEventsFilters {
|
|
1757
2726
|
/**
|
|
1758
|
-
* <p>
|
|
1759
|
-
* An ID of an insight that is related to the events you want to filter for.
|
|
1760
|
-
* </p>
|
|
2727
|
+
* <p> An ID of an insight that is related to the events you want to filter for. </p>
|
|
1761
2728
|
*/
|
|
1762
2729
|
InsightId?: string;
|
|
1763
2730
|
/**
|
|
@@ -1765,28 +2732,24 @@ export interface ListEventsFilters {
|
|
|
1765
2732
|
*/
|
|
1766
2733
|
EventTimeRange?: EventTimeRange;
|
|
1767
2734
|
/**
|
|
1768
|
-
* <p>
|
|
1769
|
-
*
|
|
1770
|
-
* </p>
|
|
2735
|
+
* <p> The class of the events you want to filter for, such as an infrastructure change, a
|
|
2736
|
+
* deployment, or a schema change. </p>
|
|
1771
2737
|
*/
|
|
1772
2738
|
EventClass?: EventClass | string;
|
|
1773
2739
|
/**
|
|
1774
|
-
* <p>
|
|
1775
|
-
* The AWS source that emitted the events you want to filter for.
|
|
1776
|
-
* </p>
|
|
2740
|
+
* <p> The Amazon Web Services source that emitted the events you want to filter for. </p>
|
|
1777
2741
|
*/
|
|
1778
2742
|
EventSource?: string;
|
|
1779
2743
|
/**
|
|
1780
|
-
* <p>
|
|
1781
|
-
*
|
|
1782
|
-
* </p>
|
|
2744
|
+
* <p> The source, <code>AWS_CLOUD_TRAIL</code> or <code>AWS_CODE_DEPLOY</code>, of the
|
|
2745
|
+
* events you want returned. </p>
|
|
1783
2746
|
*/
|
|
1784
2747
|
DataSource?: EventDataSource | string;
|
|
1785
2748
|
/**
|
|
1786
|
-
* <p>
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1789
|
-
*
|
|
2749
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
2750
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
2751
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
2752
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
1790
2753
|
*/
|
|
1791
2754
|
ResourceCollection?: ResourceCollection;
|
|
1792
2755
|
}
|
|
@@ -1798,9 +2761,8 @@ export declare namespace ListEventsFilters {
|
|
|
1798
2761
|
}
|
|
1799
2762
|
export interface ListEventsRequest {
|
|
1800
2763
|
/**
|
|
1801
|
-
* <p>
|
|
1802
|
-
*
|
|
1803
|
-
* </p>
|
|
2764
|
+
* <p> A <code>ListEventsFilters</code> object used to specify which events to return.
|
|
2765
|
+
* </p>
|
|
1804
2766
|
*/
|
|
1805
2767
|
Filters: ListEventsFilters | undefined;
|
|
1806
2768
|
/**
|
|
@@ -1813,6 +2775,10 @@ export interface ListEventsRequest {
|
|
|
1813
2775
|
* the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
1814
2776
|
*/
|
|
1815
2777
|
NextToken?: string;
|
|
2778
|
+
/**
|
|
2779
|
+
* <p>The ID of the Amazon Web Services account. </p>
|
|
2780
|
+
*/
|
|
2781
|
+
AccountId?: string;
|
|
1816
2782
|
}
|
|
1817
2783
|
export declare namespace ListEventsRequest {
|
|
1818
2784
|
/**
|
|
@@ -1821,28 +2787,21 @@ export declare namespace ListEventsRequest {
|
|
|
1821
2787
|
const filterSensitiveLog: (obj: ListEventsRequest) => any;
|
|
1822
2788
|
}
|
|
1823
2789
|
/**
|
|
1824
|
-
* <p>
|
|
1825
|
-
*
|
|
1826
|
-
*
|
|
1827
|
-
* </p>
|
|
2790
|
+
* <p> The Amazon Web Services resource that emitted an event. Amazon Web Services resource events and metrics are
|
|
2791
|
+
* analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your
|
|
2792
|
+
* operational solutions. </p>
|
|
1828
2793
|
*/
|
|
1829
2794
|
export interface EventResource {
|
|
1830
2795
|
/**
|
|
1831
|
-
* <p>
|
|
1832
|
-
* The type of resource that emitted an event.
|
|
1833
|
-
* </p>
|
|
2796
|
+
* <p> The type of resource that emitted an event. </p>
|
|
1834
2797
|
*/
|
|
1835
2798
|
Type?: string;
|
|
1836
2799
|
/**
|
|
1837
|
-
* <p>
|
|
1838
|
-
* The name of the resource that emitted an event.
|
|
1839
|
-
* </p>
|
|
2800
|
+
* <p> The name of the resource that emitted an event. </p>
|
|
1840
2801
|
*/
|
|
1841
2802
|
Name?: string;
|
|
1842
2803
|
/**
|
|
1843
|
-
* <p>
|
|
1844
|
-
* The Amazon Resource Name (ARN) of the resource that emitted an event.
|
|
1845
|
-
* </p>
|
|
2804
|
+
* <p> The Amazon Resource Name (ARN) of the resource that emitted an event. </p>
|
|
1846
2805
|
*/
|
|
1847
2806
|
Arn?: string;
|
|
1848
2807
|
}
|
|
@@ -1853,23 +2812,20 @@ export declare namespace EventResource {
|
|
|
1853
2812
|
const filterSensitiveLog: (obj: EventResource) => any;
|
|
1854
2813
|
}
|
|
1855
2814
|
/**
|
|
1856
|
-
* <p>
|
|
1857
|
-
*
|
|
1858
|
-
*
|
|
1859
|
-
* </p>
|
|
2815
|
+
* <p> An Amazon Web Services resource event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to
|
|
2816
|
+
* find anomalous behavior and provide recommendations to improve your operational
|
|
2817
|
+
* solutions. </p>
|
|
1860
2818
|
*/
|
|
1861
2819
|
export interface Event {
|
|
1862
2820
|
/**
|
|
1863
|
-
* <p>
|
|
1864
|
-
*
|
|
1865
|
-
*
|
|
1866
|
-
*
|
|
2821
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
2822
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
2823
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
2824
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
1867
2825
|
*/
|
|
1868
2826
|
ResourceCollection?: ResourceCollection;
|
|
1869
2827
|
/**
|
|
1870
|
-
* <p>
|
|
1871
|
-
* The ID of the event.
|
|
1872
|
-
* </p>
|
|
2828
|
+
* <p> The ID of the event. </p>
|
|
1873
2829
|
*/
|
|
1874
2830
|
Id?: string;
|
|
1875
2831
|
/**
|
|
@@ -1877,33 +2833,26 @@ export interface Event {
|
|
|
1877
2833
|
*/
|
|
1878
2834
|
Time?: Date;
|
|
1879
2835
|
/**
|
|
1880
|
-
* <p>
|
|
1881
|
-
* The AWS source that emitted the event.
|
|
1882
|
-
* </p>
|
|
2836
|
+
* <p> The Amazon Web Services source that emitted the event. </p>
|
|
1883
2837
|
*/
|
|
1884
2838
|
EventSource?: string;
|
|
1885
2839
|
/**
|
|
1886
|
-
* <p>
|
|
1887
|
-
* The name of the event.
|
|
1888
|
-
* </p>
|
|
2840
|
+
* <p> The name of the event. </p>
|
|
1889
2841
|
*/
|
|
1890
2842
|
Name?: string;
|
|
1891
2843
|
/**
|
|
1892
|
-
* <p>
|
|
1893
|
-
*
|
|
1894
|
-
* </p>
|
|
2844
|
+
* <p> The source, <code>AWS_CLOUD_TRAIL</code> or <code>AWS_CODE_DEPLOY</code>, where DevOps Guru
|
|
2845
|
+
* analysis found the event. </p>
|
|
1895
2846
|
*/
|
|
1896
2847
|
DataSource?: EventDataSource | string;
|
|
1897
2848
|
/**
|
|
1898
|
-
* <p>
|
|
1899
|
-
*
|
|
1900
|
-
* </p>
|
|
2849
|
+
* <p> The class of the event. The class specifies what the event is related to, such as an
|
|
2850
|
+
* infrastructure change, a deployment, or a schema change. </p>
|
|
1901
2851
|
*/
|
|
1902
2852
|
EventClass?: EventClass | string;
|
|
1903
2853
|
/**
|
|
1904
|
-
* <p>
|
|
1905
|
-
*
|
|
1906
|
-
* </p>
|
|
2854
|
+
* <p> An <code>EventResource</code> object that contains information about the resource
|
|
2855
|
+
* that emitted the event. </p>
|
|
1907
2856
|
*/
|
|
1908
2857
|
Resources?: EventResource[];
|
|
1909
2858
|
}
|
|
@@ -1915,9 +2864,7 @@ export declare namespace Event {
|
|
|
1915
2864
|
}
|
|
1916
2865
|
export interface ListEventsResponse {
|
|
1917
2866
|
/**
|
|
1918
|
-
* <p>
|
|
1919
|
-
* A list of the requested events.
|
|
1920
|
-
* </p>
|
|
2867
|
+
* <p> A list of the requested events. </p>
|
|
1921
2868
|
*/
|
|
1922
2869
|
Events: Event[] | undefined;
|
|
1923
2870
|
/**
|
|
@@ -1937,21 +2884,17 @@ export declare enum InsightType {
|
|
|
1937
2884
|
REACTIVE = "REACTIVE"
|
|
1938
2885
|
}
|
|
1939
2886
|
/**
|
|
1940
|
-
* <p>
|
|
1941
|
-
* Used to filter for insights that have any status.
|
|
1942
|
-
* </p>
|
|
2887
|
+
* <p> Used to filter for insights that have any status. </p>
|
|
1943
2888
|
*/
|
|
1944
2889
|
export interface ListInsightsAnyStatusFilter {
|
|
1945
2890
|
/**
|
|
1946
|
-
* <p>
|
|
1947
|
-
*
|
|
1948
|
-
* </p>
|
|
2891
|
+
* <p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights.
|
|
2892
|
+
* </p>
|
|
1949
2893
|
*/
|
|
1950
2894
|
Type: InsightType | string | undefined;
|
|
1951
2895
|
/**
|
|
1952
|
-
* <p>
|
|
1953
|
-
*
|
|
1954
|
-
* </p>
|
|
2896
|
+
* <p> A time range used to specify when the behavior of the filtered insights started.
|
|
2897
|
+
* </p>
|
|
1955
2898
|
*/
|
|
1956
2899
|
StartTimeRange: StartTimeRange | undefined;
|
|
1957
2900
|
}
|
|
@@ -1962,21 +2905,16 @@ export declare namespace ListInsightsAnyStatusFilter {
|
|
|
1962
2905
|
const filterSensitiveLog: (obj: ListInsightsAnyStatusFilter) => any;
|
|
1963
2906
|
}
|
|
1964
2907
|
/**
|
|
1965
|
-
* <p>
|
|
1966
|
-
*
|
|
1967
|
-
* </p>
|
|
2908
|
+
* <p> A range of time that specifies when anomalous behavior in an anomaly or insight
|
|
2909
|
+
* ended. </p>
|
|
1968
2910
|
*/
|
|
1969
2911
|
export interface EndTimeRange {
|
|
1970
2912
|
/**
|
|
1971
|
-
* <p>
|
|
1972
|
-
* The earliest end time in the time range.
|
|
1973
|
-
* </p>
|
|
2913
|
+
* <p> The earliest end time in the time range. </p>
|
|
1974
2914
|
*/
|
|
1975
2915
|
FromTime?: Date;
|
|
1976
2916
|
/**
|
|
1977
|
-
* <p>
|
|
1978
|
-
* The latest end time in the time range.
|
|
1979
|
-
* </p>
|
|
2917
|
+
* <p> The latest end time in the time range. </p>
|
|
1980
2918
|
*/
|
|
1981
2919
|
ToTime?: Date;
|
|
1982
2920
|
}
|
|
@@ -1987,21 +2925,17 @@ export declare namespace EndTimeRange {
|
|
|
1987
2925
|
const filterSensitiveLog: (obj: EndTimeRange) => any;
|
|
1988
2926
|
}
|
|
1989
2927
|
/**
|
|
1990
|
-
* <p>
|
|
1991
|
-
* Used to filter for insights that have the status <code>CLOSED</code>.
|
|
1992
|
-
* </p>
|
|
2928
|
+
* <p> Used to filter for insights that have the status <code>CLOSED</code>. </p>
|
|
1993
2929
|
*/
|
|
1994
2930
|
export interface ListInsightsClosedStatusFilter {
|
|
1995
2931
|
/**
|
|
1996
|
-
* <p>
|
|
1997
|
-
*
|
|
1998
|
-
* </p>
|
|
2932
|
+
* <p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights.
|
|
2933
|
+
* </p>
|
|
1999
2934
|
*/
|
|
2000
2935
|
Type: InsightType | string | undefined;
|
|
2001
2936
|
/**
|
|
2002
|
-
* <p>
|
|
2003
|
-
*
|
|
2004
|
-
* </p>
|
|
2937
|
+
* <p> A time range used to specify when the behavior of the filtered insights ended.
|
|
2938
|
+
* </p>
|
|
2005
2939
|
*/
|
|
2006
2940
|
EndTimeRange: EndTimeRange | undefined;
|
|
2007
2941
|
}
|
|
@@ -2012,15 +2946,12 @@ export declare namespace ListInsightsClosedStatusFilter {
|
|
|
2012
2946
|
const filterSensitiveLog: (obj: ListInsightsClosedStatusFilter) => any;
|
|
2013
2947
|
}
|
|
2014
2948
|
/**
|
|
2015
|
-
* <p>
|
|
2016
|
-
* Used to filter for insights that have the status <code>ONGOING</code>.
|
|
2017
|
-
* </p>
|
|
2949
|
+
* <p> Used to filter for insights that have the status <code>ONGOING</code>. </p>
|
|
2018
2950
|
*/
|
|
2019
2951
|
export interface ListInsightsOngoingStatusFilter {
|
|
2020
2952
|
/**
|
|
2021
|
-
* <p>
|
|
2022
|
-
*
|
|
2023
|
-
* </p>
|
|
2953
|
+
* <p> Use to filter for either <code>REACTIVE</code> or <code>PROACTIVE</code> insights.
|
|
2954
|
+
* </p>
|
|
2024
2955
|
*/
|
|
2025
2956
|
Type: InsightType | string | undefined;
|
|
2026
2957
|
}
|
|
@@ -2031,30 +2962,23 @@ export declare namespace ListInsightsOngoingStatusFilter {
|
|
|
2031
2962
|
const filterSensitiveLog: (obj: ListInsightsOngoingStatusFilter) => any;
|
|
2032
2963
|
}
|
|
2033
2964
|
/**
|
|
2034
|
-
* <p>
|
|
2035
|
-
*
|
|
2036
|
-
* </p>
|
|
2965
|
+
* <p> A filter used by <code>ListInsights</code> to specify which insights to return.
|
|
2966
|
+
* </p>
|
|
2037
2967
|
*/
|
|
2038
2968
|
export interface ListInsightsStatusFilter {
|
|
2039
2969
|
/**
|
|
2040
|
-
* <p>
|
|
2041
|
-
*
|
|
2042
|
-
* that are either <code>REACTIVE</code> or <code>PROACTIVE</code>.
|
|
2043
|
-
* </p>
|
|
2970
|
+
* <p> A <code>ListInsightsAnyStatusFilter</code> that specifies ongoing insights that are
|
|
2971
|
+
* either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>
|
|
2044
2972
|
*/
|
|
2045
2973
|
Ongoing?: ListInsightsOngoingStatusFilter;
|
|
2046
2974
|
/**
|
|
2047
|
-
* <p>
|
|
2048
|
-
*
|
|
2049
|
-
* either <code>REACTIVE</code> or <code>PROACTIVE</code>.
|
|
2050
|
-
* </p>
|
|
2975
|
+
* <p> A <code>ListInsightsClosedStatusFilter</code> that specifies closed insights that are
|
|
2976
|
+
* either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>
|
|
2051
2977
|
*/
|
|
2052
2978
|
Closed?: ListInsightsClosedStatusFilter;
|
|
2053
2979
|
/**
|
|
2054
|
-
* <p>
|
|
2055
|
-
*
|
|
2056
|
-
* that are either <code>REACTIVE</code> or <code>PROACTIVE</code>.
|
|
2057
|
-
* </p>
|
|
2980
|
+
* <p> A <code>ListInsightsAnyStatusFilter</code> that specifies insights of any status that
|
|
2981
|
+
* are either <code>REACTIVE</code> or <code>PROACTIVE</code>. </p>
|
|
2058
2982
|
*/
|
|
2059
2983
|
Any?: ListInsightsAnyStatusFilter;
|
|
2060
2984
|
}
|
|
@@ -2066,9 +2990,8 @@ export declare namespace ListInsightsStatusFilter {
|
|
|
2066
2990
|
}
|
|
2067
2991
|
export interface ListInsightsRequest {
|
|
2068
2992
|
/**
|
|
2069
|
-
* <p>
|
|
2070
|
-
*
|
|
2071
|
-
* </p>
|
|
2993
|
+
* <p> A filter used to filter the returned insights by their status. You can specify one
|
|
2994
|
+
* status filter. </p>
|
|
2072
2995
|
*/
|
|
2073
2996
|
StatusFilter: ListInsightsStatusFilter | undefined;
|
|
2074
2997
|
/**
|
|
@@ -2089,40 +3012,269 @@ export declare namespace ListInsightsRequest {
|
|
|
2089
3012
|
const filterSensitiveLog: (obj: ListInsightsRequest) => any;
|
|
2090
3013
|
}
|
|
2091
3014
|
/**
|
|
2092
|
-
* <p>A collection of the names of
|
|
3015
|
+
* <p>A collection of the names of Amazon Web Services services.</p>
|
|
2093
3016
|
*/
|
|
2094
3017
|
export interface ServiceCollection {
|
|
2095
3018
|
/**
|
|
2096
|
-
* <p>An array of strings that each specifies the name of an
|
|
3019
|
+
* <p>An array of strings that each specifies the name of an Amazon Web Services service.</p>
|
|
3020
|
+
*/
|
|
3021
|
+
ServiceNames?: (ServiceName | string)[];
|
|
3022
|
+
}
|
|
3023
|
+
export declare namespace ServiceCollection {
|
|
3024
|
+
/**
|
|
3025
|
+
* @internal
|
|
3026
|
+
*/
|
|
3027
|
+
const filterSensitiveLog: (obj: ServiceCollection) => any;
|
|
3028
|
+
}
|
|
3029
|
+
/**
|
|
3030
|
+
* <p>Details about a proactive insight. This object is returned by
|
|
3031
|
+
* <code>DescribeInsight.</code>
|
|
3032
|
+
* </p>
|
|
3033
|
+
*/
|
|
3034
|
+
export interface ProactiveInsightSummary {
|
|
3035
|
+
/**
|
|
3036
|
+
* <p>The ID of the proactive insight. </p>
|
|
3037
|
+
*/
|
|
3038
|
+
Id?: string;
|
|
3039
|
+
/**
|
|
3040
|
+
* <p>The name of the proactive insight. </p>
|
|
3041
|
+
*/
|
|
3042
|
+
Name?: string;
|
|
3043
|
+
/**
|
|
3044
|
+
* <p>The severity of the insight. For more information, see
|
|
3045
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
3046
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
3047
|
+
*/
|
|
3048
|
+
Severity?: InsightSeverity | string;
|
|
3049
|
+
/**
|
|
3050
|
+
* <p>The status of the proactive insight. </p>
|
|
3051
|
+
*/
|
|
3052
|
+
Status?: InsightStatus | string;
|
|
3053
|
+
/**
|
|
3054
|
+
* <p> A time ranged that specifies when the observed behavior in an insight started and
|
|
3055
|
+
* ended. </p>
|
|
3056
|
+
*/
|
|
3057
|
+
InsightTimeRange?: InsightTimeRange;
|
|
3058
|
+
/**
|
|
3059
|
+
* <p> The time range during which anomalous behavior in a proactive anomaly or an insight
|
|
3060
|
+
* is expected to occur. </p>
|
|
3061
|
+
*/
|
|
3062
|
+
PredictionTimeRange?: PredictionTimeRange;
|
|
3063
|
+
/**
|
|
3064
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
3065
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
3066
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
3067
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
3068
|
+
*/
|
|
3069
|
+
ResourceCollection?: ResourceCollection;
|
|
3070
|
+
/**
|
|
3071
|
+
* <p>A collection of the names of Amazon Web Services services.</p>
|
|
3072
|
+
*/
|
|
3073
|
+
ServiceCollection?: ServiceCollection;
|
|
3074
|
+
/**
|
|
3075
|
+
* <p>The Amazon Resource Names (ARNs)
|
|
3076
|
+
* of the Amazon Web Services resources that generated this insight.</p>
|
|
3077
|
+
*/
|
|
3078
|
+
AssociatedResourceArns?: string[];
|
|
3079
|
+
}
|
|
3080
|
+
export declare namespace ProactiveInsightSummary {
|
|
3081
|
+
/**
|
|
3082
|
+
* @internal
|
|
3083
|
+
*/
|
|
3084
|
+
const filterSensitiveLog: (obj: ProactiveInsightSummary) => any;
|
|
3085
|
+
}
|
|
3086
|
+
/**
|
|
3087
|
+
* <p> Information about a reactive insight. This object is returned by
|
|
3088
|
+
* <code>DescribeInsight.</code>
|
|
3089
|
+
* </p>
|
|
3090
|
+
*/
|
|
3091
|
+
export interface ReactiveInsightSummary {
|
|
3092
|
+
/**
|
|
3093
|
+
* <p> The ID of a reactive summary. </p>
|
|
3094
|
+
*/
|
|
3095
|
+
Id?: string;
|
|
3096
|
+
/**
|
|
3097
|
+
* <p> The name of a reactive insight. </p>
|
|
3098
|
+
*/
|
|
3099
|
+
Name?: string;
|
|
3100
|
+
/**
|
|
3101
|
+
* <p>The severity of the insight. For more information, see
|
|
3102
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
3103
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
3104
|
+
*/
|
|
3105
|
+
Severity?: InsightSeverity | string;
|
|
3106
|
+
/**
|
|
3107
|
+
* <p> The status of a reactive insight. </p>
|
|
3108
|
+
*/
|
|
3109
|
+
Status?: InsightStatus | string;
|
|
3110
|
+
/**
|
|
3111
|
+
* <p> A time ranged that specifies when the observed behavior in an insight started and
|
|
3112
|
+
* ended. </p>
|
|
3113
|
+
*/
|
|
3114
|
+
InsightTimeRange?: InsightTimeRange;
|
|
3115
|
+
/**
|
|
3116
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
3117
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
3118
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
3119
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
3120
|
+
*/
|
|
3121
|
+
ResourceCollection?: ResourceCollection;
|
|
3122
|
+
/**
|
|
3123
|
+
* <p>A collection of the names of Amazon Web Services services.</p>
|
|
3124
|
+
*/
|
|
3125
|
+
ServiceCollection?: ServiceCollection;
|
|
3126
|
+
/**
|
|
3127
|
+
* <p>The Amazon Resource Names (ARNs)
|
|
3128
|
+
* of the Amazon Web Services resources that generated this insight.</p>
|
|
3129
|
+
*/
|
|
3130
|
+
AssociatedResourceArns?: string[];
|
|
3131
|
+
}
|
|
3132
|
+
export declare namespace ReactiveInsightSummary {
|
|
3133
|
+
/**
|
|
3134
|
+
* @internal
|
|
3135
|
+
*/
|
|
3136
|
+
const filterSensitiveLog: (obj: ReactiveInsightSummary) => any;
|
|
3137
|
+
}
|
|
3138
|
+
export interface ListInsightsResponse {
|
|
3139
|
+
/**
|
|
3140
|
+
* <p> The returned list of proactive insights. </p>
|
|
3141
|
+
*/
|
|
3142
|
+
ProactiveInsights?: ProactiveInsightSummary[];
|
|
3143
|
+
/**
|
|
3144
|
+
* <p> The returned list of reactive insights. </p>
|
|
3145
|
+
*/
|
|
3146
|
+
ReactiveInsights?: ReactiveInsightSummary[];
|
|
3147
|
+
/**
|
|
3148
|
+
* <p>The pagination token to use to retrieve
|
|
3149
|
+
* the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3150
|
+
*/
|
|
3151
|
+
NextToken?: string;
|
|
3152
|
+
}
|
|
3153
|
+
export declare namespace ListInsightsResponse {
|
|
3154
|
+
/**
|
|
3155
|
+
* @internal
|
|
3156
|
+
*/
|
|
3157
|
+
const filterSensitiveLog: (obj: ListInsightsResponse) => any;
|
|
3158
|
+
}
|
|
3159
|
+
export interface ListNotificationChannelsRequest {
|
|
3160
|
+
/**
|
|
3161
|
+
* <p>The pagination token to use to retrieve
|
|
3162
|
+
* the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3163
|
+
*/
|
|
3164
|
+
NextToken?: string;
|
|
3165
|
+
}
|
|
3166
|
+
export declare namespace ListNotificationChannelsRequest {
|
|
3167
|
+
/**
|
|
3168
|
+
* @internal
|
|
3169
|
+
*/
|
|
3170
|
+
const filterSensitiveLog: (obj: ListNotificationChannelsRequest) => any;
|
|
3171
|
+
}
|
|
3172
|
+
/**
|
|
3173
|
+
* <p> Information about a notification channel. A notification channel is used to notify
|
|
3174
|
+
* you when DevOps Guru creates an insight. The one
|
|
3175
|
+
* supported notification channel is Amazon Simple Notification Service (Amazon SNS). </p>
|
|
3176
|
+
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission
|
|
3177
|
+
* to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account.
|
|
3178
|
+
* For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html">Permissions
|
|
3179
|
+
* for cross account Amazon SNS topics</a>.</p>
|
|
3180
|
+
* <p>If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions
|
|
3181
|
+
* to the CMK. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html">Permissions for
|
|
3182
|
+
* Amazon Web Services KMS–encrypted Amazon SNS topics</a>.</p>
|
|
3183
|
+
*/
|
|
3184
|
+
export interface NotificationChannel {
|
|
3185
|
+
/**
|
|
3186
|
+
* <p> The ID of a notification channel. </p>
|
|
3187
|
+
*/
|
|
3188
|
+
Id?: string;
|
|
3189
|
+
/**
|
|
3190
|
+
* <p> A <code>NotificationChannelConfig</code> object that contains information about
|
|
3191
|
+
* configured notification channels. </p>
|
|
3192
|
+
*/
|
|
3193
|
+
Config?: NotificationChannelConfig;
|
|
3194
|
+
}
|
|
3195
|
+
export declare namespace NotificationChannel {
|
|
3196
|
+
/**
|
|
3197
|
+
* @internal
|
|
3198
|
+
*/
|
|
3199
|
+
const filterSensitiveLog: (obj: NotificationChannel) => any;
|
|
3200
|
+
}
|
|
3201
|
+
export interface ListNotificationChannelsResponse {
|
|
3202
|
+
/**
|
|
3203
|
+
* <p> An array that contains the requested notification channels. </p>
|
|
3204
|
+
*/
|
|
3205
|
+
Channels?: NotificationChannel[];
|
|
3206
|
+
/**
|
|
3207
|
+
* <p>The pagination token to use to retrieve
|
|
3208
|
+
* the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3209
|
+
*/
|
|
3210
|
+
NextToken?: string;
|
|
3211
|
+
}
|
|
3212
|
+
export declare namespace ListNotificationChannelsResponse {
|
|
3213
|
+
/**
|
|
3214
|
+
* @internal
|
|
3215
|
+
*/
|
|
3216
|
+
const filterSensitiveLog: (obj: ListNotificationChannelsResponse) => any;
|
|
3217
|
+
}
|
|
3218
|
+
export interface ListOrganizationInsightsRequest {
|
|
3219
|
+
/**
|
|
3220
|
+
* <p> A filter used by <code>ListInsights</code> to specify which insights to return.
|
|
3221
|
+
* </p>
|
|
3222
|
+
*/
|
|
3223
|
+
StatusFilter: ListInsightsStatusFilter | undefined;
|
|
3224
|
+
/**
|
|
3225
|
+
* <p>The maximum number of results to return with a single call.
|
|
3226
|
+
* To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
|
|
3227
|
+
*/
|
|
3228
|
+
MaxResults?: number;
|
|
3229
|
+
/**
|
|
3230
|
+
* <p>The ID of the Amazon Web Services account. </p>
|
|
2097
3231
|
*/
|
|
2098
|
-
|
|
3232
|
+
AccountIds?: string[];
|
|
3233
|
+
/**
|
|
3234
|
+
* <p>The ID of the organizational unit.</p>
|
|
3235
|
+
*/
|
|
3236
|
+
OrganizationalUnitIds?: string[];
|
|
3237
|
+
/**
|
|
3238
|
+
* <p>The pagination token to use to retrieve
|
|
3239
|
+
* the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3240
|
+
*/
|
|
3241
|
+
NextToken?: string;
|
|
2099
3242
|
}
|
|
2100
|
-
export declare namespace
|
|
3243
|
+
export declare namespace ListOrganizationInsightsRequest {
|
|
2101
3244
|
/**
|
|
2102
3245
|
* @internal
|
|
2103
3246
|
*/
|
|
2104
|
-
const filterSensitiveLog: (obj:
|
|
3247
|
+
const filterSensitiveLog: (obj: ListOrganizationInsightsRequest) => any;
|
|
2105
3248
|
}
|
|
2106
3249
|
/**
|
|
2107
3250
|
* <p>Details about a proactive insight. This object is returned by
|
|
2108
|
-
* <code>DescribeInsight
|
|
2109
|
-
* </p>
|
|
3251
|
+
* <code>DescribeInsight</code>.</p>
|
|
2110
3252
|
*/
|
|
2111
|
-
export interface
|
|
3253
|
+
export interface ProactiveOrganizationInsightSummary {
|
|
2112
3254
|
/**
|
|
2113
|
-
* <p>The ID of the
|
|
3255
|
+
* <p>The ID of the insight summary.</p>
|
|
2114
3256
|
*/
|
|
2115
3257
|
Id?: string;
|
|
2116
3258
|
/**
|
|
2117
|
-
* <p>The
|
|
3259
|
+
* <p>The ID of the Amazon Web Services account.</p>
|
|
3260
|
+
*/
|
|
3261
|
+
AccountId?: string;
|
|
3262
|
+
/**
|
|
3263
|
+
* <p>The ID of the organizational unit.</p>
|
|
3264
|
+
*/
|
|
3265
|
+
OrganizationalUnitId?: string;
|
|
3266
|
+
/**
|
|
3267
|
+
* <p>The name of the insight summary.</p>
|
|
2118
3268
|
*/
|
|
2119
3269
|
Name?: string;
|
|
2120
3270
|
/**
|
|
2121
|
-
* <p>
|
|
3271
|
+
* <p> An array of severity values used to search for insights. For more information, see
|
|
3272
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
3273
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
2122
3274
|
*/
|
|
2123
3275
|
Severity?: InsightSeverity | string;
|
|
2124
3276
|
/**
|
|
2125
|
-
* <p>
|
|
3277
|
+
* <p> An array of status values used to search for insights. </p>
|
|
2126
3278
|
*/
|
|
2127
3279
|
Status?: InsightStatus | string;
|
|
2128
3280
|
/**
|
|
@@ -2131,57 +3283,57 @@ export interface ProactiveInsightSummary {
|
|
|
2131
3283
|
*/
|
|
2132
3284
|
InsightTimeRange?: InsightTimeRange;
|
|
2133
3285
|
/**
|
|
2134
|
-
* <p>
|
|
2135
|
-
*
|
|
2136
|
-
* </p>
|
|
3286
|
+
* <p> The time range during which anomalous behavior in a proactive anomaly or an insight
|
|
3287
|
+
* is expected to occur. </p>
|
|
2137
3288
|
*/
|
|
2138
3289
|
PredictionTimeRange?: PredictionTimeRange;
|
|
2139
3290
|
/**
|
|
2140
|
-
* <p>
|
|
2141
|
-
*
|
|
2142
|
-
*
|
|
2143
|
-
*
|
|
3291
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
3292
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
3293
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
3294
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
2144
3295
|
*/
|
|
2145
3296
|
ResourceCollection?: ResourceCollection;
|
|
2146
3297
|
/**
|
|
2147
|
-
* <p>A collection of the names of
|
|
3298
|
+
* <p>A collection of the names of Amazon Web Services services.</p>
|
|
2148
3299
|
*/
|
|
2149
3300
|
ServiceCollection?: ServiceCollection;
|
|
2150
3301
|
}
|
|
2151
|
-
export declare namespace
|
|
3302
|
+
export declare namespace ProactiveOrganizationInsightSummary {
|
|
2152
3303
|
/**
|
|
2153
3304
|
* @internal
|
|
2154
3305
|
*/
|
|
2155
|
-
const filterSensitiveLog: (obj:
|
|
3306
|
+
const filterSensitiveLog: (obj: ProactiveOrganizationInsightSummary) => any;
|
|
2156
3307
|
}
|
|
2157
3308
|
/**
|
|
2158
|
-
* <p>
|
|
2159
|
-
*
|
|
2160
|
-
* </p>
|
|
3309
|
+
* <p>Information about a reactive insight. This object is returned by
|
|
3310
|
+
* <code>DescribeInsight</code>.</p>
|
|
2161
3311
|
*/
|
|
2162
|
-
export interface
|
|
3312
|
+
export interface ReactiveOrganizationInsightSummary {
|
|
2163
3313
|
/**
|
|
2164
|
-
* <p>
|
|
2165
|
-
* The ID of a reactive summary.
|
|
2166
|
-
* </p>
|
|
3314
|
+
* <p>The ID of the insight summary.</p>
|
|
2167
3315
|
*/
|
|
2168
3316
|
Id?: string;
|
|
2169
3317
|
/**
|
|
2170
|
-
* <p>
|
|
2171
|
-
|
|
2172
|
-
|
|
3318
|
+
* <p>The ID of the Amazon Web Services account. </p>
|
|
3319
|
+
*/
|
|
3320
|
+
AccountId?: string;
|
|
3321
|
+
/**
|
|
3322
|
+
* <p>The ID of the organizational unit.</p>
|
|
3323
|
+
*/
|
|
3324
|
+
OrganizationalUnitId?: string;
|
|
3325
|
+
/**
|
|
3326
|
+
* <p>The name of the insight summary.</p>
|
|
2173
3327
|
*/
|
|
2174
3328
|
Name?: string;
|
|
2175
3329
|
/**
|
|
2176
|
-
* <p>
|
|
2177
|
-
*
|
|
2178
|
-
*
|
|
3330
|
+
* <p> An array of severity values used to search for insights. For more information, see
|
|
3331
|
+
* <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/working-with-insights.html#understanding-insights-severities">Understanding
|
|
3332
|
+
* insight severities</a> in the <i>Amazon DevOps Guru User Guide</i>.</p>
|
|
2179
3333
|
*/
|
|
2180
3334
|
Severity?: InsightSeverity | string;
|
|
2181
3335
|
/**
|
|
2182
|
-
* <p>
|
|
2183
|
-
* The status of a reactive insight.
|
|
2184
|
-
* </p>
|
|
3336
|
+
* <p> An array of status values used to search for insights. </p>
|
|
2185
3337
|
*/
|
|
2186
3338
|
Status?: InsightStatus | string;
|
|
2187
3339
|
/**
|
|
@@ -2190,114 +3342,45 @@ export interface ReactiveInsightSummary {
|
|
|
2190
3342
|
*/
|
|
2191
3343
|
InsightTimeRange?: InsightTimeRange;
|
|
2192
3344
|
/**
|
|
2193
|
-
* <p>
|
|
2194
|
-
*
|
|
2195
|
-
*
|
|
2196
|
-
*
|
|
3345
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
3346
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
3347
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
3348
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
2197
3349
|
*/
|
|
2198
3350
|
ResourceCollection?: ResourceCollection;
|
|
2199
3351
|
/**
|
|
2200
|
-
* <p>A collection of the names of
|
|
3352
|
+
* <p>A collection of the names of Amazon Web Services services.</p>
|
|
2201
3353
|
*/
|
|
2202
3354
|
ServiceCollection?: ServiceCollection;
|
|
2203
3355
|
}
|
|
2204
|
-
export declare namespace
|
|
2205
|
-
/**
|
|
2206
|
-
* @internal
|
|
2207
|
-
*/
|
|
2208
|
-
const filterSensitiveLog: (obj: ReactiveInsightSummary) => any;
|
|
2209
|
-
}
|
|
2210
|
-
export interface ListInsightsResponse {
|
|
2211
|
-
/**
|
|
2212
|
-
* <p>
|
|
2213
|
-
* The returned list of proactive insights.
|
|
2214
|
-
* </p>
|
|
2215
|
-
*/
|
|
2216
|
-
ProactiveInsights?: ProactiveInsightSummary[];
|
|
2217
|
-
/**
|
|
2218
|
-
* <p>
|
|
2219
|
-
* The returned list of reactive insights.
|
|
2220
|
-
* </p>
|
|
2221
|
-
*/
|
|
2222
|
-
ReactiveInsights?: ReactiveInsightSummary[];
|
|
2223
|
-
/**
|
|
2224
|
-
* <p>The pagination token to use to retrieve
|
|
2225
|
-
* the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
2226
|
-
*/
|
|
2227
|
-
NextToken?: string;
|
|
2228
|
-
}
|
|
2229
|
-
export declare namespace ListInsightsResponse {
|
|
2230
|
-
/**
|
|
2231
|
-
* @internal
|
|
2232
|
-
*/
|
|
2233
|
-
const filterSensitiveLog: (obj: ListInsightsResponse) => any;
|
|
2234
|
-
}
|
|
2235
|
-
export interface ListNotificationChannelsRequest {
|
|
2236
|
-
/**
|
|
2237
|
-
* <p>The pagination token to use to retrieve
|
|
2238
|
-
* the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
2239
|
-
*/
|
|
2240
|
-
NextToken?: string;
|
|
2241
|
-
}
|
|
2242
|
-
export declare namespace ListNotificationChannelsRequest {
|
|
3356
|
+
export declare namespace ReactiveOrganizationInsightSummary {
|
|
2243
3357
|
/**
|
|
2244
3358
|
* @internal
|
|
2245
3359
|
*/
|
|
2246
|
-
const filterSensitiveLog: (obj:
|
|
2247
|
-
}
|
|
2248
|
-
/**
|
|
2249
|
-
* <p>
|
|
2250
|
-
* Information about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight.
|
|
2251
|
-
* The one
|
|
2252
|
-
* supported notification channel is Amazon Simple Notification Service (Amazon SNS).
|
|
2253
|
-
* </p>
|
|
2254
|
-
*
|
|
2255
|
-
* <p>If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission
|
|
2256
|
-
* to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account.
|
|
2257
|
-
* For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-required-permissions.html">Permissions
|
|
2258
|
-
* for cross account Amazon SNS topics</a>.</p>
|
|
2259
|
-
* <p>If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions
|
|
2260
|
-
* to the CMK. For more information, see <a href="https://docs.aws.amazon.com/devops-guru/latest/userguide/sns-kms-permissions.html">Permissions for
|
|
2261
|
-
* AWS KMS–encrypted Amazon SNS topics</a>.</p>
|
|
2262
|
-
*/
|
|
2263
|
-
export interface NotificationChannel {
|
|
2264
|
-
/**
|
|
2265
|
-
* <p>
|
|
2266
|
-
* The ID of a notification channel.
|
|
2267
|
-
* </p>
|
|
2268
|
-
*/
|
|
2269
|
-
Id?: string;
|
|
2270
|
-
/**
|
|
2271
|
-
* <p>
|
|
2272
|
-
* A <code>NotificationChannelConfig</code> object that contains information about configured notification channels.
|
|
2273
|
-
* </p>
|
|
2274
|
-
*/
|
|
2275
|
-
Config?: NotificationChannelConfig;
|
|
3360
|
+
const filterSensitiveLog: (obj: ReactiveOrganizationInsightSummary) => any;
|
|
2276
3361
|
}
|
|
2277
|
-
export
|
|
3362
|
+
export interface ListOrganizationInsightsResponse {
|
|
2278
3363
|
/**
|
|
2279
|
-
*
|
|
3364
|
+
* <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
|
|
3365
|
+
* account.</p>
|
|
2280
3366
|
*/
|
|
2281
|
-
|
|
2282
|
-
}
|
|
2283
|
-
export interface ListNotificationChannelsResponse {
|
|
3367
|
+
ProactiveInsights?: ProactiveOrganizationInsightSummary[];
|
|
2284
3368
|
/**
|
|
2285
|
-
* <p>
|
|
2286
|
-
*
|
|
2287
|
-
* </p>
|
|
3369
|
+
* <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
|
|
3370
|
+
* account.</p>
|
|
2288
3371
|
*/
|
|
2289
|
-
|
|
3372
|
+
ReactiveInsights?: ReactiveOrganizationInsightSummary[];
|
|
2290
3373
|
/**
|
|
2291
3374
|
* <p>The pagination token to use to retrieve
|
|
2292
3375
|
* the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
2293
3376
|
*/
|
|
2294
3377
|
NextToken?: string;
|
|
2295
3378
|
}
|
|
2296
|
-
export declare namespace
|
|
3379
|
+
export declare namespace ListOrganizationInsightsResponse {
|
|
2297
3380
|
/**
|
|
2298
3381
|
* @internal
|
|
2299
3382
|
*/
|
|
2300
|
-
const filterSensitiveLog: (obj:
|
|
3383
|
+
const filterSensitiveLog: (obj: ListOrganizationInsightsResponse) => any;
|
|
2301
3384
|
}
|
|
2302
3385
|
export declare enum Locale {
|
|
2303
3386
|
DE_DE = "DE_DE",
|
|
@@ -2314,9 +3397,7 @@ export declare enum Locale {
|
|
|
2314
3397
|
}
|
|
2315
3398
|
export interface ListRecommendationsRequest {
|
|
2316
3399
|
/**
|
|
2317
|
-
* <p>
|
|
2318
|
-
* The ID of the requested insight.
|
|
2319
|
-
* </p>
|
|
3400
|
+
* <p> The ID of the requested insight. </p>
|
|
2320
3401
|
*/
|
|
2321
3402
|
InsightId: string | undefined;
|
|
2322
3403
|
/**
|
|
@@ -2328,6 +3409,10 @@ export interface ListRecommendationsRequest {
|
|
|
2328
3409
|
* <p>A locale that specifies the language to use for recommendations.</p>
|
|
2329
3410
|
*/
|
|
2330
3411
|
Locale?: Locale | string;
|
|
3412
|
+
/**
|
|
3413
|
+
* <p>The ID of the Amazon Web Services account. </p>
|
|
3414
|
+
*/
|
|
3415
|
+
AccountId?: string;
|
|
2331
3416
|
}
|
|
2332
3417
|
export declare namespace ListRecommendationsRequest {
|
|
2333
3418
|
/**
|
|
@@ -2336,21 +3421,19 @@ export declare namespace ListRecommendationsRequest {
|
|
|
2336
3421
|
const filterSensitiveLog: (obj: ListRecommendationsRequest) => any;
|
|
2337
3422
|
}
|
|
2338
3423
|
/**
|
|
2339
|
-
* <p>
|
|
2340
|
-
* Information about a resource in which DevOps Guru detected anomalous behavior.
|
|
2341
|
-
* </p>
|
|
3424
|
+
* <p> Information about a resource in which DevOps Guru detected anomalous behavior. </p>
|
|
2342
3425
|
*/
|
|
2343
3426
|
export interface RecommendationRelatedAnomalyResource {
|
|
2344
3427
|
/**
|
|
2345
|
-
* <p>
|
|
2346
|
-
* The name of the resource.
|
|
2347
|
-
* </p>
|
|
3428
|
+
* <p> The name of the resource. </p>
|
|
2348
3429
|
*/
|
|
2349
3430
|
Name?: string;
|
|
2350
3431
|
/**
|
|
2351
|
-
* <p>
|
|
2352
|
-
*
|
|
2353
|
-
*
|
|
3432
|
+
* <p> The type of the resource. Resource types take the same form that is
|
|
3433
|
+
* used by Amazon Web Services CloudFormation resource type identifiers, <code>service-provider::service-name::data-type-name</code>.
|
|
3434
|
+
* For example, <code>AWS::RDS::DBCluster</code>. For more information, see
|
|
3435
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and
|
|
3436
|
+
* property types reference</a> in the <i>Amazon Web Services CloudFormation User Guide</i>.</p>
|
|
2354
3437
|
*/
|
|
2355
3438
|
Type?: string;
|
|
2356
3439
|
}
|
|
@@ -2361,10 +3444,8 @@ export declare namespace RecommendationRelatedAnomalyResource {
|
|
|
2361
3444
|
const filterSensitiveLog: (obj: RecommendationRelatedAnomalyResource) => any;
|
|
2362
3445
|
}
|
|
2363
3446
|
/**
|
|
2364
|
-
* <p>
|
|
2365
|
-
*
|
|
2366
|
-
* that are used to generate insights.
|
|
2367
|
-
* </p>
|
|
3447
|
+
* <p> Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many
|
|
3448
|
+
* analyzed metrics that are used to generate insights. </p>
|
|
2368
3449
|
*/
|
|
2369
3450
|
export interface RecommendationRelatedCloudWatchMetricsSourceDetail {
|
|
2370
3451
|
/**
|
|
@@ -2383,10 +3464,8 @@ export declare namespace RecommendationRelatedCloudWatchMetricsSourceDetail {
|
|
|
2383
3464
|
const filterSensitiveLog: (obj: RecommendationRelatedCloudWatchMetricsSourceDetail) => any;
|
|
2384
3465
|
}
|
|
2385
3466
|
/**
|
|
2386
|
-
* <p>
|
|
2387
|
-
*
|
|
2388
|
-
* and namespace of an Amazon CloudWatch metric.
|
|
2389
|
-
* </p>
|
|
3467
|
+
* <p> Contains an array of <code>RecommendationRelatedCloudWatchMetricsSourceDetail</code>
|
|
3468
|
+
* objects that contain the name and namespace of an Amazon CloudWatch metric. </p>
|
|
2390
3469
|
*/
|
|
2391
3470
|
export interface RecommendationRelatedAnomalySourceDetail {
|
|
2392
3471
|
/**
|
|
@@ -2402,24 +3481,23 @@ export declare namespace RecommendationRelatedAnomalySourceDetail {
|
|
|
2402
3481
|
const filterSensitiveLog: (obj: RecommendationRelatedAnomalySourceDetail) => any;
|
|
2403
3482
|
}
|
|
2404
3483
|
/**
|
|
2405
|
-
* <p>
|
|
2406
|
-
* Information about an anomaly that is related to a recommendation.
|
|
2407
|
-
* </p>
|
|
3484
|
+
* <p> Information about an anomaly that is related to a recommendation. </p>
|
|
2408
3485
|
*/
|
|
2409
3486
|
export interface RecommendationRelatedAnomaly {
|
|
2410
3487
|
/**
|
|
2411
|
-
* <p>
|
|
2412
|
-
*
|
|
2413
|
-
* and type of the resource.
|
|
2414
|
-
* </p>
|
|
3488
|
+
* <p> An array of objects that represent resources in which DevOps Guru detected anomalous
|
|
3489
|
+
* behavior. Each object contains the name and type of the resource. </p>
|
|
2415
3490
|
*/
|
|
2416
3491
|
Resources?: RecommendationRelatedAnomalyResource[];
|
|
2417
3492
|
/**
|
|
2418
|
-
* <p>
|
|
2419
|
-
*
|
|
2420
|
-
* </p>
|
|
3493
|
+
* <p> Information about where the anomalous behavior related the recommendation was found.
|
|
3494
|
+
* For example, details in Amazon CloudWatch metrics. </p>
|
|
2421
3495
|
*/
|
|
2422
3496
|
SourceDetails?: RecommendationRelatedAnomalySourceDetail[];
|
|
3497
|
+
/**
|
|
3498
|
+
* <p>The ID of an anomaly that generated the insight with this recommendation.</p>
|
|
3499
|
+
*/
|
|
3500
|
+
AnomalyId?: string;
|
|
2423
3501
|
}
|
|
2424
3502
|
export declare namespace RecommendationRelatedAnomaly {
|
|
2425
3503
|
/**
|
|
@@ -2428,23 +3506,18 @@ export declare namespace RecommendationRelatedAnomaly {
|
|
|
2428
3506
|
const filterSensitiveLog: (obj: RecommendationRelatedAnomaly) => any;
|
|
2429
3507
|
}
|
|
2430
3508
|
/**
|
|
2431
|
-
* <p>
|
|
2432
|
-
*
|
|
2433
|
-
* </p>
|
|
3509
|
+
* <p> Information about an Amazon Web Services resource that emitted and event that is related to a
|
|
3510
|
+
* recommendation in an insight. </p>
|
|
2434
3511
|
*/
|
|
2435
3512
|
export interface RecommendationRelatedEventResource {
|
|
2436
3513
|
/**
|
|
2437
|
-
* <p>
|
|
2438
|
-
*
|
|
2439
|
-
* <code>EventResource</code> object.
|
|
2440
|
-
* </p>
|
|
3514
|
+
* <p> The name of the resource that emitted the event. This corresponds to the
|
|
3515
|
+
* <code>Name</code> field in an <code>EventResource</code> object. </p>
|
|
2441
3516
|
*/
|
|
2442
3517
|
Name?: string;
|
|
2443
3518
|
/**
|
|
2444
|
-
* <p>
|
|
2445
|
-
*
|
|
2446
|
-
* <code>EventResource</code> object.
|
|
2447
|
-
* </p>
|
|
3519
|
+
* <p> The type of the resource that emitted the event. This corresponds to the
|
|
3520
|
+
* <code>Type</code> field in an <code>EventResource</code> object. </p>
|
|
2448
3521
|
*/
|
|
2449
3522
|
Type?: string;
|
|
2450
3523
|
}
|
|
@@ -2455,23 +3528,17 @@ export declare namespace RecommendationRelatedEventResource {
|
|
|
2455
3528
|
const filterSensitiveLog: (obj: RecommendationRelatedEventResource) => any;
|
|
2456
3529
|
}
|
|
2457
3530
|
/**
|
|
2458
|
-
* <p>
|
|
2459
|
-
* Information about an event that is related to a recommendation.
|
|
2460
|
-
* </p>
|
|
3531
|
+
* <p> Information about an event that is related to a recommendation. </p>
|
|
2461
3532
|
*/
|
|
2462
3533
|
export interface RecommendationRelatedEvent {
|
|
2463
3534
|
/**
|
|
2464
|
-
* <p>
|
|
2465
|
-
*
|
|
2466
|
-
* <code>Event</code> object.
|
|
2467
|
-
* </p>
|
|
3535
|
+
* <p> The name of the event. This corresponds to the <code>Name</code> field in an
|
|
3536
|
+
* <code>Event</code> object. </p>
|
|
2468
3537
|
*/
|
|
2469
3538
|
Name?: string;
|
|
2470
3539
|
/**
|
|
2471
|
-
* <p>
|
|
2472
|
-
*
|
|
2473
|
-
* CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.
|
|
2474
|
-
* </p>
|
|
3540
|
+
* <p> A <code>ResourceCollection</code> object that contains arrays of the names of Amazon Web Services
|
|
3541
|
+
* CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
2475
3542
|
*/
|
|
2476
3543
|
Resources?: RecommendationRelatedEventResource[];
|
|
2477
3544
|
}
|
|
@@ -2487,39 +3554,29 @@ export declare namespace RecommendationRelatedEvent {
|
|
|
2487
3554
|
*/
|
|
2488
3555
|
export interface Recommendation {
|
|
2489
3556
|
/**
|
|
2490
|
-
* <p>
|
|
2491
|
-
* A description of the problem.
|
|
2492
|
-
* </p>
|
|
3557
|
+
* <p> A description of the problem. </p>
|
|
2493
3558
|
*/
|
|
2494
3559
|
Description?: string;
|
|
2495
3560
|
/**
|
|
2496
|
-
* <p>
|
|
2497
|
-
* A hyperlink to information to help you address the problem.
|
|
2498
|
-
* </p>
|
|
3561
|
+
* <p> A hyperlink to information to help you address the problem. </p>
|
|
2499
3562
|
*/
|
|
2500
3563
|
Link?: string;
|
|
2501
3564
|
/**
|
|
2502
|
-
* <p>
|
|
2503
|
-
* The name of the recommendation.
|
|
2504
|
-
* </p>
|
|
3565
|
+
* <p> The name of the recommendation. </p>
|
|
2505
3566
|
*/
|
|
2506
3567
|
Name?: string;
|
|
2507
3568
|
/**
|
|
2508
|
-
* <p>
|
|
2509
|
-
* The reason DevOps Guru flagged the anomalous behavior as a problem.
|
|
2510
|
-
* </p>
|
|
3569
|
+
* <p> The reason DevOps Guru flagged the anomalous behavior as a problem. </p>
|
|
2511
3570
|
*/
|
|
2512
3571
|
Reason?: string;
|
|
2513
3572
|
/**
|
|
2514
|
-
* <p>
|
|
2515
|
-
*
|
|
2516
|
-
* </p>
|
|
3573
|
+
* <p> Events that are related to the problem. Use these events to learn more about what's
|
|
3574
|
+
* happening and to help address the issue. </p>
|
|
2517
3575
|
*/
|
|
2518
3576
|
RelatedEvents?: RecommendationRelatedEvent[];
|
|
2519
3577
|
/**
|
|
2520
|
-
* <p>
|
|
2521
|
-
*
|
|
2522
|
-
* </p>
|
|
3578
|
+
* <p> Anomalies that are related to the problem. Use these Anomalies to learn more about
|
|
3579
|
+
* what's happening and to help address the issue. </p>
|
|
2523
3580
|
*/
|
|
2524
3581
|
RelatedAnomalies?: RecommendationRelatedAnomaly[];
|
|
2525
3582
|
}
|
|
@@ -2531,9 +3588,7 @@ export declare namespace Recommendation {
|
|
|
2531
3588
|
}
|
|
2532
3589
|
export interface ListRecommendationsResponse {
|
|
2533
3590
|
/**
|
|
2534
|
-
* <p>
|
|
2535
|
-
* An array of the requested recommendations.
|
|
2536
|
-
* </p>
|
|
3591
|
+
* <p> An array of the requested recommendations. </p>
|
|
2537
3592
|
*/
|
|
2538
3593
|
Recommendations?: Recommendation[];
|
|
2539
3594
|
/**
|
|
@@ -2550,9 +3605,7 @@ export declare namespace ListRecommendationsResponse {
|
|
|
2550
3605
|
}
|
|
2551
3606
|
export interface PutFeedbackRequest {
|
|
2552
3607
|
/**
|
|
2553
|
-
* <p>
|
|
2554
|
-
* The feedback from customers is about the recommendations in this insight.
|
|
2555
|
-
* </p>
|
|
3608
|
+
* <p> The feedback from customers is about the recommendations in this insight. </p>
|
|
2556
3609
|
*/
|
|
2557
3610
|
InsightFeedback?: InsightFeedback;
|
|
2558
3611
|
}
|
|
@@ -2572,9 +3625,7 @@ export declare namespace PutFeedbackResponse {
|
|
|
2572
3625
|
}
|
|
2573
3626
|
export interface RemoveNotificationChannelRequest {
|
|
2574
3627
|
/**
|
|
2575
|
-
* <p>
|
|
2576
|
-
* The ID of the notification channel to be removed.
|
|
2577
|
-
* </p>
|
|
3628
|
+
* <p> The ID of the notification channel to be removed. </p>
|
|
2578
3629
|
*/
|
|
2579
3630
|
Id: string | undefined;
|
|
2580
3631
|
}
|
|
@@ -2593,33 +3644,27 @@ export declare namespace RemoveNotificationChannelResponse {
|
|
|
2593
3644
|
const filterSensitiveLog: (obj: RemoveNotificationChannelResponse) => any;
|
|
2594
3645
|
}
|
|
2595
3646
|
/**
|
|
2596
|
-
* <p>
|
|
2597
|
-
*
|
|
2598
|
-
* for insights.
|
|
2599
|
-
* </p>
|
|
3647
|
+
* <p> Specifies one or more severity values and one or more status values that are used to
|
|
3648
|
+
* search for insights. </p>
|
|
2600
3649
|
*/
|
|
2601
3650
|
export interface SearchInsightsFilters {
|
|
2602
3651
|
/**
|
|
2603
|
-
* <p>
|
|
2604
|
-
* An array of severity values used to search for insights.
|
|
2605
|
-
* </p>
|
|
3652
|
+
* <p> An array of severity values used to search for insights. </p>
|
|
2606
3653
|
*/
|
|
2607
3654
|
Severities?: (InsightSeverity | string)[];
|
|
2608
3655
|
/**
|
|
2609
|
-
* <p>
|
|
2610
|
-
* An array of status values used to search for insights.
|
|
2611
|
-
* </p>
|
|
3656
|
+
* <p> An array of status values used to search for insights. </p>
|
|
2612
3657
|
*/
|
|
2613
3658
|
Statuses?: (InsightStatus | string)[];
|
|
2614
3659
|
/**
|
|
2615
|
-
* <p>
|
|
2616
|
-
*
|
|
2617
|
-
*
|
|
2618
|
-
*
|
|
3660
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
3661
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
3662
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
3663
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
2619
3664
|
*/
|
|
2620
3665
|
ResourceCollection?: ResourceCollection;
|
|
2621
3666
|
/**
|
|
2622
|
-
* <p>A collection of the names of
|
|
3667
|
+
* <p>A collection of the names of Amazon Web Services services.</p>
|
|
2623
3668
|
*/
|
|
2624
3669
|
ServiceCollection?: ServiceCollection;
|
|
2625
3670
|
}
|
|
@@ -2631,15 +3676,13 @@ export declare namespace SearchInsightsFilters {
|
|
|
2631
3676
|
}
|
|
2632
3677
|
export interface SearchInsightsRequest {
|
|
2633
3678
|
/**
|
|
2634
|
-
* <p>
|
|
2635
|
-
*
|
|
2636
|
-
* </p>
|
|
3679
|
+
* <p> The start of the time range passed in. Returned insights occurred after this time.
|
|
3680
|
+
* </p>
|
|
2637
3681
|
*/
|
|
2638
3682
|
StartTimeRange: StartTimeRange | undefined;
|
|
2639
3683
|
/**
|
|
2640
|
-
* <p>
|
|
2641
|
-
*
|
|
2642
|
-
* </p>
|
|
3684
|
+
* <p> A <code>SearchInsightsFilters</code> object that is used to set the severity and
|
|
3685
|
+
* status filters on your insight search. </p>
|
|
2643
3686
|
*/
|
|
2644
3687
|
Filters?: SearchInsightsFilters;
|
|
2645
3688
|
/**
|
|
@@ -2653,9 +3696,8 @@ export interface SearchInsightsRequest {
|
|
|
2653
3696
|
*/
|
|
2654
3697
|
NextToken?: string;
|
|
2655
3698
|
/**
|
|
2656
|
-
* <p>
|
|
2657
|
-
*
|
|
2658
|
-
* </p>
|
|
3699
|
+
* <p> The type of insights you are searching for (<code>REACTIVE</code> or
|
|
3700
|
+
* <code>PROACTIVE</code>). </p>
|
|
2659
3701
|
*/
|
|
2660
3702
|
Type: InsightType | string | undefined;
|
|
2661
3703
|
}
|
|
@@ -2667,15 +3709,11 @@ export declare namespace SearchInsightsRequest {
|
|
|
2667
3709
|
}
|
|
2668
3710
|
export interface SearchInsightsResponse {
|
|
2669
3711
|
/**
|
|
2670
|
-
* <p>
|
|
2671
|
-
* The returned proactive insights.
|
|
2672
|
-
* </p>
|
|
3712
|
+
* <p> The returned proactive insights. </p>
|
|
2673
3713
|
*/
|
|
2674
3714
|
ProactiveInsights?: ProactiveInsightSummary[];
|
|
2675
3715
|
/**
|
|
2676
|
-
* <p>
|
|
2677
|
-
* The returned reactive insights.
|
|
2678
|
-
* </p>
|
|
3716
|
+
* <p> The returned reactive insights. </p>
|
|
2679
3717
|
*/
|
|
2680
3718
|
ReactiveInsights?: ReactiveInsightSummary[];
|
|
2681
3719
|
/**
|
|
@@ -2690,9 +3728,100 @@ export declare namespace SearchInsightsResponse {
|
|
|
2690
3728
|
*/
|
|
2691
3729
|
const filterSensitiveLog: (obj: SearchInsightsResponse) => any;
|
|
2692
3730
|
}
|
|
3731
|
+
/**
|
|
3732
|
+
* <p> Filters you can use to specify which events are returned when <code>ListEvents</code>
|
|
3733
|
+
* is called. </p>
|
|
3734
|
+
*/
|
|
3735
|
+
export interface SearchOrganizationInsightsFilters {
|
|
3736
|
+
/**
|
|
3737
|
+
* <p> An array of severity values used to search for insights. </p>
|
|
3738
|
+
*/
|
|
3739
|
+
Severities?: (InsightSeverity | string)[];
|
|
3740
|
+
/**
|
|
3741
|
+
* <p> An array of status values used to search for insights. </p>
|
|
3742
|
+
*/
|
|
3743
|
+
Statuses?: (InsightStatus | string)[];
|
|
3744
|
+
/**
|
|
3745
|
+
* <p> A collection of Amazon Web Services resources supported by DevOps Guru.
|
|
3746
|
+
* The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and
|
|
3747
|
+
* Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze
|
|
3748
|
+
* the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
3749
|
+
*/
|
|
3750
|
+
ResourceCollection?: ResourceCollection;
|
|
3751
|
+
/**
|
|
3752
|
+
* <p>A collection of the names of Amazon Web Services services.</p>
|
|
3753
|
+
*/
|
|
3754
|
+
ServiceCollection?: ServiceCollection;
|
|
3755
|
+
}
|
|
3756
|
+
export declare namespace SearchOrganizationInsightsFilters {
|
|
3757
|
+
/**
|
|
3758
|
+
* @internal
|
|
3759
|
+
*/
|
|
3760
|
+
const filterSensitiveLog: (obj: SearchOrganizationInsightsFilters) => any;
|
|
3761
|
+
}
|
|
3762
|
+
export interface SearchOrganizationInsightsRequest {
|
|
3763
|
+
/**
|
|
3764
|
+
* <p>The ID of the Amazon Web Services account. </p>
|
|
3765
|
+
*/
|
|
3766
|
+
AccountIds: string[] | undefined;
|
|
3767
|
+
/**
|
|
3768
|
+
* <p> A time range used to specify when the behavior of an insight or anomaly started.
|
|
3769
|
+
* </p>
|
|
3770
|
+
*/
|
|
3771
|
+
StartTimeRange: StartTimeRange | undefined;
|
|
3772
|
+
/**
|
|
3773
|
+
* <p> A <code>SearchOrganizationInsightsFilters</code> object that is used to set the
|
|
3774
|
+
* severity and status filters on your insight search. </p>
|
|
3775
|
+
*/
|
|
3776
|
+
Filters?: SearchOrganizationInsightsFilters;
|
|
3777
|
+
/**
|
|
3778
|
+
* <p>The maximum number of results to return with a single call.
|
|
3779
|
+
* To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
|
|
3780
|
+
*/
|
|
3781
|
+
MaxResults?: number;
|
|
3782
|
+
/**
|
|
3783
|
+
* <p>The pagination token to use to retrieve
|
|
3784
|
+
* the next page of results for this operation. If this value is null, it retrieves the first page.</p>
|
|
3785
|
+
*/
|
|
3786
|
+
NextToken?: string;
|
|
3787
|
+
/**
|
|
3788
|
+
* <p> The type of insights you are searching for (<code>REACTIVE</code> or
|
|
3789
|
+
* <code>PROACTIVE</code>). </p>
|
|
3790
|
+
*/
|
|
3791
|
+
Type: InsightType | string | undefined;
|
|
3792
|
+
}
|
|
3793
|
+
export declare namespace SearchOrganizationInsightsRequest {
|
|
3794
|
+
/**
|
|
3795
|
+
* @internal
|
|
3796
|
+
*/
|
|
3797
|
+
const filterSensitiveLog: (obj: SearchOrganizationInsightsRequest) => any;
|
|
3798
|
+
}
|
|
3799
|
+
export interface SearchOrganizationInsightsResponse {
|
|
3800
|
+
/**
|
|
3801
|
+
* <p>An integer that specifies the number of open proactive insights in your Amazon Web Services
|
|
3802
|
+
* account.</p>
|
|
3803
|
+
*/
|
|
3804
|
+
ProactiveInsights?: ProactiveInsightSummary[];
|
|
3805
|
+
/**
|
|
3806
|
+
* <p>An integer that specifies the number of open reactive insights in your Amazon Web Services
|
|
3807
|
+
* account.</p>
|
|
3808
|
+
*/
|
|
3809
|
+
ReactiveInsights?: ReactiveInsightSummary[];
|
|
3810
|
+
/**
|
|
3811
|
+
* <p>The pagination token to use to retrieve
|
|
3812
|
+
* the next page of results for this operation. If there are no more pages, this value is null.</p>
|
|
3813
|
+
*/
|
|
3814
|
+
NextToken?: string;
|
|
3815
|
+
}
|
|
3816
|
+
export declare namespace SearchOrganizationInsightsResponse {
|
|
3817
|
+
/**
|
|
3818
|
+
* @internal
|
|
3819
|
+
*/
|
|
3820
|
+
const filterSensitiveLog: (obj: SearchOrganizationInsightsResponse) => any;
|
|
3821
|
+
}
|
|
2693
3822
|
export interface StartCostEstimationRequest {
|
|
2694
3823
|
/**
|
|
2695
|
-
* <p>The collection of
|
|
3824
|
+
* <p>The collection of Amazon Web Services resources used to create a monthly DevOps Guru cost estimate.</p>
|
|
2696
3825
|
*/
|
|
2697
3826
|
ResourceCollection: CostEstimationResourceCollectionFilter | undefined;
|
|
2698
3827
|
/**
|
|
@@ -2719,12 +3848,12 @@ export declare enum UpdateResourceCollectionAction {
|
|
|
2719
3848
|
REMOVE = "REMOVE"
|
|
2720
3849
|
}
|
|
2721
3850
|
/**
|
|
2722
|
-
* <p> Contains the names of
|
|
3851
|
+
* <p> Contains the names of Amazon Web Services CloudFormation stacks used to update a collection of stacks.
|
|
3852
|
+
* You can specify up to 500 Amazon Web Services CloudFormation stacks.</p>
|
|
2723
3853
|
*/
|
|
2724
3854
|
export interface UpdateCloudFormationCollectionFilter {
|
|
2725
3855
|
/**
|
|
2726
|
-
* <p>
|
|
2727
|
-
* An array of the names of the AWS CloudFormation stacks to update. You can specify up to 500 AWS CloudFormation stacks.
|
|
3856
|
+
* <p> An array of the names of the Amazon Web Services CloudFormation stacks to update. You can specify up to 500 Amazon Web Services CloudFormation stacks.
|
|
2728
3857
|
* </p>
|
|
2729
3858
|
*/
|
|
2730
3859
|
StackNames?: string[];
|
|
@@ -2736,17 +3865,89 @@ export declare namespace UpdateCloudFormationCollectionFilter {
|
|
|
2736
3865
|
const filterSensitiveLog: (obj: UpdateCloudFormationCollectionFilter) => any;
|
|
2737
3866
|
}
|
|
2738
3867
|
/**
|
|
2739
|
-
* <p>
|
|
2740
|
-
*
|
|
2741
|
-
|
|
3868
|
+
* <p>A new collection of Amazon Web Services resources that are defined by an Amazon Web Services tag or tag
|
|
3869
|
+
* <i>key</i>/<i>value</i> pair.</p>
|
|
3870
|
+
*/
|
|
3871
|
+
export interface UpdateTagCollectionFilter {
|
|
3872
|
+
/**
|
|
3873
|
+
* <p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that
|
|
3874
|
+
* DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make
|
|
3875
|
+
* up your DevOps Guru application and analysis boundary.</p>
|
|
3876
|
+
* <important>
|
|
3877
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
3878
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
3879
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
3880
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
3881
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
3882
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
3883
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
3884
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
3885
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
3886
|
+
* </important>
|
|
3887
|
+
*/
|
|
3888
|
+
AppBoundaryKey: string | undefined;
|
|
3889
|
+
/**
|
|
3890
|
+
* <p>The values in an Amazon Web Services tag collection.</p>
|
|
3891
|
+
* <p>The tag's <i>value</i> is an optional field used to associate a string with
|
|
3892
|
+
* the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team
|
|
3893
|
+
* name). The <i>key</i> and <i>value</i> are the tag's <i>key</i> pair.
|
|
3894
|
+
* Omitting the tag <i>value</i> is the same as using an empty
|
|
3895
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
3896
|
+
* case-sensitive. You can specify a maximum of 256 characters for a tag value.</p>
|
|
3897
|
+
*/
|
|
3898
|
+
TagValues: string[] | undefined;
|
|
3899
|
+
}
|
|
3900
|
+
export declare namespace UpdateTagCollectionFilter {
|
|
3901
|
+
/**
|
|
3902
|
+
* @internal
|
|
3903
|
+
*/
|
|
3904
|
+
const filterSensitiveLog: (obj: UpdateTagCollectionFilter) => any;
|
|
3905
|
+
}
|
|
3906
|
+
/**
|
|
3907
|
+
* <p> Contains information used to update a collection of Amazon Web Services resources. </p>
|
|
2742
3908
|
*/
|
|
2743
3909
|
export interface UpdateResourceCollectionFilter {
|
|
2744
3910
|
/**
|
|
2745
|
-
* <p>
|
|
2746
|
-
* An collection of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.
|
|
2747
|
-
* </p>
|
|
3911
|
+
* <p> A collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>
|
|
2748
3912
|
*/
|
|
2749
3913
|
CloudFormation?: UpdateCloudFormationCollectionFilter;
|
|
3914
|
+
/**
|
|
3915
|
+
* <p>The updated Amazon Web Services tags used to filter the resources in the resource collection.</p>
|
|
3916
|
+
* <p>Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support
|
|
3917
|
+
* tagging, so you can assign the same tag to resources from different services to indicate
|
|
3918
|
+
* that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB
|
|
3919
|
+
* table resource that you assign to an Lambda function. For more information about
|
|
3920
|
+
* using tags, see the <a href="https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf">Tagging
|
|
3921
|
+
* best practices</a> whitepaper. </p>
|
|
3922
|
+
* <p>Each Amazon Web Services tag has two parts. </p>
|
|
3923
|
+
* <ul>
|
|
3924
|
+
* <li>
|
|
3925
|
+
* <p>A tag <i>key</i> (for example, <code>CostCenter</code>,
|
|
3926
|
+
* <code>Environment</code>, <code>Project</code>, or <code>Secret</code>). Tag
|
|
3927
|
+
* <i>keys</i> are case-sensitive.</p>
|
|
3928
|
+
* </li>
|
|
3929
|
+
* <li>
|
|
3930
|
+
* <p>An optional field known as a tag <i>value</i> (for example,
|
|
3931
|
+
* <code>111122223333</code>, <code>Production</code>, or a team
|
|
3932
|
+
* name). Omitting the tag <i>value</i> is the same as using an empty
|
|
3933
|
+
* string. Like tag <i>keys</i>, tag <i>values</i> are
|
|
3934
|
+
* case-sensitive.</p>
|
|
3935
|
+
* </li>
|
|
3936
|
+
* </ul>
|
|
3937
|
+
* <p>Together these are known as <i>key</i>-<i>value</i> pairs.</p>
|
|
3938
|
+
* <important>
|
|
3939
|
+
* <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the
|
|
3940
|
+
* prefix <code>Devops-guru-</code>. The tag <i>key</i> might be
|
|
3941
|
+
* <code>Devops-guru-deployment-application</code> or
|
|
3942
|
+
* <code>Devops-guru-rds-application</code>. While <i>keys</i> are case-sensitive, the
|
|
3943
|
+
* case of <i>key</i> characters don't matter to DevOps Guru. For example, DevOps Guru works with a
|
|
3944
|
+
* <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named
|
|
3945
|
+
* <code>DevOps-Guru-RDS</code>. Possible <i>key</i>/<i>value</i> pairs in your
|
|
3946
|
+
* application might be <code>Devops-Guru-production-application/RDS</code> or
|
|
3947
|
+
* <code>Devops-Guru-production-application/containers</code>.</p>
|
|
3948
|
+
* </important>
|
|
3949
|
+
*/
|
|
3950
|
+
Tags?: UpdateTagCollectionFilter[];
|
|
2750
3951
|
}
|
|
2751
3952
|
export declare namespace UpdateResourceCollectionFilter {
|
|
2752
3953
|
/**
|
|
@@ -2756,15 +3957,12 @@ export declare namespace UpdateResourceCollectionFilter {
|
|
|
2756
3957
|
}
|
|
2757
3958
|
export interface UpdateResourceCollectionRequest {
|
|
2758
3959
|
/**
|
|
2759
|
-
* <p>
|
|
2760
|
-
*
|
|
2761
|
-
* </p>
|
|
3960
|
+
* <p> Specifies if the resource collection in the request is added or deleted to the
|
|
3961
|
+
* resource collection. </p>
|
|
2762
3962
|
*/
|
|
2763
3963
|
Action: UpdateResourceCollectionAction | string | undefined;
|
|
2764
3964
|
/**
|
|
2765
|
-
* <p>
|
|
2766
|
-
* Contains information used to update a collection of AWS resources.
|
|
2767
|
-
* </p>
|
|
3965
|
+
* <p> Contains information used to update a collection of Amazon Web Services resources. </p>
|
|
2768
3966
|
*/
|
|
2769
3967
|
ResourceCollection: UpdateResourceCollectionFilter | undefined;
|
|
2770
3968
|
}
|
|
@@ -2783,15 +3981,13 @@ export declare namespace UpdateResourceCollectionResponse {
|
|
|
2783
3981
|
const filterSensitiveLog: (obj: UpdateResourceCollectionResponse) => any;
|
|
2784
3982
|
}
|
|
2785
3983
|
/**
|
|
2786
|
-
* <p>
|
|
2787
|
-
*
|
|
2788
|
-
* </p>
|
|
3984
|
+
* <p> Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager
|
|
3985
|
+
* OpsCenter for each created insight. </p>
|
|
2789
3986
|
*/
|
|
2790
3987
|
export interface OpsCenterIntegrationConfig {
|
|
2791
3988
|
/**
|
|
2792
|
-
* <p>
|
|
2793
|
-
*
|
|
2794
|
-
* </p>
|
|
3989
|
+
* <p> Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created
|
|
3990
|
+
* insight. </p>
|
|
2795
3991
|
*/
|
|
2796
3992
|
OptInStatus?: OptInStatus | string;
|
|
2797
3993
|
}
|
|
@@ -2802,15 +3998,13 @@ export declare namespace OpsCenterIntegrationConfig {
|
|
|
2802
3998
|
const filterSensitiveLog: (obj: OpsCenterIntegrationConfig) => any;
|
|
2803
3999
|
}
|
|
2804
4000
|
/**
|
|
2805
|
-
* <p>
|
|
2806
|
-
*
|
|
2807
|
-
* </p>
|
|
4001
|
+
* <p> Information about updating the integration status of an Amazon Web Services service, such as
|
|
4002
|
+
* Amazon Web Services Systems Manager, with DevOps Guru. </p>
|
|
2808
4003
|
*/
|
|
2809
4004
|
export interface UpdateServiceIntegrationConfig {
|
|
2810
4005
|
/**
|
|
2811
|
-
* <p>
|
|
2812
|
-
*
|
|
2813
|
-
* </p>
|
|
4006
|
+
* <p> Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager
|
|
4007
|
+
* OpsCenter for each created insight. </p>
|
|
2814
4008
|
*/
|
|
2815
4009
|
OpsCenter?: OpsCenterIntegrationConfig;
|
|
2816
4010
|
}
|
|
@@ -2822,10 +4016,8 @@ export declare namespace UpdateServiceIntegrationConfig {
|
|
|
2822
4016
|
}
|
|
2823
4017
|
export interface UpdateServiceIntegrationRequest {
|
|
2824
4018
|
/**
|
|
2825
|
-
* <p>
|
|
2826
|
-
*
|
|
2827
|
-
* want to update it to enabled or disabled.
|
|
2828
|
-
* </p>
|
|
4019
|
+
* <p> An <code>IntegratedServiceConfig</code> object used to specify the integrated service
|
|
4020
|
+
* you want to update, and whether you want to update it to enabled or disabled. </p>
|
|
2829
4021
|
*/
|
|
2830
4022
|
ServiceIntegration: UpdateServiceIntegrationConfig | undefined;
|
|
2831
4023
|
}
|