Debian Codegraph @

models/apis/amp/2020-08-01/docs-2.json

raw
1 {
2 "version": "2.0",
3 "service": "<p>Amazon Managed Service for Prometheus</p>",
4 "operations": {
5 "CreateAlertManagerDefinition": "<p>Create an alert manager definition.</p>",
6 "CreateLoggingConfiguration": "<p>Create logging configuration.</p>",
7 "CreateRuleGroupsNamespace": "<p>Create a rule group namespace.</p>",
8 "CreateScraper": "<p>Create a scraper.</p>",
9 "CreateWorkspace": "<p>Creates a new AMP workspace.</p>",
10 "DeleteAlertManagerDefinition": "<p>Deletes an alert manager definition.</p>",
11 "DeleteLoggingConfiguration": "<p>Delete logging configuration.</p>",
12 "DeleteRuleGroupsNamespace": "<p>Delete a rule groups namespace.</p>",
13 "DeleteScraper": "<p>Deletes a scraper.</p>",
14 "DeleteWorkspace": "<p>Deletes an AMP workspace.</p>",
15 "DescribeAlertManagerDefinition": "<p>Describes an alert manager definition.</p>",
16 "DescribeLoggingConfiguration": "<p>Describes logging configuration.</p>",
17 "DescribeRuleGroupsNamespace": "<p>Describe a rule groups namespace.</p>",
18 "DescribeScraper": "<p>Describe an existing scraper.</p>",
19 "DescribeWorkspace": "<p>Describes an existing AMP workspace.</p>",
20 "GetDefaultScraperConfiguration": "<p>Gets a default configuration.</p>",
21 "ListRuleGroupsNamespaces": "<p>Lists rule groups namespaces.</p>",
22 "ListScrapers": "<p>Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results.</p>",
23 "ListTagsForResource": "<p>Lists the tags you have assigned to the resource.</p>",
24 "ListWorkspaces": "<p>Lists all AMP workspaces, including workspaces being created or deleted.</p>",
25 "PutAlertManagerDefinition": "<p>Update an alert manager definition.</p>",
26 "PutRuleGroupsNamespace": "<p>Update a rule groups namespace.</p>",
27 "TagResource": "<p>Creates tags for the specified resource.</p>",
28 "UntagResource": "<p>Deletes tags from the specified resource.</p>",
29 "UpdateLoggingConfiguration": "<p>Update logging configuration.</p>",
30 "UpdateWorkspaceAlias": "<p>Updates an AMP workspace alias.</p>"
31 },
32 "shapes": {
33 "AccessDeniedException": {
34 "base": "<p>User does not have sufficient access to perform this action.</p>",
35 "refs": {
36 }
37 },
38 "AlertManagerDefinitionData": {
39 "base": "<p>The alert manager definition data.</p>",
40 "refs": {
41 "AlertManagerDefinitionDescription$data": "<p>The alert manager definition.</p>",
42 "CreateAlertManagerDefinitionRequest$data": "<p>The alert manager definition data.</p>",
43 "PutAlertManagerDefinitionRequest$data": "<p>The alert manager definition data.</p>"
44 }
45 },
46 "AlertManagerDefinitionDescription": {
47 "base": "<p>Represents the properties of an alert manager definition.</p>",
48 "refs": {
49 "DescribeAlertManagerDefinitionResponse$alertManagerDefinition": "<p>The properties of the selected workspace's alert manager definition.</p>"
50 }
51 },
52 "AlertManagerDefinitionStatus": {
53 "base": "<p>Represents the status of a definition.</p>",
54 "refs": {
55 "AlertManagerDefinitionDescription$status": "<p>The status of alert manager definition.</p>",
56 "CreateAlertManagerDefinitionResponse$status": "<p>The status of alert manager definition.</p>",
57 "PutAlertManagerDefinitionResponse$status": "<p>The status of alert manager definition.</p>"
58 }
59 },
60 "AlertManagerDefinitionStatusCode": {
61 "base": "<p>State of an alert manager definition.</p>",
62 "refs": {
63 "AlertManagerDefinitionStatus$statusCode": "<p>Status code of this definition.</p>"
64 }
65 },
66 "AmpConfiguration": {
67 "base": "<p>A representation of an AMP destination.</p>",
68 "refs": {
69 "Destination$ampConfiguration": "<p>A representation of an AMP destination.</p>"
70 }
71 },
72 "Blob": {
73 "base": null,
74 "refs": {
75 "GetDefaultScraperConfigurationResponse$configuration": "<p>The default configuration.</p>",
76 "ScrapeConfiguration$configurationBlob": "<p>Binary data representing a Prometheus configuration file.</p>"
77 }
78 },
79 "ClusterArn": {
80 "base": "<p>The ARN of an EKS cluster.</p>",
81 "refs": {
82 "EksConfiguration$clusterArn": "<p>The ARN of an EKS cluster.</p>"
83 }
84 },
85 "ConflictException": {
86 "base": "<p>Updating or deleting a resource can cause an inconsistent state.</p>",
87 "refs": {
88 }
89 },
90 "CreateAlertManagerDefinitionRequest": {
91 "base": "<p>Represents the input of a CreateAlertManagerDefinition operation.</p>",
92 "refs": {
93 }
94 },
95 "CreateAlertManagerDefinitionResponse": {
96 "base": "<p>Represents the output of a CreateAlertManagerDefinition operation.</p>",
97 "refs": {
98 }
99 },
100 "CreateLoggingConfigurationRequest": {
101 "base": "<p>Represents the input of a CreateLoggingConfiguration operation.</p>",
102 "refs": {
103 }
104 },
105 "CreateLoggingConfigurationResponse": {
106 "base": "<p>Represents the output of a CreateLoggingConfiguration operation.</p>",
107 "refs": {
108 }
109 },
110 "CreateRuleGroupsNamespaceRequest": {
111 "base": "<p>Represents the input of a CreateRuleGroupsNamespace operation.</p>",
112 "refs": {
113 }
114 },
115 "CreateRuleGroupsNamespaceResponse": {
116 "base": "<p>Represents the output of a CreateRuleGroupsNamespace operation.</p>",
117 "refs": {
118 }
119 },
120 "CreateScraperRequest": {
121 "base": "<p>Represents the input of a CreateScraper operation.</p>",
122 "refs": {
123 }
124 },
125 "CreateScraperResponse": {
126 "base": "<p>Represents the output of a CreateScraper operation.</p>",
127 "refs": {
128 }
129 },
130 "CreateWorkspaceRequest": {
131 "base": "<p>Represents the input of a CreateWorkspace operation.</p>",
132 "refs": {
133 }
134 },
135 "CreateWorkspaceResponse": {
136 "base": "<p>Represents the output of a CreateWorkspace operation.</p>",
137 "refs": {
138 }
139 },
140 "DeleteAlertManagerDefinitionRequest": {
141 "base": "<p>Represents the input of a DeleteAlertManagerDefinition operation.</p>",
142 "refs": {
143 }
144 },
145 "DeleteLoggingConfigurationRequest": {
146 "base": "<p>Represents the input of a DeleteLoggingConfiguration operation.</p>",
147 "refs": {
148 }
149 },
150 "DeleteRuleGroupsNamespaceRequest": {
151 "base": "<p>Represents the input of a DeleteRuleGroupsNamespace operation.</p>",
152 "refs": {
153 }
154 },
155 "DeleteScraperRequest": {
156 "base": "<p>Represents the input of a DeleteScraper operation.</p>",
157 "refs": {
158 }
159 },
160 "DeleteScraperResponse": {
161 "base": "<p>Represents the output of a DeleteScraper operation.</p>",
162 "refs": {
163 }
164 },
165 "DeleteWorkspaceRequest": {
166 "base": "<p>Represents the input of a DeleteWorkspace operation.</p>",
167 "refs": {
168 }
169 },
170 "DescribeAlertManagerDefinitionRequest": {
171 "base": "<p>Represents the input of a DescribeAlertManagerDefinition operation.</p>",
172 "refs": {
173 }
174 },
175 "DescribeAlertManagerDefinitionResponse": {
176 "base": "<p>Represents the output of a DescribeAlertManagerDefinition operation.</p>",
177 "refs": {
178 }
179 },
180 "DescribeLoggingConfigurationRequest": {
181 "base": "<p>Represents the input of a DescribeLoggingConfiguration operation.</p>",
182 "refs": {
183 }
184 },
185 "DescribeLoggingConfigurationResponse": {
186 "base": "<p>Represents the output of a DescribeLoggingConfiguration operation.</p>",
187 "refs": {
188 }
189 },
190 "DescribeRuleGroupsNamespaceRequest": {
191 "base": "<p>Represents the input of a DescribeRuleGroupsNamespace operation.</p>",
192 "refs": {
193 }
194 },
195 "DescribeRuleGroupsNamespaceResponse": {
196 "base": "<p>Represents the output of a DescribeRuleGroupsNamespace operation.</p>",
197 "refs": {
198 }
199 },
200 "DescribeScraperRequest": {
201 "base": "<p>Represents the input of a DescribeScraper operation.</p>",
202 "refs": {
203 }
204 },
205 "DescribeScraperResponse": {
206 "base": "<p>Represents the output of a DescribeScraper operation.</p>",
207 "refs": {
208 }
209 },
210 "DescribeWorkspaceRequest": {
211 "base": "<p>Represents the input of a DescribeWorkspace operation.</p>",
212 "refs": {
213 }
214 },
215 "DescribeWorkspaceResponse": {
216 "base": "<p>Represents the output of a DescribeWorkspace operation.</p>",
217 "refs": {
218 }
219 },
220 "Destination": {
221 "base": "<p>A representation of a destination that a scraper can produce metrics to.</p>",
222 "refs": {
223 "CreateScraperRequest$destination": "<p>The destination that the scraper will be producing metrics to.</p>",
224 "ScraperDescription$destination": "<p>The destination that the scraper is producing metrics to.</p>",
225 "ScraperSummary$destination": "<p>The destination that the scraper is producing metrics to.</p>"
226 }
227 },
228 "EksConfiguration": {
229 "base": "<p>A representation of an EKS source.</p>",
230 "refs": {
231 "Source$eksConfiguration": "<p>A representation of an EKS source.</p>"
232 }
233 },
234 "FilterKey": {
235 "base": "<p>The name of the key to filter by.</p>",
236 "refs": {
237 "ScraperFilters$key": "<p>The name of the key to filter by. Currently supported filter keys are 'status', 'sourceArn', 'destinationArn', and 'alias'.</p>"
238 }
239 },
240 "FilterValue": {
241 "base": "<p>The value of a given key to filter by.</p>",
242 "refs": {
243 "FilterValues$member": null
244 }
245 },
246 "FilterValues": {
247 "base": "<p>A list of scraper filter values.</p>",
248 "refs": {
249 "ScraperFilters$value": "<p>The values of the given key to filter by.</p>"
250 }
251 },
252 "GetDefaultScraperConfigurationRequest": {
253 "base": "<p>Represents the input of a GetDefaultScraperConfiguration operation.</p>",
254 "refs": {
255 }
256 },
257 "GetDefaultScraperConfigurationResponse": {
258 "base": "<p>Represents the output of a GetDefaultScraperConfiguration operation.</p>",
259 "refs": {
260 }
261 },
262 "IamRoleArn": {
263 "base": "<p>An ARN identifying an IAM role used by the scraper.</p>",
264 "refs": {
265 "ScraperDescription$roleArn": "<p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.</p>",
266 "ScraperSummary$roleArn": "<p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.</p>"
267 }
268 },
269 "IdempotencyToken": {
270 "base": "<p>An identifier used to ensure the idempotency of a write request.</p>",
271 "refs": {
272 "CreateAlertManagerDefinitionRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
273 "CreateLoggingConfigurationRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
274 "CreateRuleGroupsNamespaceRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
275 "CreateScraperRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
276 "CreateWorkspaceRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
277 "DeleteAlertManagerDefinitionRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
278 "DeleteLoggingConfigurationRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
279 "DeleteRuleGroupsNamespaceRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
280 "DeleteScraperRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
281 "DeleteWorkspaceRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
282 "PutAlertManagerDefinitionRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
283 "PutRuleGroupsNamespaceRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
284 "UpdateLoggingConfigurationRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>",
285 "UpdateWorkspaceAliasRequest$clientToken": "<p>Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.</p>"
286 }
287 },
288 "Integer": {
289 "base": null,
290 "refs": {
291 "InternalServerException$retryAfterSeconds": "<p>Advice to clients on when the call can be safely retried.</p>",
292 "ThrottlingException$retryAfterSeconds": "<p>Advice to clients on when the call can be safely retried.</p>"
293 }
294 },
295 "InternalServerException": {
296 "base": "<p>Unexpected error during processing of request.</p>",
297 "refs": {
298 }
299 },
300 "ListRuleGroupsNamespacesRequest": {
301 "base": "<p>Represents the input of a ListRuleGroupsNamespaces operation.</p>",
302 "refs": {
303 }
304 },
305 "ListRuleGroupsNamespacesRequestMaxResultsInteger": {
306 "base": null,
307 "refs": {
308 "ListRuleGroupsNamespacesRequest$maxResults": "<p>Maximum results to return in response (default=100, maximum=1000).</p>"
309 }
310 },
311 "ListRuleGroupsNamespacesResponse": {
312 "base": "<p>Represents the output of a ListRuleGroupsNamespaces operation.</p>",
313 "refs": {
314 }
315 },
316 "ListScrapersRequest": {
317 "base": "<p>Represents the input of a ListScrapers operation.</p>",
318 "refs": {
319 }
320 },
321 "ListScrapersRequestMaxResultsInteger": {
322 "base": null,
323 "refs": {
324 "ListScrapersRequest$maxResults": "<p>Maximum results to return in response (default=100, maximum=1000).</p>"
325 }
326 },
327 "ListScrapersResponse": {
328 "base": "<p>Represents the output of a ListScrapers operation.</p>",
329 "refs": {
330 }
331 },
332 "ListTagsForResourceRequest": {
333 "base": null,
334 "refs": {
335 }
336 },
337 "ListTagsForResourceResponse": {
338 "base": null,
339 "refs": {
340 }
341 },
342 "ListWorkspacesRequest": {
343 "base": "<p>Represents the input of a ListWorkspaces operation.</p>",
344 "refs": {
345 }
346 },
347 "ListWorkspacesRequestMaxResultsInteger": {
348 "base": null,
349 "refs": {
350 "ListWorkspacesRequest$maxResults": "<p>Maximum results to return in response (default=100, maximum=1000).</p>"
351 }
352 },
353 "ListWorkspacesResponse": {
354 "base": "<p>Represents the output of a ListWorkspaces operation.</p>",
355 "refs": {
356 }
357 },
358 "LogGroupArn": {
359 "base": null,
360 "refs": {
361 "CreateLoggingConfigurationRequest$logGroupArn": "<p>The ARN of the CW log group to which the vended log data will be published.</p>",
362 "LoggingConfigurationMetadata$logGroupArn": "<p>The ARN of the CW log group to which the vended log data will be published.</p>",
363 "UpdateLoggingConfigurationRequest$logGroupArn": "<p>The ARN of the CW log group to which the vended log data will be published.</p>"
364 }
365 },
366 "LoggingConfigurationMetadata": {
367 "base": "<p>Represents the properties of a logging configuration metadata.</p>",
368 "refs": {
369 "DescribeLoggingConfigurationResponse$loggingConfiguration": "<p>Metadata object containing information about the logging configuration of a workspace.</p>"
370 }
371 },
372 "LoggingConfigurationStatus": {
373 "base": "<p>Represents the status of a logging configuration.</p>",
374 "refs": {
375 "CreateLoggingConfigurationResponse$status": "<p>The status of the logging configuration.</p>",
376 "LoggingConfigurationMetadata$status": "<p>The status of the logging configuration.</p>",
377 "UpdateLoggingConfigurationResponse$status": "<p>The status of the logging configuration.</p>"
378 }
379 },
380 "LoggingConfigurationStatusCode": {
381 "base": "<p>State of a logging configuration.</p>",
382 "refs": {
383 "LoggingConfigurationStatus$statusCode": "<p>Status code of the logging configuration.</p>"
384 }
385 },
386 "PaginationToken": {
387 "base": "<p>A token used to access the next page in a paginated result set.</p>",
388 "refs": {
389 "ListRuleGroupsNamespacesRequest$nextToken": "<p>Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.</p>",
390 "ListRuleGroupsNamespacesResponse$nextToken": "<p>Pagination token to use when requesting the next page in this list.</p>",
391 "ListScrapersRequest$nextToken": "<p>Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.</p>",
392 "ListScrapersResponse$nextToken": "<p>Pagination token to use when requesting the next page in this list.</p>",
393 "ListWorkspacesRequest$nextToken": "<p>Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.</p>",
394 "ListWorkspacesResponse$nextToken": "<p>Pagination token to use when requesting the next page in this list.</p>"
395 }
396 },
397 "PutAlertManagerDefinitionRequest": {
398 "base": "<p>Represents the input of a PutAlertManagerDefinition operation.</p>",
399 "refs": {
400 }
401 },
402 "PutAlertManagerDefinitionResponse": {
403 "base": "<p>Represents the output of a PutAlertManagerDefinition operation.</p>",
404 "refs": {
405 }
406 },
407 "PutRuleGroupsNamespaceRequest": {
408 "base": "<p>Represents the input of a PutRuleGroupsNamespace operation.</p>",
409 "refs": {
410 }
411 },
412 "PutRuleGroupsNamespaceResponse": {
413 "base": "<p>Represents the output of a PutRuleGroupsNamespace operation.</p>",
414 "refs": {
415 }
416 },
417 "ResourceNotFoundException": {
418 "base": "<p>Request references a resource which does not exist.</p>",
419 "refs": {
420 }
421 },
422 "RuleGroupsNamespaceArn": {
423 "base": "<p>An ARN identifying a rule groups namespace.</p>",
424 "refs": {
425 "CreateRuleGroupsNamespaceResponse$arn": "<p>The Amazon Resource Name (ARN) of this rule groups namespace.</p>",
426 "PutRuleGroupsNamespaceResponse$arn": "<p>The Amazon Resource Name (ARN) of this rule groups namespace.</p>",
427 "RuleGroupsNamespaceDescription$arn": "<p>The Amazon Resource Name (ARN) of this rule groups namespace.</p>",
428 "RuleGroupsNamespaceSummary$arn": "<p>The Amazon Resource Name (ARN) of this rule groups namespace.</p>"
429 }
430 },
431 "RuleGroupsNamespaceData": {
432 "base": "<p>The rule groups namespace data.</p>",
433 "refs": {
434 "CreateRuleGroupsNamespaceRequest$data": "<p>The namespace data that define the rule groups.</p>",
435 "PutRuleGroupsNamespaceRequest$data": "<p>The namespace data that define the rule groups.</p>",
436 "RuleGroupsNamespaceDescription$data": "<p>The rule groups namespace data.</p>"
437 }
438 },
439 "RuleGroupsNamespaceDescription": {
440 "base": "<p>Represents a description of the rule groups namespace.</p>",
441 "refs": {
442 "DescribeRuleGroupsNamespaceResponse$ruleGroupsNamespace": "<p>The selected rule groups namespace.</p>"
443 }
444 },
445 "RuleGroupsNamespaceName": {
446 "base": "<p>The namespace name that the rule group belong to.</p>",
447 "refs": {
448 "CreateRuleGroupsNamespaceRequest$name": "<p>The rule groups namespace name.</p>",
449 "CreateRuleGroupsNamespaceResponse$name": "<p>The rule groups namespace name.</p>",
450 "DeleteRuleGroupsNamespaceRequest$name": "<p>The rule groups namespace name.</p>",
451 "DescribeRuleGroupsNamespaceRequest$name": "<p>The rule groups namespace.</p>",
452 "ListRuleGroupsNamespacesRequest$name": "<p>Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.</p>",
453 "PutRuleGroupsNamespaceRequest$name": "<p>The rule groups namespace name.</p>",
454 "PutRuleGroupsNamespaceResponse$name": "<p>The rule groups namespace name.</p>",
455 "RuleGroupsNamespaceDescription$name": "<p>The rule groups namespace name.</p>",
456 "RuleGroupsNamespaceSummary$name": "<p>The rule groups namespace name.</p>"
457 }
458 },
459 "RuleGroupsNamespaceStatus": {
460 "base": "<p>Represents the status of a namespace.</p>",
461 "refs": {
462 "CreateRuleGroupsNamespaceResponse$status": "<p>The status of rule groups namespace.</p>",
463 "PutRuleGroupsNamespaceResponse$status": "<p>The status of rule groups namespace.</p>",
464 "RuleGroupsNamespaceDescription$status": "<p>The status of rule groups namespace.</p>",
465 "RuleGroupsNamespaceSummary$status": "<p>The status of rule groups namespace.</p>"
466 }
467 },
468 "RuleGroupsNamespaceStatusCode": {
469 "base": "<p>State of a namespace.</p>",
470 "refs": {
471 "RuleGroupsNamespaceStatus$statusCode": "<p>Status code of this namespace.</p>"
472 }
473 },
474 "RuleGroupsNamespaceSummary": {
475 "base": "<p>Represents a summary of the rule groups namespace.</p>",
476 "refs": {
477 "RuleGroupsNamespaceSummaryList$member": null
478 }
479 },
480 "RuleGroupsNamespaceSummaryList": {
481 "base": "<p>A list of rule groups namespace summary.</p>",
482 "refs": {
483 "ListRuleGroupsNamespacesResponse$ruleGroupsNamespaces": "<p>The list of the selected rule groups namespaces.</p>"
484 }
485 },
486 "ScrapeConfiguration": {
487 "base": "<p>A representation of a Prometheus configuration file.</p>",
488 "refs": {
489 "CreateScraperRequest$scrapeConfiguration": "<p>The configuration used to create the scraper.</p>",
490 "ScraperDescription$scrapeConfiguration": "<p>The configuration used to create the scraper.</p>"
491 }
492 },
493 "ScraperAlias": {
494 "base": "<p>A user-assigned scraper alias.</p>",
495 "refs": {
496 "CreateScraperRequest$alias": "<p>An optional user-assigned alias for this scraper. This alias is for user reference and does not need to be unique.</p>",
497 "ScraperDescription$alias": "<p>Alias of this scraper.</p>",
498 "ScraperSummary$alias": "<p>Alias of this scraper.</p>"
499 }
500 },
501 "ScraperArn": {
502 "base": "<p>An ARN identifying a scrape configuration.</p>",
503 "refs": {
504 "CreateScraperResponse$arn": "<p>The ARN of the scraper that was just created.</p>",
505 "ScraperDescription$arn": "<p>The Amazon Resource Name (ARN) of this scraper.</p>",
506 "ScraperSummary$arn": "<p>The Amazon Resource Name (ARN) of this scraper.</p>"
507 }
508 },
509 "ScraperDescription": {
510 "base": "<p>Represents the properties of a scraper.</p>",
511 "refs": {
512 "DescribeScraperResponse$scraper": "<p>The properties of the selected scrapers.</p>"
513 }
514 },
515 "ScraperFilters": {
516 "base": "<p>A list of scraper filters.</p>",
517 "refs": {
518 "ListScrapersRequest$filters": "<p>A list of scraper filters.</p>"
519 }
520 },
521 "ScraperId": {
522 "base": "<p>A scraper ID.</p>",
523 "refs": {
524 "CreateScraperResponse$scraperId": "<p>The generated ID of the scraper that was just created.</p>",
525 "DeleteScraperRequest$scraperId": "<p>The ID of the scraper to delete.</p>",
526 "DeleteScraperResponse$scraperId": "<p>The ID of the scraper that was deleted.</p>",
527 "DescribeScraperRequest$scraperId": "<p>The IDs of the scraper to describe.</p>",
528 "ScraperDescription$scraperId": "<p>Unique string identifying this scraper.</p>",
529 "ScraperSummary$scraperId": "<p>Unique string identifying this scraper.</p>"
530 }
531 },
532 "ScraperStatus": {
533 "base": "<p>Represents the status of a scraper.</p>",
534 "refs": {
535 "CreateScraperResponse$status": "<p>The status of the scraper that was just created (usually CREATING).</p>",
536 "DeleteScraperResponse$status": "<p>The status of the scraper that is being deleted.</p>",
537 "ScraperDescription$status": "<p>The status of this scraper.</p>",
538 "ScraperSummary$status": "<p>The status of this scraper.</p>"
539 }
540 },
541 "ScraperStatusCode": {
542 "base": "<p>State of a scraper.</p>",
543 "refs": {
544 "ScraperStatus$statusCode": "<p>Status code of this scraper.</p>"
545 }
546 },
547 "ScraperSummary": {
548 "base": "<p>Represents a summary of the properties of a scraper.</p>",
549 "refs": {
550 "ScraperSummaryList$member": null
551 }
552 },
553 "ScraperSummaryList": {
554 "base": "<p>A list of scraper summaries.</p>",
555 "refs": {
556 "ListScrapersResponse$scrapers": "<p>The list of scrapers, filtered down if a set of filters was provided in the request.</p>"
557 }
558 },
559 "SecurityGroupId": {
560 "base": "<p>ID of a VPC security group.</p>",
561 "refs": {
562 "SecurityGroupIds$member": null
563 }
564 },
565 "SecurityGroupIds": {
566 "base": "<p>A list of security group IDs specified for VPC configuration.</p>",
567 "refs": {
568 "EksConfiguration$securityGroupIds": "<p>A list of security group IDs specified for VPC configuration.</p>"
569 }
570 },
571 "ServiceQuotaExceededException": {
572 "base": "<p>Request would cause a service quota to be exceeded.</p>",
573 "refs": {
574 }
575 },
576 "Source": {
577 "base": "<p>A representation of a source that a scraper can discover and collect metrics from.</p>",
578 "refs": {
579 "CreateScraperRequest$source": "<p>The source that the scraper will be discovering and collecting metrics from.</p>",
580 "ScraperDescription$source": "<p>The source that the scraper is discovering and collecting metrics from.</p>",
581 "ScraperSummary$source": "<p>The source that the scraper is discovering and collecting metrics from.</p>"
582 }
583 },
584 "StatusReason": {
585 "base": "<p>The reason for failure if any.</p>",
586 "refs": {
587 "ScraperDescription$statusReason": "<p>The reason for failure if any.</p>",
588 "ScraperSummary$statusReason": "<p>The reason for failure if any.</p>"
589 }
590 },
591 "String": {
592 "base": null,
593 "refs": {
594 "AccessDeniedException$message": "<p>Description of the error.</p>",
595 "AlertManagerDefinitionStatus$statusReason": "<p>The reason for failure if any.</p>",
596 "ConflictException$message": "<p>Description of the error.</p>",
597 "ConflictException$resourceId": "<p>Identifier of the resource affected.</p>",
598 "ConflictException$resourceType": "<p>Type of the resource affected.</p>",
599 "InternalServerException$message": "<p>Description of the error.</p>",
600 "ListTagsForResourceRequest$resourceArn": "<p>The ARN of the resource.</p>",
601 "LoggingConfigurationStatus$statusReason": "<p>The reason for failure if any.</p>",
602 "ResourceNotFoundException$message": "<p>Description of the error.</p>",
603 "ResourceNotFoundException$resourceId": "<p>Identifier of the resource affected.</p>",
604 "ResourceNotFoundException$resourceType": "<p>Type of the resource affected.</p>",
605 "RuleGroupsNamespaceStatus$statusReason": "<p>The reason for failure if any.</p>",
606 "ServiceQuotaExceededException$message": "<p>Description of the error.</p>",
607 "ServiceQuotaExceededException$resourceId": "<p>Identifier of the resource affected.</p>",
608 "ServiceQuotaExceededException$resourceType": "<p>Type of the resource affected.</p>",
609 "ServiceQuotaExceededException$serviceCode": "<p>Service Quotas requirement to identify originating service.</p>",
610 "ServiceQuotaExceededException$quotaCode": "<p>Service Quotas requirement to identify originating quota.</p>",
611 "TagResourceRequest$resourceArn": "<p>The ARN of the resource.</p>",
612 "ThrottlingException$message": "<p>Description of the error.</p>",
613 "ThrottlingException$serviceCode": "<p>Service Quotas requirement to identify originating service.</p>",
614 "ThrottlingException$quotaCode": "<p>Service Quotas requirement to identify originating quota.</p>",
615 "UntagResourceRequest$resourceArn": "<p>The ARN of the resource.</p>",
616 "ValidationException$message": "<p>Description of the error.</p>",
617 "ValidationExceptionField$name": "<p>The field name.</p>",
618 "ValidationExceptionField$message": "<p>Message describing why the field failed validation.</p>"
619 }
620 },
621 "SubnetId": {
622 "base": "<p>ID of a VPC subnet.</p>",
623 "refs": {
624 "SubnetIds$member": null
625 }
626 },
627 "SubnetIds": {
628 "base": "<p>A list of subnet IDs specified for VPC configuration.</p>",
629 "refs": {
630 "EksConfiguration$subnetIds": "<p>A list of subnet IDs specified for VPC configuration.</p>"
631 }
632 },
633 "TagKey": {
634 "base": null,
635 "refs": {
636 "TagKeys$member": null,
637 "TagMap$key": "<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with <code>aws:</code>.</p>"
638 }
639 },
640 "TagKeys": {
641 "base": null,
642 "refs": {
643 "UntagResourceRequest$tagKeys": "<p>One or more tag keys</p>"
644 }
645 },
646 "TagMap": {
647 "base": "<p>The list of tags assigned to the resource.</p>",
648 "refs": {
649 "CreateRuleGroupsNamespaceRequest$tags": "<p>Optional, user-provided tags for this rule groups namespace.</p>",
650 "CreateRuleGroupsNamespaceResponse$tags": "<p>The tags of this rule groups namespace.</p>",
651 "CreateScraperRequest$tags": "<p>Optional, user-provided tags for this scraper.</p>",
652 "CreateScraperResponse$tags": "<p>The tags of this scraper.</p>",
653 "CreateWorkspaceRequest$tags": "<p>Optional, user-provided tags for this workspace.</p>",
654 "CreateWorkspaceResponse$tags": "<p>The tags of this workspace.</p>",
655 "ListTagsForResourceResponse$tags": null,
656 "PutRuleGroupsNamespaceResponse$tags": "<p>The tags of this rule groups namespace.</p>",
657 "RuleGroupsNamespaceDescription$tags": "<p>The tags of this rule groups namespace.</p>",
658 "RuleGroupsNamespaceSummary$tags": "<p>The tags of this rule groups namespace.</p>",
659 "ScraperDescription$tags": "<p>The tags of this scraper.</p>",
660 "ScraperSummary$tags": "<p>The tags of this scraper.</p>",
661 "TagResourceRequest$tags": null,
662 "WorkspaceDescription$tags": "<p>The tags of this workspace.</p>",
663 "WorkspaceSummary$tags": "<p>The tags of this workspace.</p>"
664 }
665 },
666 "TagResourceRequest": {
667 "base": null,
668 "refs": {
669 }
670 },
671 "TagResourceResponse": {
672 "base": null,
673 "refs": {
674 }
675 },
676 "TagValue": {
677 "base": null,
678 "refs": {
679 "TagMap$value": "<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @</p>"
680 }
681 },
682 "ThrottlingException": {
683 "base": "<p>Request was denied due to request throttling.</p>",
684 "refs": {
685 }
686 },
687 "Timestamp": {
688 "base": null,
689 "refs": {
690 "AlertManagerDefinitionDescription$createdAt": "<p>The time when the alert manager definition was created.</p>",
691 "AlertManagerDefinitionDescription$modifiedAt": "<p>The time when the alert manager definition was modified.</p>",
692 "LoggingConfigurationMetadata$createdAt": "<p>The time when the logging configuration was created.</p>",
693 "LoggingConfigurationMetadata$modifiedAt": "<p>The time when the logging configuration was modified.</p>",
694 "RuleGroupsNamespaceDescription$createdAt": "<p>The time when the rule groups namespace was created.</p>",
695 "RuleGroupsNamespaceDescription$modifiedAt": "<p>The time when the rule groups namespace was modified.</p>",
696 "RuleGroupsNamespaceSummary$createdAt": "<p>The time when the rule groups namespace was created.</p>",
697 "RuleGroupsNamespaceSummary$modifiedAt": "<p>The time when the rule groups namespace was modified.</p>",
698 "ScraperDescription$createdAt": "<p>The time when the scraper was created.</p>",
699 "ScraperDescription$lastModifiedAt": "<p>The time when the scraper was last modified.</p>",
700 "ScraperSummary$createdAt": "<p>The time when the scraper was created.</p>",
701 "ScraperSummary$lastModifiedAt": "<p>The time when the scraper was last modified.</p>",
702 "WorkspaceDescription$createdAt": "<p>The time when the workspace was created.</p>",
703 "WorkspaceSummary$createdAt": "<p>The time when the workspace was created.</p>"
704 }
705 },
706 "UntagResourceRequest": {
707 "base": null,
708 "refs": {
709 }
710 },
711 "UntagResourceResponse": {
712 "base": null,
713 "refs": {
714 }
715 },
716 "UpdateLoggingConfigurationRequest": {
717 "base": "<p>Represents the input of an UpdateLoggingConfiguration operation.</p>",
718 "refs": {
719 }
720 },
721 "UpdateLoggingConfigurationResponse": {
722 "base": "<p>Represents the output of an UpdateLoggingConfiguration operation.</p>",
723 "refs": {
724 }
725 },
726 "UpdateWorkspaceAliasRequest": {
727 "base": "<p>Represents the input of an UpdateWorkspaceAlias operation.</p>",
728 "refs": {
729 }
730 },
731 "Uri": {
732 "base": null,
733 "refs": {
734 "WorkspaceDescription$prometheusEndpoint": "<p>Prometheus endpoint URI.</p>"
735 }
736 },
737 "ValidationException": {
738 "base": "<p>The input fails to satisfy the constraints specified by an AWS service.</p>",
739 "refs": {
740 }
741 },
742 "ValidationExceptionField": {
743 "base": "<p>Stores information about a field passed inside a request that resulted in an exception.</p>",
744 "refs": {
745 "ValidationExceptionFieldList$member": null
746 }
747 },
748 "ValidationExceptionFieldList": {
749 "base": "<p>A list of fields.</p>",
750 "refs": {
751 "ValidationException$fieldList": "<p>The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message.</p>"
752 }
753 },
754 "ValidationExceptionReason": {
755 "base": "<p>Possible reasons a request failed validation.</p>",
756 "refs": {
757 "ValidationException$reason": "<p>Reason the request failed validation.</p>"
758 }
759 },
760 "WorkspaceAlias": {
761 "base": "<p>A user-assigned workspace alias.</p>",
762 "refs": {
763 "CreateWorkspaceRequest$alias": "<p>An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.</p>",
764 "ListWorkspacesRequest$alias": "<p>Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.</p>",
765 "UpdateWorkspaceAliasRequest$alias": "<p>The new alias of the workspace.</p>",
766 "WorkspaceDescription$alias": "<p>Alias of this workspace.</p>",
767 "WorkspaceSummary$alias": "<p>Alias of this workspace.</p>"
768 }
769 },
770 "WorkspaceArn": {
771 "base": "<p>An ARN identifying a Workspace.</p>",
772 "refs": {
773 "AmpConfiguration$workspaceArn": "<p>The ARN of an AMP workspace.</p>",
774 "CreateWorkspaceResponse$arn": "<p>The ARN of the workspace that was just created.</p>",
775 "WorkspaceDescription$arn": "<p>The Amazon Resource Name (ARN) of this workspace.</p>",
776 "WorkspaceSummary$arn": "<p>The AmazonResourceName of this workspace.</p>"
777 }
778 },
779 "WorkspaceDescription": {
780 "base": "<p>Represents the properties of a workspace.</p>",
781 "refs": {
782 "DescribeWorkspaceResponse$workspace": "<p>The properties of the selected workspace.</p>"
783 }
784 },
785 "WorkspaceId": {
786 "base": "<p>A workspace ID.</p>",
787 "refs": {
788 "CreateAlertManagerDefinitionRequest$workspaceId": "<p>The ID of the workspace in which to create the alert manager definition.</p>",
789 "CreateLoggingConfigurationRequest$workspaceId": "<p>The ID of the workspace to vend logs to.</p>",
790 "CreateRuleGroupsNamespaceRequest$workspaceId": "<p>The ID of the workspace in which to create the rule group namespace.</p>",
791 "CreateWorkspaceResponse$workspaceId": "<p>The generated ID of the workspace that was just created.</p>",
792 "DeleteAlertManagerDefinitionRequest$workspaceId": "<p>The ID of the workspace in which to delete the alert manager definition.</p>",
793 "DeleteLoggingConfigurationRequest$workspaceId": "<p>The ID of the workspace to vend logs to.</p>",
794 "DeleteRuleGroupsNamespaceRequest$workspaceId": "<p>The ID of the workspace to delete rule group definition.</p>",
795 "DeleteWorkspaceRequest$workspaceId": "<p>The ID of the workspace to delete.</p>",
796 "DescribeAlertManagerDefinitionRequest$workspaceId": "<p>The ID of the workspace to describe.</p>",
797 "DescribeLoggingConfigurationRequest$workspaceId": "<p>The ID of the workspace to vend logs to.</p>",
798 "DescribeRuleGroupsNamespaceRequest$workspaceId": "<p>The ID of the workspace to describe.</p>",
799 "DescribeWorkspaceRequest$workspaceId": "<p>The ID of the workspace to describe.</p>",
800 "ListRuleGroupsNamespacesRequest$workspaceId": "<p>The ID of the workspace.</p>",
801 "LoggingConfigurationMetadata$workspace": "<p>The workspace where the logging configuration exists.</p>",
802 "PutAlertManagerDefinitionRequest$workspaceId": "<p>The ID of the workspace in which to update the alert manager definition.</p>",
803 "PutRuleGroupsNamespaceRequest$workspaceId": "<p>The ID of the workspace in which to update the rule group namespace.</p>",
804 "UpdateLoggingConfigurationRequest$workspaceId": "<p>The ID of the workspace to vend logs to.</p>",
805 "UpdateWorkspaceAliasRequest$workspaceId": "<p>The ID of the workspace being updated.</p>",
806 "WorkspaceDescription$workspaceId": "<p>Unique string identifying this workspace.</p>",
807 "WorkspaceSummary$workspaceId": "<p>Unique string identifying this workspace.</p>"
808 }
809 },
810 "WorkspaceStatus": {
811 "base": "<p>Represents the status of a workspace.</p>",
812 "refs": {
813 "CreateWorkspaceResponse$status": "<p>The status of the workspace that was just created (usually CREATING).</p>",
814 "WorkspaceDescription$status": "<p>The status of this workspace.</p>",
815 "WorkspaceSummary$status": "<p>The status of this workspace.</p>"
816 }
817 },
818 "WorkspaceStatusCode": {
819 "base": "<p>State of a workspace.</p>",
820 "refs": {
821 "WorkspaceStatus$statusCode": "<p>Status code of this workspace.</p>"
822 }
823 },
824 "WorkspaceSummary": {
825 "base": "<p>Represents a summary of the properties of a workspace.</p>",
826 "refs": {
827 "WorkspaceSummaryList$member": null
828 }
829 },
830 "WorkspaceSummaryList": {
831 "base": "<p>A list of workspace summaries.</p>",
832 "refs": {
833 "ListWorkspacesResponse$workspaces": "<p>The list of existing workspaces, including those undergoing creation or deletion.</p>"
834 }
835 }
836 }
837 }