@aws-sdk/client-amp 3.509.0 → 3.513.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -1
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +1 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +47 -0
- package/dist-cjs/index.js +103 -45
- package/dist-cjs/runtimeConfig.shared.js +10 -0
- package/dist-es/AmpClient.js +17 -4
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +41 -0
- package/dist-es/runtimeConfig.shared.js +10 -0
- package/dist-es/runtimeExtensions.js +3 -0
- package/dist-types/Amp.d.ts +18 -1
- package/dist-types/AmpClient.d.ts +31 -12
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +61 -0
- package/dist-types/commands/CreateAlertManagerDefinitionCommand.d.ts +12 -8
- package/dist-types/commands/CreateLoggingConfigurationCommand.d.ts +8 -5
- package/dist-types/commands/CreateRuleGroupsNamespaceCommand.d.ts +13 -8
- package/dist-types/commands/CreateScraperCommand.d.ts +26 -8
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +10 -7
- package/dist-types/commands/DeleteAlertManagerDefinitionCommand.d.ts +8 -7
- package/dist-types/commands/DeleteLoggingConfigurationCommand.d.ts +7 -6
- package/dist-types/commands/DeleteRuleGroupsNamespaceCommand.d.ts +8 -7
- package/dist-types/commands/DeleteScraperCommand.d.ts +9 -7
- package/dist-types/commands/DeleteWorkspaceCommand.d.ts +12 -7
- package/dist-types/commands/DescribeAlertManagerDefinitionCommand.d.ts +8 -6
- package/dist-types/commands/DescribeLoggingConfigurationCommand.d.ts +7 -5
- package/dist-types/commands/DescribeRuleGroupsNamespaceCommand.d.ts +8 -6
- package/dist-types/commands/DescribeScraperCommand.d.ts +8 -6
- package/dist-types/commands/DescribeWorkspaceCommand.d.ts +7 -6
- package/dist-types/commands/GetDefaultScraperConfigurationCommand.d.ts +5 -4
- package/dist-types/commands/ListRuleGroupsNamespacesCommand.d.ts +7 -6
- package/dist-types/commands/ListScrapersCommand.d.ts +8 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +9 -6
- package/dist-types/commands/ListWorkspacesCommand.d.ts +7 -5
- package/dist-types/commands/PutAlertManagerDefinitionCommand.d.ts +11 -8
- package/dist-types/commands/PutRuleGroupsNamespaceCommand.d.ts +15 -8
- package/dist-types/commands/TagResourceCommand.d.ts +13 -6
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -6
- package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts +8 -6
- package/dist-types/commands/UpdateWorkspaceAliasCommand.d.ts +9 -8
- package/dist-types/extensionConfiguration.d.ts +2 -1
- package/dist-types/index.d.ts +18 -1
- package/dist-types/models/models_0.d.ts +360 -260
- package/dist-types/runtimeConfig.browser.d.ts +5 -3
- package/dist-types/runtimeConfig.d.ts +4 -2
- package/dist-types/runtimeConfig.native.d.ts +6 -4
- package/dist-types/runtimeConfig.shared.d.ts +2 -0
- package/dist-types/ts3.4/AmpClient.d.ts +11 -9
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +3 -1
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -5
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -4
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -8
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -0
- package/package.json +16 -16
|
@@ -2,7 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { AmpServiceException as __BaseException } from "./AmpServiceException";
|
|
3
3
|
/**
|
|
4
4
|
* @public
|
|
5
|
-
*
|
|
5
|
+
* <p>You do not have sufficient access to perform this action.</p>
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -14,19 +14,19 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* @public
|
|
17
|
-
*
|
|
17
|
+
* <p>The request would cause an inconsistent state.</p>
|
|
18
18
|
*/
|
|
19
19
|
export declare class ConflictException extends __BaseException {
|
|
20
20
|
readonly name: "ConflictException";
|
|
21
21
|
readonly $fault: "client";
|
|
22
22
|
/**
|
|
23
23
|
* @public
|
|
24
|
-
* Identifier of the resource affected
|
|
24
|
+
* <p>Identifier of the resource affected.</p>
|
|
25
25
|
*/
|
|
26
26
|
resourceId: string | undefined;
|
|
27
27
|
/**
|
|
28
28
|
* @public
|
|
29
|
-
* Type of the resource affected
|
|
29
|
+
* <p>Type of the resource affected.</p>
|
|
30
30
|
*/
|
|
31
31
|
resourceType: string | undefined;
|
|
32
32
|
/**
|
|
@@ -36,22 +36,25 @@ export declare class ConflictException extends __BaseException {
|
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
38
|
* @public
|
|
39
|
-
* Represents the input of a CreateAlertManagerDefinition operation
|
|
39
|
+
* <p>Represents the input of a <code>CreateAlertManagerDefinition</code> operation.</p>
|
|
40
40
|
*/
|
|
41
41
|
export interface CreateAlertManagerDefinitionRequest {
|
|
42
42
|
/**
|
|
43
43
|
* @public
|
|
44
|
-
* The ID of the workspace
|
|
44
|
+
* <p>The ID of the workspace to add the alert manager definition to.</p>
|
|
45
45
|
*/
|
|
46
46
|
workspaceId: string | undefined;
|
|
47
47
|
/**
|
|
48
48
|
* @public
|
|
49
|
-
* The alert manager definition
|
|
49
|
+
* <p>The alert manager definition to add. A base64-encoded version of the YAML alert
|
|
50
|
+
* manager definition file.</p>
|
|
51
|
+
* <p>For details about the alert manager definition, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html">AlertManagedDefinitionData</a>.</p>
|
|
50
52
|
*/
|
|
51
53
|
data: Uint8Array | undefined;
|
|
52
54
|
/**
|
|
53
55
|
* @public
|
|
54
|
-
*
|
|
56
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
57
|
+
* Case-sensitive.</p>
|
|
55
58
|
*/
|
|
56
59
|
clientToken?: string;
|
|
57
60
|
}
|
|
@@ -91,34 +94,34 @@ export declare const AlertManagerDefinitionStatusCode: {
|
|
|
91
94
|
export type AlertManagerDefinitionStatusCode = (typeof AlertManagerDefinitionStatusCode)[keyof typeof AlertManagerDefinitionStatusCode];
|
|
92
95
|
/**
|
|
93
96
|
* @public
|
|
94
|
-
*
|
|
97
|
+
* <p>The status of the alert manager. </p>
|
|
95
98
|
*/
|
|
96
99
|
export interface AlertManagerDefinitionStatus {
|
|
97
100
|
/**
|
|
98
101
|
* @public
|
|
99
|
-
*
|
|
102
|
+
* <p>The current status of the alert manager. </p>
|
|
100
103
|
*/
|
|
101
104
|
statusCode: AlertManagerDefinitionStatusCode | undefined;
|
|
102
105
|
/**
|
|
103
106
|
* @public
|
|
104
|
-
*
|
|
107
|
+
* <p>If there is a failure, the reason for the failure.</p>
|
|
105
108
|
*/
|
|
106
109
|
statusReason?: string;
|
|
107
110
|
}
|
|
108
111
|
/**
|
|
109
112
|
* @public
|
|
110
|
-
* Represents the output of a CreateAlertManagerDefinition operation
|
|
113
|
+
* <p>Represents the output of a <code>CreateAlertManagerDefinition</code> operation.</p>
|
|
111
114
|
*/
|
|
112
115
|
export interface CreateAlertManagerDefinitionResponse {
|
|
113
116
|
/**
|
|
114
117
|
* @public
|
|
115
|
-
*
|
|
118
|
+
* <p>A structure that displays the current status of the alert manager definition.</p>
|
|
116
119
|
*/
|
|
117
120
|
status: AlertManagerDefinitionStatus | undefined;
|
|
118
121
|
}
|
|
119
122
|
/**
|
|
120
123
|
* @public
|
|
121
|
-
*
|
|
124
|
+
* <p>An unexpected error occurred during the processing of the request.</p>
|
|
122
125
|
*/
|
|
123
126
|
export declare class InternalServerException extends __BaseException {
|
|
124
127
|
readonly name: "InternalServerException";
|
|
@@ -126,7 +129,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
126
129
|
$retryable: {};
|
|
127
130
|
/**
|
|
128
131
|
* @public
|
|
129
|
-
* Advice to clients on when the call can be safely retried
|
|
132
|
+
* <p>Advice to clients on when the call can be safely retried.</p>
|
|
130
133
|
*/
|
|
131
134
|
retryAfterSeconds?: number;
|
|
132
135
|
/**
|
|
@@ -136,19 +139,19 @@ export declare class InternalServerException extends __BaseException {
|
|
|
136
139
|
}
|
|
137
140
|
/**
|
|
138
141
|
* @public
|
|
139
|
-
*
|
|
142
|
+
* <p>The request references a resources that doesn't exist.</p>
|
|
140
143
|
*/
|
|
141
144
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
142
145
|
readonly name: "ResourceNotFoundException";
|
|
143
146
|
readonly $fault: "client";
|
|
144
147
|
/**
|
|
145
148
|
* @public
|
|
146
|
-
* Identifier of the resource affected
|
|
149
|
+
* <p>Identifier of the resource affected.</p>
|
|
147
150
|
*/
|
|
148
151
|
resourceId: string | undefined;
|
|
149
152
|
/**
|
|
150
153
|
* @public
|
|
151
|
-
* Type of the resource affected
|
|
154
|
+
* <p>Type of the resource affected.</p>
|
|
152
155
|
*/
|
|
153
156
|
resourceType: string | undefined;
|
|
154
157
|
/**
|
|
@@ -158,29 +161,29 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
158
161
|
}
|
|
159
162
|
/**
|
|
160
163
|
* @public
|
|
161
|
-
*
|
|
164
|
+
* <p>Completing the request would cause a service quota to be exceeded.</p>
|
|
162
165
|
*/
|
|
163
166
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
164
167
|
readonly name: "ServiceQuotaExceededException";
|
|
165
168
|
readonly $fault: "client";
|
|
166
169
|
/**
|
|
167
170
|
* @public
|
|
168
|
-
* Identifier of the resource affected
|
|
171
|
+
* <p>Identifier of the resource affected.</p>
|
|
169
172
|
*/
|
|
170
173
|
resourceId: string | undefined;
|
|
171
174
|
/**
|
|
172
175
|
* @public
|
|
173
|
-
* Type of the resource affected
|
|
176
|
+
* <p>Type of the resource affected.</p>
|
|
174
177
|
*/
|
|
175
178
|
resourceType: string | undefined;
|
|
176
179
|
/**
|
|
177
180
|
* @public
|
|
178
|
-
* Service
|
|
181
|
+
* <p>Service quotas code for the originating service.</p>
|
|
179
182
|
*/
|
|
180
183
|
serviceCode: string | undefined;
|
|
181
184
|
/**
|
|
182
185
|
* @public
|
|
183
|
-
* Service
|
|
186
|
+
* <p>Service quotas code of the originating quota.</p>
|
|
184
187
|
*/
|
|
185
188
|
quotaCode: string | undefined;
|
|
186
189
|
/**
|
|
@@ -190,7 +193,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
190
193
|
}
|
|
191
194
|
/**
|
|
192
195
|
* @public
|
|
193
|
-
*
|
|
196
|
+
* <p>The request was denied due to request throttling.</p>
|
|
194
197
|
*/
|
|
195
198
|
export declare class ThrottlingException extends __BaseException {
|
|
196
199
|
readonly name: "ThrottlingException";
|
|
@@ -198,17 +201,17 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
198
201
|
$retryable: {};
|
|
199
202
|
/**
|
|
200
203
|
* @public
|
|
201
|
-
* Service
|
|
204
|
+
* <p>Service quotas code for the originating service.</p>
|
|
202
205
|
*/
|
|
203
206
|
serviceCode?: string;
|
|
204
207
|
/**
|
|
205
208
|
* @public
|
|
206
|
-
* Service
|
|
209
|
+
* <p>Service quotas code for the originating quota.</p>
|
|
207
210
|
*/
|
|
208
211
|
quotaCode?: string;
|
|
209
212
|
/**
|
|
210
213
|
* @public
|
|
211
|
-
* Advice to clients on when the call can be safely retried
|
|
214
|
+
* <p>Advice to clients on when the call can be safely retried.</p>
|
|
212
215
|
*/
|
|
213
216
|
retryAfterSeconds?: number;
|
|
214
217
|
/**
|
|
@@ -218,17 +221,17 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
218
221
|
}
|
|
219
222
|
/**
|
|
220
223
|
* @public
|
|
221
|
-
*
|
|
224
|
+
* <p>Information about a field passed into a request that resulted in an exception.</p>
|
|
222
225
|
*/
|
|
223
226
|
export interface ValidationExceptionField {
|
|
224
227
|
/**
|
|
225
228
|
* @public
|
|
226
|
-
* The field
|
|
229
|
+
* <p>The name of the field that caused an exception.</p>
|
|
227
230
|
*/
|
|
228
231
|
name: string | undefined;
|
|
229
232
|
/**
|
|
230
233
|
* @public
|
|
231
|
-
*
|
|
234
|
+
* <p>A message describing why the field caused an exception.</p>
|
|
232
235
|
*/
|
|
233
236
|
message: string | undefined;
|
|
234
237
|
}
|
|
@@ -248,19 +251,20 @@ export declare const ValidationExceptionReason: {
|
|
|
248
251
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
249
252
|
/**
|
|
250
253
|
* @public
|
|
251
|
-
* The input fails to satisfy the constraints specified by an
|
|
254
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
255
|
+
* service.</p>
|
|
252
256
|
*/
|
|
253
257
|
export declare class ValidationException extends __BaseException {
|
|
254
258
|
readonly name: "ValidationException";
|
|
255
259
|
readonly $fault: "client";
|
|
256
260
|
/**
|
|
257
261
|
* @public
|
|
258
|
-
* Reason the request failed validation
|
|
262
|
+
* <p>Reason the request failed validation.</p>
|
|
259
263
|
*/
|
|
260
264
|
reason: ValidationExceptionReason | undefined;
|
|
261
265
|
/**
|
|
262
266
|
* @public
|
|
263
|
-
* The field that caused the error, if applicable
|
|
267
|
+
* <p>The field that caused the error, if applicable.</p>
|
|
264
268
|
*/
|
|
265
269
|
fieldList?: ValidationExceptionField[];
|
|
266
270
|
/**
|
|
@@ -270,114 +274,121 @@ export declare class ValidationException extends __BaseException {
|
|
|
270
274
|
}
|
|
271
275
|
/**
|
|
272
276
|
* @public
|
|
273
|
-
* Represents the input of a DeleteAlertManagerDefinition operation
|
|
277
|
+
* <p>Represents the input of a <code>DeleteAlertManagerDefinition</code> operation.</p>
|
|
274
278
|
*/
|
|
275
279
|
export interface DeleteAlertManagerDefinitionRequest {
|
|
276
280
|
/**
|
|
277
281
|
* @public
|
|
278
|
-
* The ID of the workspace
|
|
282
|
+
* <p>The ID of the workspace to delete the alert manager definition from.</p>
|
|
279
283
|
*/
|
|
280
284
|
workspaceId: string | undefined;
|
|
281
285
|
/**
|
|
282
286
|
* @public
|
|
283
|
-
*
|
|
287
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
288
|
+
* Case-sensitive.</p>
|
|
284
289
|
*/
|
|
285
290
|
clientToken?: string;
|
|
286
291
|
}
|
|
287
292
|
/**
|
|
288
293
|
* @public
|
|
289
|
-
* Represents the input of a DescribeAlertManagerDefinition operation
|
|
294
|
+
* <p>Represents the input of a <code>DescribeAlertManagerDefinition</code> operation.</p>
|
|
290
295
|
*/
|
|
291
296
|
export interface DescribeAlertManagerDefinitionRequest {
|
|
292
297
|
/**
|
|
293
298
|
* @public
|
|
294
|
-
* The ID of the workspace to
|
|
299
|
+
* <p>The ID of the workspace to retrieve the alert manager definition from.</p>
|
|
295
300
|
*/
|
|
296
301
|
workspaceId: string | undefined;
|
|
297
302
|
}
|
|
298
303
|
/**
|
|
299
304
|
* @public
|
|
300
|
-
*
|
|
305
|
+
* <p>The details of an alert manager definition. </p>
|
|
301
306
|
*/
|
|
302
307
|
export interface AlertManagerDefinitionDescription {
|
|
303
308
|
/**
|
|
304
309
|
* @public
|
|
305
|
-
*
|
|
310
|
+
* <p>A structure that displays the current status of the alert manager definition..</p>
|
|
306
311
|
*/
|
|
307
312
|
status: AlertManagerDefinitionStatus | undefined;
|
|
308
313
|
/**
|
|
309
314
|
* @public
|
|
310
|
-
* The alert manager definition
|
|
315
|
+
* <p>The actual alert manager definition.</p>
|
|
316
|
+
* <p>For details about the alert manager definition, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html">AlertManagedDefinitionData</a>.</p>
|
|
311
317
|
*/
|
|
312
318
|
data: Uint8Array | undefined;
|
|
313
319
|
/**
|
|
314
320
|
* @public
|
|
315
|
-
* The time
|
|
321
|
+
* <p>The date and time that the alert manager definition was created.</p>
|
|
316
322
|
*/
|
|
317
323
|
createdAt: Date | undefined;
|
|
318
324
|
/**
|
|
319
325
|
* @public
|
|
320
|
-
* The time
|
|
326
|
+
* <p>The date and time that the alert manager definition was most recently changed.</p>
|
|
321
327
|
*/
|
|
322
328
|
modifiedAt: Date | undefined;
|
|
323
329
|
}
|
|
324
330
|
/**
|
|
325
331
|
* @public
|
|
326
|
-
* Represents the output of a DescribeAlertManagerDefinition operation
|
|
332
|
+
* <p>Represents the output of a <code>DescribeAlertManagerDefinition</code> operation.</p>
|
|
327
333
|
*/
|
|
328
334
|
export interface DescribeAlertManagerDefinitionResponse {
|
|
329
335
|
/**
|
|
330
336
|
* @public
|
|
331
|
-
* The
|
|
337
|
+
* <p>The alert manager definition.</p>
|
|
332
338
|
*/
|
|
333
339
|
alertManagerDefinition: AlertManagerDefinitionDescription | undefined;
|
|
334
340
|
}
|
|
335
341
|
/**
|
|
336
342
|
* @public
|
|
337
|
-
* Represents the input of a PutAlertManagerDefinition operation
|
|
343
|
+
* <p>Represents the input of a <code>PutAlertManagerDefinition</code> operation.</p>
|
|
338
344
|
*/
|
|
339
345
|
export interface PutAlertManagerDefinitionRequest {
|
|
340
346
|
/**
|
|
341
347
|
* @public
|
|
342
|
-
* The ID of the workspace
|
|
348
|
+
* <p>The ID of the workspace to update the alert manager definition in.</p>
|
|
343
349
|
*/
|
|
344
350
|
workspaceId: string | undefined;
|
|
345
351
|
/**
|
|
346
352
|
* @public
|
|
347
|
-
* The alert manager definition
|
|
353
|
+
* <p>The alert manager definition to use. A base64-encoded version of the YAML alert
|
|
354
|
+
* manager definition file.</p>
|
|
355
|
+
* <p>For details about the alert manager definition, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html">AlertManagedDefinitionData</a>.</p>
|
|
348
356
|
*/
|
|
349
357
|
data: Uint8Array | undefined;
|
|
350
358
|
/**
|
|
351
359
|
* @public
|
|
352
|
-
*
|
|
360
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
361
|
+
* Case-sensitive.</p>
|
|
353
362
|
*/
|
|
354
363
|
clientToken?: string;
|
|
355
364
|
}
|
|
356
365
|
/**
|
|
357
366
|
* @public
|
|
358
|
-
* Represents the output of a PutAlertManagerDefinition operation
|
|
367
|
+
* <p>Represents the output of a <code>PutAlertManagerDefinition</code> operation.</p>
|
|
359
368
|
*/
|
|
360
369
|
export interface PutAlertManagerDefinitionResponse {
|
|
361
370
|
/**
|
|
362
371
|
* @public
|
|
363
|
-
*
|
|
372
|
+
* <p>A structure that returns the current status of the alert manager definition.</p>
|
|
364
373
|
*/
|
|
365
374
|
status: AlertManagerDefinitionStatus | undefined;
|
|
366
375
|
}
|
|
367
376
|
/**
|
|
368
377
|
* @public
|
|
369
|
-
* Represents the input of a GetDefaultScraperConfiguration operation
|
|
378
|
+
* <p>Represents the input of a <code>GetDefaultScraperConfiguration</code> operation.</p>
|
|
370
379
|
*/
|
|
371
380
|
export interface GetDefaultScraperConfigurationRequest {
|
|
372
381
|
}
|
|
373
382
|
/**
|
|
374
383
|
* @public
|
|
375
|
-
* Represents the output of a GetDefaultScraperConfiguration operation
|
|
384
|
+
* <p>Represents the output of a <code>GetDefaultScraperConfiguration</code> operation.</p>
|
|
376
385
|
*/
|
|
377
386
|
export interface GetDefaultScraperConfigurationResponse {
|
|
378
387
|
/**
|
|
379
388
|
* @public
|
|
380
|
-
* The
|
|
389
|
+
* <p>The configuration file. Base 64 encoded.
|
|
390
|
+
* For more information, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration">Scraper configuration</a>in the <i>Amazon Managed Service for Prometheus User
|
|
391
|
+
* Guide</i>.</p>
|
|
381
392
|
*/
|
|
382
393
|
configuration: Uint8Array | undefined;
|
|
383
394
|
}
|
|
@@ -387,7 +398,8 @@ export interface GetDefaultScraperConfigurationResponse {
|
|
|
387
398
|
export interface ListTagsForResourceRequest {
|
|
388
399
|
/**
|
|
389
400
|
* @public
|
|
390
|
-
* The ARN of the resource.
|
|
401
|
+
* <p>The ARN of the resource to list tages for. Must be a workspace or rule groups
|
|
402
|
+
* namespace resource.</p>
|
|
391
403
|
*/
|
|
392
404
|
resourceArn: string | undefined;
|
|
393
405
|
}
|
|
@@ -397,24 +409,25 @@ export interface ListTagsForResourceRequest {
|
|
|
397
409
|
export interface ListTagsForResourceResponse {
|
|
398
410
|
/**
|
|
399
411
|
* @public
|
|
400
|
-
* The list of
|
|
412
|
+
* <p>The list of tag keys and values associated with the resource.</p>
|
|
401
413
|
*/
|
|
402
414
|
tags?: Record<string, string>;
|
|
403
415
|
}
|
|
404
416
|
/**
|
|
405
417
|
* @public
|
|
406
|
-
*
|
|
418
|
+
* <p>The <code>AmpConfiguration</code> structure defines the Amazon Managed Service for Prometheus instance a scraper
|
|
419
|
+
* should send metrics to.</p>
|
|
407
420
|
*/
|
|
408
421
|
export interface AmpConfiguration {
|
|
409
422
|
/**
|
|
410
423
|
* @public
|
|
411
|
-
*
|
|
424
|
+
* <p>ARN of the Amazon Managed Service for Prometheus workspace.</p>
|
|
412
425
|
*/
|
|
413
426
|
workspaceArn: string | undefined;
|
|
414
427
|
}
|
|
415
428
|
/**
|
|
416
429
|
* @public
|
|
417
|
-
*
|
|
430
|
+
* <p>Where to send the metrics from a scraper.</p>
|
|
418
431
|
*/
|
|
419
432
|
export type Destination = Destination.AmpConfigurationMember | Destination.$UnknownMember;
|
|
420
433
|
/**
|
|
@@ -423,7 +436,7 @@ export type Destination = Destination.AmpConfigurationMember | Destination.$Unkn
|
|
|
423
436
|
export declare namespace Destination {
|
|
424
437
|
/**
|
|
425
438
|
* @public
|
|
426
|
-
*
|
|
439
|
+
* <p>The Amazon Managed Service for Prometheusworkspace to send metrics to.</p>
|
|
427
440
|
*/
|
|
428
441
|
interface AmpConfigurationMember {
|
|
429
442
|
ampConfiguration: AmpConfiguration;
|
|
@@ -444,7 +457,8 @@ export declare namespace Destination {
|
|
|
444
457
|
}
|
|
445
458
|
/**
|
|
446
459
|
* @public
|
|
447
|
-
* A
|
|
460
|
+
* <p>A scrape configuration for a scraper, base 64 encoded. For more information, see <a href="prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration">Scraper configuration</a> in the <i>Amazon Managed Service for Prometheus User
|
|
461
|
+
* Guide</i>.</p>
|
|
448
462
|
*/
|
|
449
463
|
export type ScrapeConfiguration = ScrapeConfiguration.ConfigurationBlobMember | ScrapeConfiguration.$UnknownMember;
|
|
450
464
|
/**
|
|
@@ -453,7 +467,7 @@ export type ScrapeConfiguration = ScrapeConfiguration.ConfigurationBlobMember |
|
|
|
453
467
|
export declare namespace ScrapeConfiguration {
|
|
454
468
|
/**
|
|
455
469
|
* @public
|
|
456
|
-
*
|
|
470
|
+
* <p>The base 64 encoded scrape configuration file.</p>
|
|
457
471
|
*/
|
|
458
472
|
interface ConfigurationBlobMember {
|
|
459
473
|
configurationBlob: Uint8Array;
|
|
@@ -474,28 +488,29 @@ export declare namespace ScrapeConfiguration {
|
|
|
474
488
|
}
|
|
475
489
|
/**
|
|
476
490
|
* @public
|
|
477
|
-
*
|
|
491
|
+
* <p>The <code>EksConfiguration</code> structure describes the connection to the
|
|
492
|
+
* Amazon EKS cluster from which a scraper collects metrics.</p>
|
|
478
493
|
*/
|
|
479
494
|
export interface EksConfiguration {
|
|
480
495
|
/**
|
|
481
496
|
* @public
|
|
482
|
-
*
|
|
497
|
+
* <p>ARN of the Amazon EKS cluster.</p>
|
|
483
498
|
*/
|
|
484
499
|
clusterArn: string | undefined;
|
|
485
500
|
/**
|
|
486
501
|
* @public
|
|
487
|
-
* A list of security group IDs
|
|
502
|
+
* <p>A list of the security group IDs for the Amazon EKS cluster VPC configuration.</p>
|
|
488
503
|
*/
|
|
489
504
|
securityGroupIds?: string[];
|
|
490
505
|
/**
|
|
491
506
|
* @public
|
|
492
|
-
* A list of subnet IDs
|
|
507
|
+
* <p>A list of subnet IDs for the Amazon EKS cluster VPC configuration.</p>
|
|
493
508
|
*/
|
|
494
509
|
subnetIds: string[] | undefined;
|
|
495
510
|
}
|
|
496
511
|
/**
|
|
497
512
|
* @public
|
|
498
|
-
*
|
|
513
|
+
* <p>The source of collected metrics for a scraper.</p>
|
|
499
514
|
*/
|
|
500
515
|
export type Source = Source.EksConfigurationMember | Source.$UnknownMember;
|
|
501
516
|
/**
|
|
@@ -504,7 +519,7 @@ export type Source = Source.EksConfigurationMember | Source.$UnknownMember;
|
|
|
504
519
|
export declare namespace Source {
|
|
505
520
|
/**
|
|
506
521
|
* @public
|
|
507
|
-
*
|
|
522
|
+
* <p>The Amazon EKS cluster from which a scraper collects metrics.</p>
|
|
508
523
|
*/
|
|
509
524
|
interface EksConfigurationMember {
|
|
510
525
|
eksConfiguration: EksConfiguration;
|
|
@@ -525,37 +540,40 @@ export declare namespace Source {
|
|
|
525
540
|
}
|
|
526
541
|
/**
|
|
527
542
|
* @public
|
|
528
|
-
* Represents the input of a CreateScraper operation
|
|
543
|
+
* <p>Represents the input of a <code>CreateScraper</code> operation.</p>
|
|
529
544
|
*/
|
|
530
545
|
export interface CreateScraperRequest {
|
|
531
546
|
/**
|
|
532
547
|
* @public
|
|
533
|
-
*
|
|
548
|
+
* <p>(optional) a name to associate with the scraper. This is for your use, and does not
|
|
549
|
+
* need to be unique.</p>
|
|
534
550
|
*/
|
|
535
551
|
alias?: string;
|
|
536
552
|
/**
|
|
537
553
|
* @public
|
|
538
|
-
* The configuration
|
|
554
|
+
* <p>The configuration file to use in the new scraper. For more information, see <a href="prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration">Scraper configuration</a> in the <i>Amazon Managed Service for Prometheus User
|
|
555
|
+
* Guide</i>.</p>
|
|
539
556
|
*/
|
|
540
557
|
scrapeConfiguration: ScrapeConfiguration | undefined;
|
|
541
558
|
/**
|
|
542
559
|
* @public
|
|
543
|
-
* The
|
|
560
|
+
* <p>The Amazon EKS cluster from which the scraper will collect metrics.</p>
|
|
544
561
|
*/
|
|
545
562
|
source: Source | undefined;
|
|
546
563
|
/**
|
|
547
564
|
* @public
|
|
548
|
-
* The
|
|
565
|
+
* <p>The Amazon Managed Service for Prometheus workspace to send metrics to.</p>
|
|
549
566
|
*/
|
|
550
567
|
destination: Destination | undefined;
|
|
551
568
|
/**
|
|
552
569
|
* @public
|
|
553
|
-
* Optional
|
|
570
|
+
* <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the
|
|
571
|
+
* idempotency of the request.</p>
|
|
554
572
|
*/
|
|
555
573
|
clientToken?: string;
|
|
556
574
|
/**
|
|
557
575
|
* @public
|
|
558
|
-
* Optional
|
|
576
|
+
* <p>(Optional) The list of tag keys and values to associate with the scraper.</p>
|
|
559
577
|
*/
|
|
560
578
|
tags?: Record<string, string>;
|
|
561
579
|
}
|
|
@@ -591,256 +609,282 @@ export declare const ScraperStatusCode: {
|
|
|
591
609
|
export type ScraperStatusCode = (typeof ScraperStatusCode)[keyof typeof ScraperStatusCode];
|
|
592
610
|
/**
|
|
593
611
|
* @public
|
|
594
|
-
*
|
|
612
|
+
* <p>The <code>ScraperStatus</code> structure contains status information about the
|
|
613
|
+
* scraper.</p>
|
|
595
614
|
*/
|
|
596
615
|
export interface ScraperStatus {
|
|
597
616
|
/**
|
|
598
617
|
* @public
|
|
599
|
-
*
|
|
618
|
+
* <p>The current status of the scraper.</p>
|
|
600
619
|
*/
|
|
601
620
|
statusCode: ScraperStatusCode | undefined;
|
|
602
621
|
}
|
|
603
622
|
/**
|
|
604
623
|
* @public
|
|
605
|
-
* Represents the output of a CreateScraper operation
|
|
624
|
+
* <p>Represents the output of a <code>CreateScraper</code> operation.</p>
|
|
606
625
|
*/
|
|
607
626
|
export interface CreateScraperResponse {
|
|
608
627
|
/**
|
|
609
628
|
* @public
|
|
610
|
-
* The
|
|
629
|
+
* <p>The ID of the new scraper.</p>
|
|
611
630
|
*/
|
|
612
631
|
scraperId: string | undefined;
|
|
613
632
|
/**
|
|
614
633
|
* @public
|
|
615
|
-
* The ARN of the scraper
|
|
634
|
+
* <p>The Amazon Resource Name (ARN) of the new scraper.</p>
|
|
616
635
|
*/
|
|
617
636
|
arn: string | undefined;
|
|
618
637
|
/**
|
|
619
638
|
* @public
|
|
620
|
-
*
|
|
639
|
+
* <p>A structure that displays the current status of the scraper.</p>
|
|
621
640
|
*/
|
|
622
641
|
status: ScraperStatus | undefined;
|
|
623
642
|
/**
|
|
624
643
|
* @public
|
|
625
|
-
* The
|
|
644
|
+
* <p>The list of tag keys and values that are associated with the scraper.</p>
|
|
626
645
|
*/
|
|
627
646
|
tags?: Record<string, string>;
|
|
628
647
|
}
|
|
629
648
|
/**
|
|
630
649
|
* @public
|
|
631
|
-
* Represents the input of a DeleteScraper operation
|
|
650
|
+
* <p>Represents the input of a <code>DeleteScraper</code> operation.</p>
|
|
632
651
|
*/
|
|
633
652
|
export interface DeleteScraperRequest {
|
|
634
653
|
/**
|
|
635
654
|
* @public
|
|
636
|
-
* The ID of the scraper to delete
|
|
655
|
+
* <p>The ID of the scraper to delete.</p>
|
|
637
656
|
*/
|
|
638
657
|
scraperId: string | undefined;
|
|
639
658
|
/**
|
|
640
659
|
* @public
|
|
641
|
-
* Optional
|
|
660
|
+
* <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the
|
|
661
|
+
* idempotency of the request.</p>
|
|
642
662
|
*/
|
|
643
663
|
clientToken?: string;
|
|
644
664
|
}
|
|
645
665
|
/**
|
|
646
666
|
* @public
|
|
647
|
-
* Represents the output of a DeleteScraper operation
|
|
667
|
+
* <p>Represents the output of a <code>DeleteScraper</code> operation.</p>
|
|
648
668
|
*/
|
|
649
669
|
export interface DeleteScraperResponse {
|
|
650
670
|
/**
|
|
651
671
|
* @public
|
|
652
|
-
* The ID of the scraper
|
|
672
|
+
* <p>The ID of the scraper to delete.</p>
|
|
653
673
|
*/
|
|
654
674
|
scraperId: string | undefined;
|
|
655
675
|
/**
|
|
656
676
|
* @public
|
|
657
|
-
* The status of the scraper
|
|
677
|
+
* <p>The current status of the scraper.</p>
|
|
658
678
|
*/
|
|
659
679
|
status: ScraperStatus | undefined;
|
|
660
680
|
}
|
|
661
681
|
/**
|
|
662
682
|
* @public
|
|
663
|
-
* Represents the input of a DescribeScraper operation
|
|
683
|
+
* <p>Represents the input of a <code>DescribeScraper</code> operation.</p>
|
|
664
684
|
*/
|
|
665
685
|
export interface DescribeScraperRequest {
|
|
666
686
|
/**
|
|
667
687
|
* @public
|
|
668
|
-
* The
|
|
688
|
+
* <p>The ID of the scraper to describe.</p>
|
|
669
689
|
*/
|
|
670
690
|
scraperId: string | undefined;
|
|
671
691
|
}
|
|
672
692
|
/**
|
|
673
693
|
* @public
|
|
674
|
-
*
|
|
694
|
+
* <p>The <code>ScraperDescription</code> structure contains the full details about one
|
|
695
|
+
* scraper in your account.</p>
|
|
675
696
|
*/
|
|
676
697
|
export interface ScraperDescription {
|
|
677
698
|
/**
|
|
678
699
|
* @public
|
|
679
|
-
*
|
|
700
|
+
* <p>(Optional) A name associated with the scraper.</p>
|
|
680
701
|
*/
|
|
681
702
|
alias?: string;
|
|
682
703
|
/**
|
|
683
704
|
* @public
|
|
684
|
-
*
|
|
705
|
+
* <p>The ID of the scraper.</p>
|
|
685
706
|
*/
|
|
686
707
|
scraperId: string | undefined;
|
|
687
708
|
/**
|
|
688
709
|
* @public
|
|
689
|
-
* The Amazon Resource Name (ARN) of
|
|
710
|
+
* <p>The Amazon Resource Name (ARN) of the scraper.</p>
|
|
690
711
|
*/
|
|
691
712
|
arn: string | undefined;
|
|
692
713
|
/**
|
|
693
714
|
* @public
|
|
694
|
-
* The Amazon Resource Name (ARN) of the IAM role that provides
|
|
715
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that provides
|
|
716
|
+
* permissions for the scraper to discover and collect metrics on your behalf.</p>
|
|
695
717
|
*/
|
|
696
718
|
roleArn: string | undefined;
|
|
697
719
|
/**
|
|
698
720
|
* @public
|
|
699
|
-
*
|
|
721
|
+
* <p>A structure that contains the current status of the scraper.</p>
|
|
700
722
|
*/
|
|
701
723
|
status: ScraperStatus | undefined;
|
|
702
724
|
/**
|
|
703
725
|
* @public
|
|
704
|
-
* The time
|
|
726
|
+
* <p>The date and time that the scraper was created.</p>
|
|
705
727
|
*/
|
|
706
728
|
createdAt: Date | undefined;
|
|
707
729
|
/**
|
|
708
730
|
* @public
|
|
709
|
-
* The time
|
|
731
|
+
* <p>The date and time that the scraper was last modified.</p>
|
|
710
732
|
*/
|
|
711
733
|
lastModifiedAt: Date | undefined;
|
|
712
734
|
/**
|
|
713
735
|
* @public
|
|
714
|
-
* The
|
|
736
|
+
* <p>(Optional) The list of tag keys and values associated with the scraper.</p>
|
|
715
737
|
*/
|
|
716
738
|
tags?: Record<string, string>;
|
|
717
739
|
/**
|
|
718
740
|
* @public
|
|
719
|
-
*
|
|
741
|
+
* <p>If there is a failure, the reason for the failure.</p>
|
|
720
742
|
*/
|
|
721
743
|
statusReason?: string;
|
|
722
744
|
/**
|
|
723
745
|
* @public
|
|
724
|
-
* The configuration
|
|
746
|
+
* <p>The configuration file in use by the scraper.</p>
|
|
725
747
|
*/
|
|
726
748
|
scrapeConfiguration: ScrapeConfiguration | undefined;
|
|
727
749
|
/**
|
|
728
750
|
* @public
|
|
729
|
-
* The
|
|
751
|
+
* <p>The Amazon EKS cluster from which the scraper collects metrics.</p>
|
|
730
752
|
*/
|
|
731
753
|
source: Source | undefined;
|
|
732
754
|
/**
|
|
733
755
|
* @public
|
|
734
|
-
* The
|
|
756
|
+
* <p>The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.</p>
|
|
735
757
|
*/
|
|
736
758
|
destination: Destination | undefined;
|
|
737
759
|
}
|
|
738
760
|
/**
|
|
739
761
|
* @public
|
|
740
|
-
* Represents the output of a DescribeScraper operation
|
|
762
|
+
* <p>Represents the output of a <code>DescribeScraper</code> operation.</p>
|
|
741
763
|
*/
|
|
742
764
|
export interface DescribeScraperResponse {
|
|
743
765
|
/**
|
|
744
766
|
* @public
|
|
745
|
-
*
|
|
767
|
+
* <p>Contains details about the scraper.</p>
|
|
746
768
|
*/
|
|
747
769
|
scraper: ScraperDescription | undefined;
|
|
748
770
|
}
|
|
749
771
|
/**
|
|
750
772
|
* @public
|
|
751
|
-
* Represents the input of a ListScrapers operation
|
|
773
|
+
* <p>Represents the input of a <code>ListScrapers</code> operation.</p>
|
|
752
774
|
*/
|
|
753
775
|
export interface ListScrapersRequest {
|
|
754
776
|
/**
|
|
755
777
|
* @public
|
|
756
|
-
* A list of
|
|
778
|
+
* <p>(Optional) A list of key-value pairs to filter the list of scrapers returned.
|
|
779
|
+
* Keys include <code>status</code>, <code>sourceArn</code>,
|
|
780
|
+
* <code>destinationArn</code>, and <code>alias</code>.</p>
|
|
781
|
+
* <p>Filters on the same key are <code>OR</code>'d together, and filters on different
|
|
782
|
+
* keys are <code>AND</code>'d together. For example,
|
|
783
|
+
* <code>status=ACTIVE&status=CREATING&alias=Test</code>, will return all
|
|
784
|
+
* scrapers that have the alias Test, and are either in status ACTIVE or CREATING.</p>
|
|
785
|
+
* <p>To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus
|
|
786
|
+
* workspace, you would use the ARN of the workspace in a query:</p>
|
|
787
|
+
* <p>
|
|
788
|
+
* <code>status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012</code>
|
|
789
|
+
* </p>
|
|
790
|
+
* <p>If this is included, it filters the results to only the scrapers that match
|
|
791
|
+
* the filter.</p>
|
|
757
792
|
*/
|
|
758
793
|
filters?: Record<string, string[]>;
|
|
759
794
|
/**
|
|
760
795
|
* @public
|
|
761
|
-
*
|
|
796
|
+
* <p>(Optional) The token for the next set of
|
|
797
|
+
* items to return. (You received this token from a previous call.)</p>
|
|
762
798
|
*/
|
|
763
799
|
nextToken?: string;
|
|
764
800
|
/**
|
|
765
801
|
* @public
|
|
766
|
-
*
|
|
802
|
+
* <p>Optional) The maximum number of
|
|
803
|
+
* scrapers to return in one <code>ListScrapers</code> operation. The range is
|
|
804
|
+
* 1-1000.</p>
|
|
805
|
+
* <p>If you omit this parameter, the default of 100 is used.</p>
|
|
767
806
|
*/
|
|
768
807
|
maxResults?: number;
|
|
769
808
|
}
|
|
770
809
|
/**
|
|
771
810
|
* @public
|
|
772
|
-
*
|
|
811
|
+
* <p>The <code>ScraperSummary</code> structure contains a summary of the details about one
|
|
812
|
+
* scraper in your account.</p>
|
|
773
813
|
*/
|
|
774
814
|
export interface ScraperSummary {
|
|
775
815
|
/**
|
|
776
816
|
* @public
|
|
777
|
-
*
|
|
817
|
+
* <p>(Optional) A name associated with the scraper.</p>
|
|
778
818
|
*/
|
|
779
819
|
alias?: string;
|
|
780
820
|
/**
|
|
781
821
|
* @public
|
|
782
|
-
*
|
|
822
|
+
* <p>The ID of the scraper.</p>
|
|
783
823
|
*/
|
|
784
824
|
scraperId: string | undefined;
|
|
785
825
|
/**
|
|
786
826
|
* @public
|
|
787
|
-
* The Amazon Resource Name (ARN) of
|
|
827
|
+
* <p>The Amazon Resource Name (ARN) of the scraper.</p>
|
|
788
828
|
*/
|
|
789
829
|
arn: string | undefined;
|
|
790
830
|
/**
|
|
791
831
|
* @public
|
|
792
|
-
* The Amazon Resource Name (ARN) of the IAM role that provides
|
|
832
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that provides
|
|
833
|
+
* permissions for the scraper to discover and collect metrics on your behalf.</p>
|
|
793
834
|
*/
|
|
794
835
|
roleArn: string | undefined;
|
|
795
836
|
/**
|
|
796
837
|
* @public
|
|
797
|
-
*
|
|
838
|
+
* <p>A structure that contains the current status of the scraper.</p>
|
|
798
839
|
*/
|
|
799
840
|
status: ScraperStatus | undefined;
|
|
800
841
|
/**
|
|
801
842
|
* @public
|
|
802
|
-
* The time
|
|
843
|
+
* <p>The date and time that the scraper was created.</p>
|
|
803
844
|
*/
|
|
804
845
|
createdAt: Date | undefined;
|
|
805
846
|
/**
|
|
806
847
|
* @public
|
|
807
|
-
* The time
|
|
848
|
+
* <p>The date and time that the scraper was last modified.</p>
|
|
808
849
|
*/
|
|
809
850
|
lastModifiedAt: Date | undefined;
|
|
810
851
|
/**
|
|
811
852
|
* @public
|
|
812
|
-
* The
|
|
853
|
+
* <p>(Optional) The list of tag keys and values associated with the scraper.</p>
|
|
813
854
|
*/
|
|
814
855
|
tags?: Record<string, string>;
|
|
815
856
|
/**
|
|
816
857
|
* @public
|
|
817
|
-
*
|
|
858
|
+
* <p>If there is a failure, the reason for the failure.</p>
|
|
818
859
|
*/
|
|
819
860
|
statusReason?: string;
|
|
820
861
|
/**
|
|
821
862
|
* @public
|
|
822
|
-
* The
|
|
863
|
+
* <p>The Amazon EKS cluster from which the scraper collects metrics.</p>
|
|
823
864
|
*/
|
|
824
865
|
source: Source | undefined;
|
|
825
866
|
/**
|
|
826
867
|
* @public
|
|
827
|
-
* The
|
|
868
|
+
* <p>The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.</p>
|
|
828
869
|
*/
|
|
829
870
|
destination: Destination | undefined;
|
|
830
871
|
}
|
|
831
872
|
/**
|
|
832
873
|
* @public
|
|
833
|
-
* Represents the output of a ListScrapers operation
|
|
874
|
+
* <p>Represents the output of a <code>ListScrapers</code> operation.</p>
|
|
834
875
|
*/
|
|
835
876
|
export interface ListScrapersResponse {
|
|
836
877
|
/**
|
|
837
878
|
* @public
|
|
838
|
-
*
|
|
879
|
+
* <p>A list of <code>ScraperSummary</code> structures giving information about scrapers
|
|
880
|
+
* in the account that match the filters provided.</p>
|
|
839
881
|
*/
|
|
840
882
|
scrapers: ScraperSummary[] | undefined;
|
|
841
883
|
/**
|
|
842
884
|
* @public
|
|
843
|
-
*
|
|
885
|
+
* <p>A token indicating that there are more
|
|
886
|
+
* results to retrieve. You can use this token as part of your next
|
|
887
|
+
* <code>ListScrapers</code> operation to retrieve those results.</p>
|
|
844
888
|
*/
|
|
845
889
|
nextToken?: string;
|
|
846
890
|
}
|
|
@@ -850,12 +894,13 @@ export interface ListScrapersResponse {
|
|
|
850
894
|
export interface TagResourceRequest {
|
|
851
895
|
/**
|
|
852
896
|
* @public
|
|
853
|
-
* The ARN of the
|
|
897
|
+
* <p>The ARN of the workspace or rule groups namespace to apply tags to.</p>
|
|
854
898
|
*/
|
|
855
899
|
resourceArn: string | undefined;
|
|
856
900
|
/**
|
|
857
901
|
* @public
|
|
858
|
-
* The list of
|
|
902
|
+
* <p>The list of tag keys and values to associate with the resource.</p>
|
|
903
|
+
* <p>Keys may not begin with <code>aws:</code>.</p>
|
|
859
904
|
*/
|
|
860
905
|
tags: Record<string, string> | undefined;
|
|
861
906
|
}
|
|
@@ -870,12 +915,12 @@ export interface TagResourceResponse {
|
|
|
870
915
|
export interface UntagResourceRequest {
|
|
871
916
|
/**
|
|
872
917
|
* @public
|
|
873
|
-
* The ARN of the
|
|
918
|
+
* <p>The ARN of the workspace or rule groups namespace.</p>
|
|
874
919
|
*/
|
|
875
920
|
resourceArn: string | undefined;
|
|
876
921
|
/**
|
|
877
922
|
* @public
|
|
878
|
-
*
|
|
923
|
+
* <p>The keys of the tags to remove.</p>
|
|
879
924
|
*/
|
|
880
925
|
tagKeys: string[] | undefined;
|
|
881
926
|
}
|
|
@@ -886,27 +931,34 @@ export interface UntagResourceResponse {
|
|
|
886
931
|
}
|
|
887
932
|
/**
|
|
888
933
|
* @public
|
|
889
|
-
* Represents the input of a CreateWorkspace operation
|
|
934
|
+
* <p>Represents the input of a <code>CreateWorkspace</code> operation.</p>
|
|
890
935
|
*/
|
|
891
936
|
export interface CreateWorkspaceRequest {
|
|
892
937
|
/**
|
|
893
938
|
* @public
|
|
894
|
-
* An
|
|
939
|
+
* <p>An alias that you assign to this workspace to help you identify it. It does not need
|
|
940
|
+
* to be unique.</p>
|
|
941
|
+
* <p>Blank spaces at the beginning or end of the alias that you specify will be trimmed
|
|
942
|
+
* from the value used.</p>
|
|
895
943
|
*/
|
|
896
944
|
alias?: string;
|
|
897
945
|
/**
|
|
898
946
|
* @public
|
|
899
|
-
*
|
|
947
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
948
|
+
* Case-sensitive.</p>
|
|
900
949
|
*/
|
|
901
950
|
clientToken?: string;
|
|
902
951
|
/**
|
|
903
952
|
* @public
|
|
904
|
-
*
|
|
953
|
+
* <p>The list of tag keys and values to associate with the workspace.</p>
|
|
905
954
|
*/
|
|
906
955
|
tags?: Record<string, string>;
|
|
907
956
|
/**
|
|
908
957
|
* @public
|
|
909
|
-
*
|
|
958
|
+
* <p>(optional) The ARN for a customer managed KMS key to use for
|
|
959
|
+
* encrypting data within your workspace. For more information about using your
|
|
960
|
+
* own key in your workspace, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html">Encryption at rest</a> in the <i>Amazon Managed Service for Prometheus User
|
|
961
|
+
* Guide</i>.</p>
|
|
910
962
|
*/
|
|
911
963
|
kmsKeyArn?: string;
|
|
912
964
|
}
|
|
@@ -942,226 +994,246 @@ export declare const WorkspaceStatusCode: {
|
|
|
942
994
|
export type WorkspaceStatusCode = (typeof WorkspaceStatusCode)[keyof typeof WorkspaceStatusCode];
|
|
943
995
|
/**
|
|
944
996
|
* @public
|
|
945
|
-
*
|
|
997
|
+
* <p>The status of the workspace.</p>
|
|
946
998
|
*/
|
|
947
999
|
export interface WorkspaceStatus {
|
|
948
1000
|
/**
|
|
949
1001
|
* @public
|
|
950
|
-
*
|
|
1002
|
+
* <p>The current status of the workspace.</p>
|
|
951
1003
|
*/
|
|
952
1004
|
statusCode: WorkspaceStatusCode | undefined;
|
|
953
1005
|
}
|
|
954
1006
|
/**
|
|
955
1007
|
* @public
|
|
956
|
-
* Represents the output of a CreateWorkspace operation
|
|
1008
|
+
* <p>Represents the output of a <code>CreateWorkspace</code> operation.</p>
|
|
957
1009
|
*/
|
|
958
1010
|
export interface CreateWorkspaceResponse {
|
|
959
1011
|
/**
|
|
960
1012
|
* @public
|
|
961
|
-
* The
|
|
1013
|
+
* <p>The unique ID for the new workspace.</p>
|
|
962
1014
|
*/
|
|
963
1015
|
workspaceId: string | undefined;
|
|
964
1016
|
/**
|
|
965
1017
|
* @public
|
|
966
|
-
* The ARN
|
|
1018
|
+
* <p>The ARN for the new workspace.</p>
|
|
967
1019
|
*/
|
|
968
1020
|
arn: string | undefined;
|
|
969
1021
|
/**
|
|
970
1022
|
* @public
|
|
971
|
-
* The status of the workspace
|
|
1023
|
+
* <p>The current status of the new workspace. Immediately after you create the workspace,
|
|
1024
|
+
* the status is usually <code>CREATING</code>.</p>
|
|
972
1025
|
*/
|
|
973
1026
|
status: WorkspaceStatus | undefined;
|
|
974
1027
|
/**
|
|
975
1028
|
* @public
|
|
976
|
-
* The
|
|
1029
|
+
* <p>The list of tag keys and values that are associated with the workspace.</p>
|
|
977
1030
|
*/
|
|
978
1031
|
tags?: Record<string, string>;
|
|
979
1032
|
/**
|
|
980
1033
|
* @public
|
|
981
|
-
*
|
|
1034
|
+
* <p>(optional) If the workspace was created with a customer managed KMS
|
|
1035
|
+
* key, the ARN for the key used.</p>
|
|
982
1036
|
*/
|
|
983
1037
|
kmsKeyArn?: string;
|
|
984
1038
|
}
|
|
985
1039
|
/**
|
|
986
1040
|
* @public
|
|
987
|
-
* Represents the input of a DeleteWorkspace operation
|
|
1041
|
+
* <p>Represents the input of a <code>DeleteWorkspace</code> operation.</p>
|
|
988
1042
|
*/
|
|
989
1043
|
export interface DeleteWorkspaceRequest {
|
|
990
1044
|
/**
|
|
991
1045
|
* @public
|
|
992
|
-
* The ID of the workspace to delete
|
|
1046
|
+
* <p>The ID of the workspace to delete.</p>
|
|
993
1047
|
*/
|
|
994
1048
|
workspaceId: string | undefined;
|
|
995
1049
|
/**
|
|
996
1050
|
* @public
|
|
997
|
-
*
|
|
1051
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1052
|
+
* Case-sensitive.</p>
|
|
998
1053
|
*/
|
|
999
1054
|
clientToken?: string;
|
|
1000
1055
|
}
|
|
1001
1056
|
/**
|
|
1002
1057
|
* @public
|
|
1003
|
-
* Represents the input of a DescribeWorkspace operation
|
|
1058
|
+
* <p>Represents the input of a <code>DescribeWorkspace</code> operation.</p>
|
|
1004
1059
|
*/
|
|
1005
1060
|
export interface DescribeWorkspaceRequest {
|
|
1006
1061
|
/**
|
|
1007
1062
|
* @public
|
|
1008
|
-
* The ID of the workspace to describe
|
|
1063
|
+
* <p>The ID of the workspace to describe.</p>
|
|
1009
1064
|
*/
|
|
1010
1065
|
workspaceId: string | undefined;
|
|
1011
1066
|
}
|
|
1012
1067
|
/**
|
|
1013
1068
|
* @public
|
|
1014
|
-
*
|
|
1069
|
+
* <p>The full details about one Amazon Managed Service for Prometheus workspace in your account.</p>
|
|
1015
1070
|
*/
|
|
1016
1071
|
export interface WorkspaceDescription {
|
|
1017
1072
|
/**
|
|
1018
1073
|
* @public
|
|
1019
|
-
*
|
|
1074
|
+
* <p>The unique ID for the workspace.</p>
|
|
1020
1075
|
*/
|
|
1021
1076
|
workspaceId: string | undefined;
|
|
1022
1077
|
/**
|
|
1023
1078
|
* @public
|
|
1024
|
-
*
|
|
1079
|
+
* <p>The alias that is assigned to this workspace to help identify it. It may not be
|
|
1080
|
+
* unique.</p>
|
|
1025
1081
|
*/
|
|
1026
1082
|
alias?: string;
|
|
1027
1083
|
/**
|
|
1028
1084
|
* @public
|
|
1029
|
-
* The
|
|
1085
|
+
* <p>The ARN of the workspace.</p>
|
|
1030
1086
|
*/
|
|
1031
1087
|
arn: string | undefined;
|
|
1032
1088
|
/**
|
|
1033
1089
|
* @public
|
|
1034
|
-
* The status of
|
|
1090
|
+
* <p>The current status of the workspace.</p>
|
|
1035
1091
|
*/
|
|
1036
1092
|
status: WorkspaceStatus | undefined;
|
|
1037
1093
|
/**
|
|
1038
1094
|
* @public
|
|
1039
|
-
* Prometheus endpoint
|
|
1095
|
+
* <p>The Prometheus endpoint available for this workspace. </p>
|
|
1040
1096
|
*/
|
|
1041
1097
|
prometheusEndpoint?: string;
|
|
1042
1098
|
/**
|
|
1043
1099
|
* @public
|
|
1044
|
-
* The time
|
|
1100
|
+
* <p>The date and time that the workspace was created.</p>
|
|
1045
1101
|
*/
|
|
1046
1102
|
createdAt: Date | undefined;
|
|
1047
1103
|
/**
|
|
1048
1104
|
* @public
|
|
1049
|
-
* The
|
|
1105
|
+
* <p>The list of tag keys and values that are associated with the workspace.</p>
|
|
1050
1106
|
*/
|
|
1051
1107
|
tags?: Record<string, string>;
|
|
1052
1108
|
/**
|
|
1053
1109
|
* @public
|
|
1054
|
-
*
|
|
1110
|
+
* <p>(optional) If the workspace was created with a customer managed KMS
|
|
1111
|
+
* key, the ARN for the key used.</p>
|
|
1055
1112
|
*/
|
|
1056
1113
|
kmsKeyArn?: string;
|
|
1057
1114
|
}
|
|
1058
1115
|
/**
|
|
1059
1116
|
* @public
|
|
1060
|
-
* Represents the output of a DescribeWorkspace operation
|
|
1117
|
+
* <p>Represents the output of a <code>DescribeWorkspace</code> operation.</p>
|
|
1061
1118
|
*/
|
|
1062
1119
|
export interface DescribeWorkspaceResponse {
|
|
1063
1120
|
/**
|
|
1064
1121
|
* @public
|
|
1065
|
-
*
|
|
1122
|
+
* <p>A structure that contains details about the workspace.</p>
|
|
1066
1123
|
*/
|
|
1067
1124
|
workspace: WorkspaceDescription | undefined;
|
|
1068
1125
|
}
|
|
1069
1126
|
/**
|
|
1070
1127
|
* @public
|
|
1071
|
-
* Represents the input of a ListWorkspaces operation
|
|
1128
|
+
* <p>Represents the input of a <code>ListWorkspaces</code> operation.</p>
|
|
1072
1129
|
*/
|
|
1073
1130
|
export interface ListWorkspacesRequest {
|
|
1074
1131
|
/**
|
|
1075
1132
|
* @public
|
|
1076
|
-
*
|
|
1133
|
+
* <p>The token for the next set of items to return. You receive this token from a previous
|
|
1134
|
+
* call, and use it to get the next page of results. The other parameters must be the same
|
|
1135
|
+
* as the initial call.</p>
|
|
1136
|
+
* <p>For example, if your initial request has <code>maxResults</code> of 10, and there are
|
|
1137
|
+
* 12 workspaces to return, then your initial request will return 10 and a
|
|
1138
|
+
* <code>nextToken</code>. Using the next token in a subsequent call will return the
|
|
1139
|
+
* remaining 2 workspaces.</p>
|
|
1077
1140
|
*/
|
|
1078
1141
|
nextToken?: string;
|
|
1079
1142
|
/**
|
|
1080
1143
|
* @public
|
|
1081
|
-
*
|
|
1144
|
+
* <p>If this is included, it filters the results to only the workspaces with names that
|
|
1145
|
+
* start with the value that you specify here.</p>
|
|
1146
|
+
* <p>Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning
|
|
1147
|
+
* and end of the alias that you specify.</p>
|
|
1082
1148
|
*/
|
|
1083
1149
|
alias?: string;
|
|
1084
1150
|
/**
|
|
1085
1151
|
* @public
|
|
1086
|
-
*
|
|
1152
|
+
* <p>The maximum number of workspaces to return per request. The default is 100.</p>
|
|
1087
1153
|
*/
|
|
1088
1154
|
maxResults?: number;
|
|
1089
1155
|
}
|
|
1090
1156
|
/**
|
|
1091
1157
|
* @public
|
|
1092
|
-
*
|
|
1158
|
+
* <p>The information about one Amazon Managed Service for Prometheus workspace in your account. </p>
|
|
1093
1159
|
*/
|
|
1094
1160
|
export interface WorkspaceSummary {
|
|
1095
1161
|
/**
|
|
1096
1162
|
* @public
|
|
1097
|
-
*
|
|
1163
|
+
* <p>The unique ID for the workspace.</p>
|
|
1098
1164
|
*/
|
|
1099
1165
|
workspaceId: string | undefined;
|
|
1100
1166
|
/**
|
|
1101
1167
|
* @public
|
|
1102
|
-
*
|
|
1168
|
+
* <p>The alias that is assigned to this workspace to help identify it. It may not be
|
|
1169
|
+
* unique.</p>
|
|
1103
1170
|
*/
|
|
1104
1171
|
alias?: string;
|
|
1105
1172
|
/**
|
|
1106
1173
|
* @public
|
|
1107
|
-
* The
|
|
1174
|
+
* <p>The ARN of the workspace.</p>
|
|
1108
1175
|
*/
|
|
1109
1176
|
arn: string | undefined;
|
|
1110
1177
|
/**
|
|
1111
1178
|
* @public
|
|
1112
|
-
* The status of
|
|
1179
|
+
* <p>The current status of the workspace.</p>
|
|
1113
1180
|
*/
|
|
1114
1181
|
status: WorkspaceStatus | undefined;
|
|
1115
1182
|
/**
|
|
1116
1183
|
* @public
|
|
1117
|
-
* The time
|
|
1184
|
+
* <p>The date and time that the workspace was created.</p>
|
|
1118
1185
|
*/
|
|
1119
1186
|
createdAt: Date | undefined;
|
|
1120
1187
|
/**
|
|
1121
1188
|
* @public
|
|
1122
|
-
* The
|
|
1189
|
+
* <p>The list of tag keys and values that are associated with the workspace.</p>
|
|
1123
1190
|
*/
|
|
1124
1191
|
tags?: Record<string, string>;
|
|
1125
1192
|
/**
|
|
1126
1193
|
* @public
|
|
1127
|
-
*
|
|
1194
|
+
* <p>(optional) If the workspace was created with a customer managed KMS
|
|
1195
|
+
* key, the ARN for the key used.</p>
|
|
1128
1196
|
*/
|
|
1129
1197
|
kmsKeyArn?: string;
|
|
1130
1198
|
}
|
|
1131
1199
|
/**
|
|
1132
1200
|
* @public
|
|
1133
|
-
* Represents the output of a ListWorkspaces operation
|
|
1201
|
+
* <p>Represents the output of a <code>ListWorkspaces</code> operation.</p>
|
|
1134
1202
|
*/
|
|
1135
1203
|
export interface ListWorkspacesResponse {
|
|
1136
1204
|
/**
|
|
1137
1205
|
* @public
|
|
1138
|
-
*
|
|
1206
|
+
* <p>An array of <code>WorkspaceSummary</code> structures containing information about the
|
|
1207
|
+
* workspaces requested.</p>
|
|
1139
1208
|
*/
|
|
1140
1209
|
workspaces: WorkspaceSummary[] | undefined;
|
|
1141
1210
|
/**
|
|
1142
1211
|
* @public
|
|
1143
|
-
*
|
|
1212
|
+
* <p>A token indicating that there are more results to retrieve. You can use this token as
|
|
1213
|
+
* part of your next <code>ListWorkspaces</code> request to retrieve those results.</p>
|
|
1144
1214
|
*/
|
|
1145
1215
|
nextToken?: string;
|
|
1146
1216
|
}
|
|
1147
1217
|
/**
|
|
1148
1218
|
* @public
|
|
1149
|
-
* Represents the input of a CreateLoggingConfiguration operation
|
|
1219
|
+
* <p>Represents the input of a <code>CreateLoggingConfiguration</code> operation.</p>
|
|
1150
1220
|
*/
|
|
1151
1221
|
export interface CreateLoggingConfigurationRequest {
|
|
1152
1222
|
/**
|
|
1153
1223
|
* @public
|
|
1154
|
-
* The ID of the workspace to
|
|
1224
|
+
* <p>The ID of the workspace to create the logging configuration for.</p>
|
|
1155
1225
|
*/
|
|
1156
1226
|
workspaceId: string | undefined;
|
|
1157
1227
|
/**
|
|
1158
1228
|
* @public
|
|
1159
|
-
* The ARN of the
|
|
1229
|
+
* <p>The ARN of the CloudWatch log group to which the vended log data will be
|
|
1230
|
+
* published. This log group must exist prior to calling this API.</p>
|
|
1160
1231
|
*/
|
|
1161
1232
|
logGroupArn: string | undefined;
|
|
1162
1233
|
/**
|
|
1163
1234
|
* @public
|
|
1164
|
-
*
|
|
1235
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1236
|
+
* Case-sensitive.</p>
|
|
1165
1237
|
*/
|
|
1166
1238
|
clientToken?: string;
|
|
1167
1239
|
}
|
|
@@ -1201,160 +1273,167 @@ export declare const LoggingConfigurationStatusCode: {
|
|
|
1201
1273
|
export type LoggingConfigurationStatusCode = (typeof LoggingConfigurationStatusCode)[keyof typeof LoggingConfigurationStatusCode];
|
|
1202
1274
|
/**
|
|
1203
1275
|
* @public
|
|
1204
|
-
*
|
|
1276
|
+
* <p>The status of the logging configuration. </p>
|
|
1205
1277
|
*/
|
|
1206
1278
|
export interface LoggingConfigurationStatus {
|
|
1207
1279
|
/**
|
|
1208
1280
|
* @public
|
|
1209
|
-
*
|
|
1281
|
+
* <p>The current status of the logging configuration.</p>
|
|
1210
1282
|
*/
|
|
1211
1283
|
statusCode: LoggingConfigurationStatusCode | undefined;
|
|
1212
1284
|
/**
|
|
1213
1285
|
* @public
|
|
1214
|
-
*
|
|
1286
|
+
* <p>If failed, the reason for the failure.</p>
|
|
1215
1287
|
*/
|
|
1216
1288
|
statusReason?: string;
|
|
1217
1289
|
}
|
|
1218
1290
|
/**
|
|
1219
1291
|
* @public
|
|
1220
|
-
* Represents the output of a CreateLoggingConfiguration operation
|
|
1292
|
+
* <p>Represents the output of a <code>CreateLoggingConfiguration</code> operation.</p>
|
|
1221
1293
|
*/
|
|
1222
1294
|
export interface CreateLoggingConfigurationResponse {
|
|
1223
1295
|
/**
|
|
1224
1296
|
* @public
|
|
1225
|
-
*
|
|
1297
|
+
* <p>A structure that displays the current status of the logging configuration.</p>
|
|
1226
1298
|
*/
|
|
1227
1299
|
status: LoggingConfigurationStatus | undefined;
|
|
1228
1300
|
}
|
|
1229
1301
|
/**
|
|
1230
1302
|
* @public
|
|
1231
|
-
* Represents the input of a DeleteLoggingConfiguration operation
|
|
1303
|
+
* <p>Represents the input of a <code>DeleteLoggingConfiguration</code> operation.</p>
|
|
1232
1304
|
*/
|
|
1233
1305
|
export interface DeleteLoggingConfigurationRequest {
|
|
1234
1306
|
/**
|
|
1235
1307
|
* @public
|
|
1236
|
-
* The ID of the workspace
|
|
1308
|
+
* <p>The ID of the workspace containing the logging configuration to delete.</p>
|
|
1237
1309
|
*/
|
|
1238
1310
|
workspaceId: string | undefined;
|
|
1239
1311
|
/**
|
|
1240
1312
|
* @public
|
|
1241
|
-
*
|
|
1313
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1314
|
+
* Case-sensitive.</p>
|
|
1242
1315
|
*/
|
|
1243
1316
|
clientToken?: string;
|
|
1244
1317
|
}
|
|
1245
1318
|
/**
|
|
1246
1319
|
* @public
|
|
1247
|
-
* Represents the input of a DescribeLoggingConfiguration operation
|
|
1320
|
+
* <p>Represents the input of a <code>DescribeLoggingConfiguration</code> operation.</p>
|
|
1248
1321
|
*/
|
|
1249
1322
|
export interface DescribeLoggingConfigurationRequest {
|
|
1250
1323
|
/**
|
|
1251
1324
|
* @public
|
|
1252
|
-
* The ID of the workspace to
|
|
1325
|
+
* <p>The ID of the workspace to describe the logging configuration for.</p>
|
|
1253
1326
|
*/
|
|
1254
1327
|
workspaceId: string | undefined;
|
|
1255
1328
|
}
|
|
1256
1329
|
/**
|
|
1257
1330
|
* @public
|
|
1258
|
-
*
|
|
1331
|
+
* <p>Contains information about the logging configuration. </p>
|
|
1259
1332
|
*/
|
|
1260
1333
|
export interface LoggingConfigurationMetadata {
|
|
1261
1334
|
/**
|
|
1262
1335
|
* @public
|
|
1263
|
-
* The status of the logging configuration
|
|
1336
|
+
* <p>The current status of the logging configuration.</p>
|
|
1264
1337
|
*/
|
|
1265
1338
|
status: LoggingConfigurationStatus | undefined;
|
|
1266
1339
|
/**
|
|
1267
1340
|
* @public
|
|
1268
|
-
* The
|
|
1341
|
+
* <p>The ID of the workspace the logging configuration is for.</p>
|
|
1269
1342
|
*/
|
|
1270
1343
|
workspace: string | undefined;
|
|
1271
1344
|
/**
|
|
1272
1345
|
* @public
|
|
1273
|
-
* The ARN of the
|
|
1346
|
+
* <p>The ARN of the CloudWatch log group to which the vended log data will be
|
|
1347
|
+
* published.</p>
|
|
1274
1348
|
*/
|
|
1275
1349
|
logGroupArn: string | undefined;
|
|
1276
1350
|
/**
|
|
1277
1351
|
* @public
|
|
1278
|
-
* The time
|
|
1352
|
+
* <p>The date and time that the logging configuration was created.</p>
|
|
1279
1353
|
*/
|
|
1280
1354
|
createdAt: Date | undefined;
|
|
1281
1355
|
/**
|
|
1282
1356
|
* @public
|
|
1283
|
-
* The time
|
|
1357
|
+
* <p>The date and time that the logging configuration was most recently changed.</p>
|
|
1284
1358
|
*/
|
|
1285
1359
|
modifiedAt: Date | undefined;
|
|
1286
1360
|
}
|
|
1287
1361
|
/**
|
|
1288
1362
|
* @public
|
|
1289
|
-
* Represents the output of a DescribeLoggingConfiguration operation
|
|
1363
|
+
* <p>Represents the output of a <code>DescribeLoggingConfiguration</code> operation.</p>
|
|
1290
1364
|
*/
|
|
1291
1365
|
export interface DescribeLoggingConfigurationResponse {
|
|
1292
1366
|
/**
|
|
1293
1367
|
* @public
|
|
1294
|
-
*
|
|
1368
|
+
* <p>A structure that displays the information about the logging configuration.</p>
|
|
1295
1369
|
*/
|
|
1296
1370
|
loggingConfiguration: LoggingConfigurationMetadata | undefined;
|
|
1297
1371
|
}
|
|
1298
1372
|
/**
|
|
1299
1373
|
* @public
|
|
1300
|
-
* Represents the input of an UpdateLoggingConfiguration operation
|
|
1374
|
+
* <p>Represents the input of an <code>UpdateLoggingConfiguration</code> operation.</p>
|
|
1301
1375
|
*/
|
|
1302
1376
|
export interface UpdateLoggingConfigurationRequest {
|
|
1303
1377
|
/**
|
|
1304
1378
|
* @public
|
|
1305
|
-
* The ID of the workspace to
|
|
1379
|
+
* <p>The ID of the workspace to update the logging configuration for.</p>
|
|
1306
1380
|
*/
|
|
1307
1381
|
workspaceId: string | undefined;
|
|
1308
1382
|
/**
|
|
1309
1383
|
* @public
|
|
1310
|
-
* The ARN of the
|
|
1384
|
+
* <p>The ARN of the CloudWatch log group to which the vended log data will be
|
|
1385
|
+
* published.</p>
|
|
1311
1386
|
*/
|
|
1312
1387
|
logGroupArn: string | undefined;
|
|
1313
1388
|
/**
|
|
1314
1389
|
* @public
|
|
1315
|
-
*
|
|
1390
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1391
|
+
* Case-sensitive.</p>
|
|
1316
1392
|
*/
|
|
1317
1393
|
clientToken?: string;
|
|
1318
1394
|
}
|
|
1319
1395
|
/**
|
|
1320
1396
|
* @public
|
|
1321
|
-
* Represents the output of an UpdateLoggingConfiguration operation
|
|
1397
|
+
* <p>Represents the output of an <code>UpdateLoggingConfiguration</code> operation.</p>
|
|
1322
1398
|
*/
|
|
1323
1399
|
export interface UpdateLoggingConfigurationResponse {
|
|
1324
1400
|
/**
|
|
1325
1401
|
* @public
|
|
1326
|
-
*
|
|
1402
|
+
* <p>A structure that contains the current status of the logging configuration.</p>
|
|
1327
1403
|
*/
|
|
1328
1404
|
status: LoggingConfigurationStatus | undefined;
|
|
1329
1405
|
}
|
|
1330
1406
|
/**
|
|
1331
1407
|
* @public
|
|
1332
|
-
* Represents the input of a CreateRuleGroupsNamespace operation
|
|
1408
|
+
* <p>Represents the input of a <code>CreateRuleGroupsNamespace</code> operation.</p>
|
|
1333
1409
|
*/
|
|
1334
1410
|
export interface CreateRuleGroupsNamespaceRequest {
|
|
1335
1411
|
/**
|
|
1336
1412
|
* @public
|
|
1337
|
-
* The ID of the workspace
|
|
1413
|
+
* <p>The ID of the workspace to add the rule groups namespace.</p>
|
|
1338
1414
|
*/
|
|
1339
1415
|
workspaceId: string | undefined;
|
|
1340
1416
|
/**
|
|
1341
1417
|
* @public
|
|
1342
|
-
* The rule groups namespace
|
|
1418
|
+
* <p>The name for the new rule groups namespace.</p>
|
|
1343
1419
|
*/
|
|
1344
1420
|
name: string | undefined;
|
|
1345
1421
|
/**
|
|
1346
1422
|
* @public
|
|
1347
|
-
* The
|
|
1423
|
+
* <p>The rules file to use in the new namespace.</p>
|
|
1424
|
+
* <p>Contains the base64-encoded version of the YAML rules file.</p>
|
|
1425
|
+
* <p>For details about the rule groups namespace structure, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html">RuleGroupsNamespaceData</a>.</p>
|
|
1348
1426
|
*/
|
|
1349
1427
|
data: Uint8Array | undefined;
|
|
1350
1428
|
/**
|
|
1351
1429
|
* @public
|
|
1352
|
-
*
|
|
1430
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1431
|
+
* Case-sensitive.</p>
|
|
1353
1432
|
*/
|
|
1354
1433
|
clientToken?: string;
|
|
1355
1434
|
/**
|
|
1356
1435
|
* @public
|
|
1357
|
-
*
|
|
1436
|
+
* <p>The list of tag keys and values to associate with the rule groups namespace.</p>
|
|
1358
1437
|
*/
|
|
1359
1438
|
tags?: Record<string, string>;
|
|
1360
1439
|
}
|
|
@@ -1394,283 +1473,304 @@ export declare const RuleGroupsNamespaceStatusCode: {
|
|
|
1394
1473
|
export type RuleGroupsNamespaceStatusCode = (typeof RuleGroupsNamespaceStatusCode)[keyof typeof RuleGroupsNamespaceStatusCode];
|
|
1395
1474
|
/**
|
|
1396
1475
|
* @public
|
|
1397
|
-
*
|
|
1476
|
+
* <p>The status information about a rule groups namespace. </p>
|
|
1398
1477
|
*/
|
|
1399
1478
|
export interface RuleGroupsNamespaceStatus {
|
|
1400
1479
|
/**
|
|
1401
1480
|
* @public
|
|
1402
|
-
*
|
|
1481
|
+
* <p>The current status of the namespace.</p>
|
|
1403
1482
|
*/
|
|
1404
1483
|
statusCode: RuleGroupsNamespaceStatusCode | undefined;
|
|
1405
1484
|
/**
|
|
1406
1485
|
* @public
|
|
1407
|
-
* The reason for failure if any
|
|
1486
|
+
* <p>The reason for the failure, if any.</p>
|
|
1408
1487
|
*/
|
|
1409
1488
|
statusReason?: string;
|
|
1410
1489
|
}
|
|
1411
1490
|
/**
|
|
1412
1491
|
* @public
|
|
1413
|
-
* Represents the output of a CreateRuleGroupsNamespace operation
|
|
1492
|
+
* <p>Represents the output of a <code>CreateRuleGroupsNamespace</code> operation.</p>
|
|
1414
1493
|
*/
|
|
1415
1494
|
export interface CreateRuleGroupsNamespaceResponse {
|
|
1416
1495
|
/**
|
|
1417
1496
|
* @public
|
|
1418
|
-
* The rule groups namespace
|
|
1497
|
+
* <p>The name of the new rule groups namespace.</p>
|
|
1419
1498
|
*/
|
|
1420
1499
|
name: string | undefined;
|
|
1421
1500
|
/**
|
|
1422
1501
|
* @public
|
|
1423
|
-
* The Amazon Resource Name (ARN) of
|
|
1502
|
+
* <p>The Amazon Resource Name (ARN) of the new rule groups namespace.</p>
|
|
1424
1503
|
*/
|
|
1425
1504
|
arn: string | undefined;
|
|
1426
1505
|
/**
|
|
1427
1506
|
* @public
|
|
1428
|
-
*
|
|
1507
|
+
* <p>A structure that returns the current status of the rule groups namespace.</p>
|
|
1429
1508
|
*/
|
|
1430
1509
|
status: RuleGroupsNamespaceStatus | undefined;
|
|
1431
1510
|
/**
|
|
1432
1511
|
* @public
|
|
1433
|
-
* The
|
|
1512
|
+
* <p>The list of tag keys and values that are associated with the namespace.</p>
|
|
1434
1513
|
*/
|
|
1435
1514
|
tags?: Record<string, string>;
|
|
1436
1515
|
}
|
|
1437
1516
|
/**
|
|
1438
1517
|
* @public
|
|
1439
|
-
* Represents the input of a DeleteRuleGroupsNamespace operation
|
|
1518
|
+
* <p>Represents the input of a <code>DeleteRuleGroupsNamespace</code> operation.</p>
|
|
1440
1519
|
*/
|
|
1441
1520
|
export interface DeleteRuleGroupsNamespaceRequest {
|
|
1442
1521
|
/**
|
|
1443
1522
|
* @public
|
|
1444
|
-
* The ID of the workspace
|
|
1523
|
+
* <p>The ID of the workspace containing the rule groups namespace and definition to
|
|
1524
|
+
* delete.</p>
|
|
1445
1525
|
*/
|
|
1446
1526
|
workspaceId: string | undefined;
|
|
1447
1527
|
/**
|
|
1448
1528
|
* @public
|
|
1449
|
-
* The rule groups namespace
|
|
1529
|
+
* <p>The name of the rule groups namespace to delete.</p>
|
|
1450
1530
|
*/
|
|
1451
1531
|
name: string | undefined;
|
|
1452
1532
|
/**
|
|
1453
1533
|
* @public
|
|
1454
|
-
*
|
|
1534
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1535
|
+
* Case-sensitive.</p>
|
|
1455
1536
|
*/
|
|
1456
1537
|
clientToken?: string;
|
|
1457
1538
|
}
|
|
1458
1539
|
/**
|
|
1459
1540
|
* @public
|
|
1460
|
-
* Represents the input of a DescribeRuleGroupsNamespace operation
|
|
1541
|
+
* <p>Represents the input of a <code>DescribeRuleGroupsNamespace</code> operation.</p>
|
|
1461
1542
|
*/
|
|
1462
1543
|
export interface DescribeRuleGroupsNamespaceRequest {
|
|
1463
1544
|
/**
|
|
1464
1545
|
* @public
|
|
1465
|
-
* The ID of the workspace
|
|
1546
|
+
* <p>The ID of the workspace containing the rule groups namespace.</p>
|
|
1466
1547
|
*/
|
|
1467
1548
|
workspaceId: string | undefined;
|
|
1468
1549
|
/**
|
|
1469
1550
|
* @public
|
|
1470
|
-
* The rule groups namespace
|
|
1551
|
+
* <p>The name of the rule groups namespace that you want information for.</p>
|
|
1471
1552
|
*/
|
|
1472
1553
|
name: string | undefined;
|
|
1473
1554
|
}
|
|
1474
1555
|
/**
|
|
1475
1556
|
* @public
|
|
1476
|
-
*
|
|
1557
|
+
* <p>The details about one rule groups namespace. </p>
|
|
1477
1558
|
*/
|
|
1478
1559
|
export interface RuleGroupsNamespaceDescription {
|
|
1479
1560
|
/**
|
|
1480
1561
|
* @public
|
|
1481
|
-
* The
|
|
1562
|
+
* <p>The ARN of the rule groups namespace.</p>
|
|
1482
1563
|
*/
|
|
1483
1564
|
arn: string | undefined;
|
|
1484
1565
|
/**
|
|
1485
1566
|
* @public
|
|
1486
|
-
* The rule groups namespace
|
|
1567
|
+
* <p>The name of the rule groups namespace.</p>
|
|
1487
1568
|
*/
|
|
1488
1569
|
name: string | undefined;
|
|
1489
1570
|
/**
|
|
1490
1571
|
* @public
|
|
1491
|
-
* The status of rule groups namespace
|
|
1572
|
+
* <p>The current status of the rule groups namespace.</p>
|
|
1492
1573
|
*/
|
|
1493
1574
|
status: RuleGroupsNamespaceStatus | undefined;
|
|
1494
1575
|
/**
|
|
1495
1576
|
* @public
|
|
1496
|
-
* The rule groups namespace
|
|
1577
|
+
* <p>The rule groups file used in the namespace.</p>
|
|
1578
|
+
* <p>For details about the rule groups namespace structure, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html">RuleGroupsNamespaceData</a>.</p>
|
|
1497
1579
|
*/
|
|
1498
1580
|
data: Uint8Array | undefined;
|
|
1499
1581
|
/**
|
|
1500
1582
|
* @public
|
|
1501
|
-
* The time
|
|
1583
|
+
* <p>The date and time that the rule groups namespace was created.</p>
|
|
1502
1584
|
*/
|
|
1503
1585
|
createdAt: Date | undefined;
|
|
1504
1586
|
/**
|
|
1505
1587
|
* @public
|
|
1506
|
-
* The time
|
|
1588
|
+
* <p>The date and time that the rule groups namespace was most recently changed.</p>
|
|
1507
1589
|
*/
|
|
1508
1590
|
modifiedAt: Date | undefined;
|
|
1509
1591
|
/**
|
|
1510
1592
|
* @public
|
|
1511
|
-
* The
|
|
1593
|
+
* <p>The list of tag keys and values that are associated with the rule groups
|
|
1594
|
+
* namespace.</p>
|
|
1512
1595
|
*/
|
|
1513
1596
|
tags?: Record<string, string>;
|
|
1514
1597
|
}
|
|
1515
1598
|
/**
|
|
1516
1599
|
* @public
|
|
1517
|
-
* Represents the output of a DescribeRuleGroupsNamespace operation
|
|
1600
|
+
* <p>Represents the output of a <code>DescribeRuleGroupsNamespace</code> operation.</p>
|
|
1518
1601
|
*/
|
|
1519
1602
|
export interface DescribeRuleGroupsNamespaceResponse {
|
|
1520
1603
|
/**
|
|
1521
1604
|
* @public
|
|
1522
|
-
* The
|
|
1605
|
+
* <p>The information about the rule groups namespace.</p>
|
|
1523
1606
|
*/
|
|
1524
1607
|
ruleGroupsNamespace: RuleGroupsNamespaceDescription | undefined;
|
|
1525
1608
|
}
|
|
1526
1609
|
/**
|
|
1527
1610
|
* @public
|
|
1528
|
-
* Represents the input of a ListRuleGroupsNamespaces operation
|
|
1611
|
+
* <p>Represents the input of a <code>ListRuleGroupsNamespaces</code> operation.</p>
|
|
1529
1612
|
*/
|
|
1530
1613
|
export interface ListRuleGroupsNamespacesRequest {
|
|
1531
1614
|
/**
|
|
1532
1615
|
* @public
|
|
1533
|
-
* The ID of the workspace
|
|
1616
|
+
* <p>The ID of the workspace containing the rule groups namespaces.</p>
|
|
1534
1617
|
*/
|
|
1535
1618
|
workspaceId: string | undefined;
|
|
1536
1619
|
/**
|
|
1537
1620
|
* @public
|
|
1538
|
-
*
|
|
1621
|
+
* <p>Use this parameter to filter the rule groups namespaces that are returned. Only the
|
|
1622
|
+
* namespaces with names that begin with the value that you specify are returned.</p>
|
|
1539
1623
|
*/
|
|
1540
1624
|
name?: string;
|
|
1541
1625
|
/**
|
|
1542
1626
|
* @public
|
|
1543
|
-
*
|
|
1627
|
+
* <p>The token for the next set of items to return. You receive this token from a previous
|
|
1628
|
+
* call, and use it to get the next page of results. The other parameters must be the same
|
|
1629
|
+
* as the initial call.</p>
|
|
1630
|
+
* <p>For example, if your initial request has <code>maxResults</code> of 10, and there are
|
|
1631
|
+
* 12 rule groups namespaces to return, then your initial request will return 10 and a
|
|
1632
|
+
* <code>nextToken</code>. Using the next token in a subsequent call will return the
|
|
1633
|
+
* remaining 2 namespaces.</p>
|
|
1544
1634
|
*/
|
|
1545
1635
|
nextToken?: string;
|
|
1546
1636
|
/**
|
|
1547
1637
|
* @public
|
|
1548
|
-
*
|
|
1638
|
+
* <p>The maximum number of results to return. The default is 100.</p>
|
|
1549
1639
|
*/
|
|
1550
1640
|
maxResults?: number;
|
|
1551
1641
|
}
|
|
1552
1642
|
/**
|
|
1553
1643
|
* @public
|
|
1554
|
-
*
|
|
1644
|
+
* <p>The high-level information about a rule groups namespace. To retrieve more
|
|
1645
|
+
* information, use <code>DescribeRuleGroupsNamespace</code>.</p>
|
|
1555
1646
|
*/
|
|
1556
1647
|
export interface RuleGroupsNamespaceSummary {
|
|
1557
1648
|
/**
|
|
1558
1649
|
* @public
|
|
1559
|
-
* The
|
|
1650
|
+
* <p>The ARN of the rule groups namespace.</p>
|
|
1560
1651
|
*/
|
|
1561
1652
|
arn: string | undefined;
|
|
1562
1653
|
/**
|
|
1563
1654
|
* @public
|
|
1564
|
-
* The rule groups namespace
|
|
1655
|
+
* <p>The name of the rule groups namespace.</p>
|
|
1565
1656
|
*/
|
|
1566
1657
|
name: string | undefined;
|
|
1567
1658
|
/**
|
|
1568
1659
|
* @public
|
|
1569
|
-
*
|
|
1660
|
+
* <p>A structure that displays the current status of the rule groups namespace.</p>
|
|
1570
1661
|
*/
|
|
1571
1662
|
status: RuleGroupsNamespaceStatus | undefined;
|
|
1572
1663
|
/**
|
|
1573
1664
|
* @public
|
|
1574
|
-
* The time
|
|
1665
|
+
* <p>The date and time that the rule groups namespace was created.</p>
|
|
1575
1666
|
*/
|
|
1576
1667
|
createdAt: Date | undefined;
|
|
1577
1668
|
/**
|
|
1578
1669
|
* @public
|
|
1579
|
-
* The time
|
|
1670
|
+
* <p>The date and time that the rule groups namespace was most recently changed.</p>
|
|
1580
1671
|
*/
|
|
1581
1672
|
modifiedAt: Date | undefined;
|
|
1582
1673
|
/**
|
|
1583
1674
|
* @public
|
|
1584
|
-
* The
|
|
1675
|
+
* <p>The list of tag keys and values that are associated with the rule groups
|
|
1676
|
+
* namespace.</p>
|
|
1585
1677
|
*/
|
|
1586
1678
|
tags?: Record<string, string>;
|
|
1587
1679
|
}
|
|
1588
1680
|
/**
|
|
1589
1681
|
* @public
|
|
1590
|
-
* Represents the output of a ListRuleGroupsNamespaces operation
|
|
1682
|
+
* <p>Represents the output of a <code>ListRuleGroupsNamespaces</code> operation.</p>
|
|
1591
1683
|
*/
|
|
1592
1684
|
export interface ListRuleGroupsNamespacesResponse {
|
|
1593
1685
|
/**
|
|
1594
1686
|
* @public
|
|
1595
|
-
* The list of
|
|
1687
|
+
* <p>The returned list of rule groups namespaces.</p>
|
|
1596
1688
|
*/
|
|
1597
1689
|
ruleGroupsNamespaces: RuleGroupsNamespaceSummary[] | undefined;
|
|
1598
1690
|
/**
|
|
1599
1691
|
* @public
|
|
1600
|
-
*
|
|
1692
|
+
* <p>A token indicating that there are more results to retrieve. You can use this token as
|
|
1693
|
+
* part of your next <code>ListRuleGroupsNamespaces</code> request to retrieve those
|
|
1694
|
+
* results.</p>
|
|
1601
1695
|
*/
|
|
1602
1696
|
nextToken?: string;
|
|
1603
1697
|
}
|
|
1604
1698
|
/**
|
|
1605
1699
|
* @public
|
|
1606
|
-
* Represents the input of a PutRuleGroupsNamespace operation
|
|
1700
|
+
* <p>Represents the input of a <code>PutRuleGroupsNamespace</code> operation.</p>
|
|
1607
1701
|
*/
|
|
1608
1702
|
export interface PutRuleGroupsNamespaceRequest {
|
|
1609
1703
|
/**
|
|
1610
1704
|
* @public
|
|
1611
|
-
* The ID of the workspace
|
|
1705
|
+
* <p>The ID of the workspace where you are updating the rule groups namespace.</p>
|
|
1612
1706
|
*/
|
|
1613
1707
|
workspaceId: string | undefined;
|
|
1614
1708
|
/**
|
|
1615
1709
|
* @public
|
|
1616
|
-
* The rule groups namespace
|
|
1710
|
+
* <p>The name of the rule groups namespace that you are updating.</p>
|
|
1617
1711
|
*/
|
|
1618
1712
|
name: string | undefined;
|
|
1619
1713
|
/**
|
|
1620
1714
|
* @public
|
|
1621
|
-
* The namespace
|
|
1715
|
+
* <p>The new rules file to use in the namespace. A base64-encoded version of the YAML rule
|
|
1716
|
+
* groups file.</p>
|
|
1717
|
+
* <p>For details about the rule groups namespace structure, see <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html">RuleGroupsNamespaceData</a>.</p>
|
|
1622
1718
|
*/
|
|
1623
1719
|
data: Uint8Array | undefined;
|
|
1624
1720
|
/**
|
|
1625
1721
|
* @public
|
|
1626
|
-
*
|
|
1722
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1723
|
+
* Case-sensitive.</p>
|
|
1627
1724
|
*/
|
|
1628
1725
|
clientToken?: string;
|
|
1629
1726
|
}
|
|
1630
1727
|
/**
|
|
1631
1728
|
* @public
|
|
1632
|
-
* Represents the output of a PutRuleGroupsNamespace operation
|
|
1729
|
+
* <p>Represents the output of a <code>PutRuleGroupsNamespace</code> operation.</p>
|
|
1633
1730
|
*/
|
|
1634
1731
|
export interface PutRuleGroupsNamespaceResponse {
|
|
1635
1732
|
/**
|
|
1636
1733
|
* @public
|
|
1637
|
-
* The rule groups namespace
|
|
1734
|
+
* <p>The name of the rule groups namespace that was updated.</p>
|
|
1638
1735
|
*/
|
|
1639
1736
|
name: string | undefined;
|
|
1640
1737
|
/**
|
|
1641
1738
|
* @public
|
|
1642
|
-
* The
|
|
1739
|
+
* <p>The ARN of the rule groups namespace.</p>
|
|
1643
1740
|
*/
|
|
1644
1741
|
arn: string | undefined;
|
|
1645
1742
|
/**
|
|
1646
1743
|
* @public
|
|
1647
|
-
*
|
|
1744
|
+
* <p>A structure that includes the current status of the rule groups namespace.</p>
|
|
1648
1745
|
*/
|
|
1649
1746
|
status: RuleGroupsNamespaceStatus | undefined;
|
|
1650
1747
|
/**
|
|
1651
1748
|
* @public
|
|
1652
|
-
* The
|
|
1749
|
+
* <p>The list of tag keys and values that are associated with the namespace.</p>
|
|
1653
1750
|
*/
|
|
1654
1751
|
tags?: Record<string, string>;
|
|
1655
1752
|
}
|
|
1656
1753
|
/**
|
|
1657
1754
|
* @public
|
|
1658
|
-
* Represents the input of an UpdateWorkspaceAlias operation
|
|
1755
|
+
* <p>Represents the input of an <code>UpdateWorkspaceAlias</code> operation.</p>
|
|
1659
1756
|
*/
|
|
1660
1757
|
export interface UpdateWorkspaceAliasRequest {
|
|
1661
1758
|
/**
|
|
1662
1759
|
* @public
|
|
1663
|
-
* The ID of the workspace
|
|
1760
|
+
* <p>The ID of the workspace to update.</p>
|
|
1664
1761
|
*/
|
|
1665
1762
|
workspaceId: string | undefined;
|
|
1666
1763
|
/**
|
|
1667
1764
|
* @public
|
|
1668
|
-
* The new alias
|
|
1765
|
+
* <p>The new alias for the workspace. It does not need to be unique.</p>
|
|
1766
|
+
* <p>Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning
|
|
1767
|
+
* and end of the alias that you specify.</p>
|
|
1669
1768
|
*/
|
|
1670
1769
|
alias?: string;
|
|
1671
1770
|
/**
|
|
1672
1771
|
* @public
|
|
1673
|
-
*
|
|
1772
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1773
|
+
* Case-sensitive.</p>
|
|
1674
1774
|
*/
|
|
1675
1775
|
clientToken?: string;
|
|
1676
1776
|
}
|