@aws-sdk/client-amp 3.812.0 → 3.817.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 +33 -18
- package/dist-cjs/index.js +216 -0
- package/dist-cjs/runtimeConfig.js +4 -1
- package/dist-es/Amp.js +8 -0
- package/dist-es/commands/CreateQueryLoggingConfigurationCommand.js +22 -0
- package/dist-es/commands/DeleteQueryLoggingConfigurationCommand.js +22 -0
- package/dist-es/commands/DescribeQueryLoggingConfigurationCommand.js +22 -0
- package/dist-es/commands/UpdateQueryLoggingConfigurationCommand.js +22 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +8 -0
- package/dist-es/protocols/Aws_restJson1.js +112 -0
- package/dist-es/runtimeConfig.js +4 -1
- package/dist-types/Amp.d.ts +29 -18
- package/dist-types/AmpClient.d.ts +7 -20
- package/dist-types/commands/CreateAlertManagerDefinitionCommand.d.ts +2 -6
- package/dist-types/commands/CreateLoggingConfigurationCommand.d.ts +2 -5
- package/dist-types/commands/CreateQueryLoggingConfigurationCommand.d.ts +98 -0
- package/dist-types/commands/CreateRuleGroupsNamespaceCommand.d.ts +2 -7
- package/dist-types/commands/CreateScraperCommand.d.ts +2 -20
- package/dist-types/commands/CreateWorkspaceCommand.d.ts +2 -5
- package/dist-types/commands/DeleteAlertManagerDefinitionCommand.d.ts +1 -2
- package/dist-types/commands/DeleteLoggingConfigurationCommand.d.ts +2 -3
- package/dist-types/commands/DeleteQueryLoggingConfigurationCommand.d.ts +86 -0
- package/dist-types/commands/DeleteRuleGroupsNamespaceCommand.d.ts +1 -2
- package/dist-types/commands/DeleteScraperCommand.d.ts +2 -4
- package/dist-types/commands/DeleteWorkspaceCommand.d.ts +2 -7
- package/dist-types/commands/DescribeAlertManagerDefinitionCommand.d.ts +2 -4
- package/dist-types/commands/DescribeLoggingConfigurationCommand.d.ts +2 -4
- package/dist-types/commands/DescribeQueryLoggingConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/DescribeRuleGroupsNamespaceCommand.d.ts +2 -4
- package/dist-types/commands/DescribeScraperCommand.d.ts +2 -4
- package/dist-types/commands/DescribeWorkspaceCommand.d.ts +1 -2
- package/dist-types/commands/DescribeWorkspaceConfigurationCommand.d.ts +2 -4
- package/dist-types/commands/GetDefaultScraperConfigurationCommand.d.ts +1 -2
- package/dist-types/commands/ListRuleGroupsNamespacesCommand.d.ts +1 -2
- package/dist-types/commands/ListScrapersCommand.d.ts +2 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -5
- package/dist-types/commands/ListWorkspacesCommand.d.ts +2 -4
- package/dist-types/commands/PutAlertManagerDefinitionCommand.d.ts +2 -5
- package/dist-types/commands/PutRuleGroupsNamespaceCommand.d.ts +2 -9
- package/dist-types/commands/TagResourceCommand.d.ts +2 -9
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
- package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts +2 -4
- package/dist-types/commands/UpdateQueryLoggingConfigurationCommand.d.ts +101 -0
- package/dist-types/commands/UpdateScraperCommand.d.ts +2 -6
- package/dist-types/commands/UpdateWorkspaceAliasCommand.d.ts +1 -2
- package/dist-types/commands/UpdateWorkspaceConfigurationCommand.d.ts +2 -5
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/index.d.ts +1 -18
- package/dist-types/models/models_0.d.ts +294 -207
- package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
- package/dist-types/ts3.4/Amp.d.ts +74 -0
- package/dist-types/ts3.4/AmpClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateQueryLoggingConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteQueryLoggingConfigurationCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DescribeQueryLoggingConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateQueryLoggingConfigurationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +57 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +48 -0
- package/package.json +5 -5
|
@@ -45,15 +45,12 @@ export interface CreateAlertManagerDefinitionRequest {
|
|
|
45
45
|
*/
|
|
46
46
|
workspaceId: string | undefined;
|
|
47
47
|
/**
|
|
48
|
-
* <p>The alert manager definition to add. A base64-encoded version of the YAML alert
|
|
49
|
-
* manager definition file.</p>
|
|
50
|
-
* <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>
|
|
48
|
+
* <p>The alert manager definition to add. A base64-encoded version of the YAML alert manager definition file.</p> <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>
|
|
51
49
|
* @public
|
|
52
50
|
*/
|
|
53
51
|
data: Uint8Array | undefined;
|
|
54
52
|
/**
|
|
55
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
56
|
-
* Case-sensitive.</p>
|
|
53
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
57
54
|
* @public
|
|
58
55
|
*/
|
|
59
56
|
clientToken?: string | undefined;
|
|
@@ -250,8 +247,7 @@ export declare const ValidationExceptionReason: {
|
|
|
250
247
|
*/
|
|
251
248
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
252
249
|
/**
|
|
253
|
-
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services
|
|
254
|
-
* service.</p>
|
|
250
|
+
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
255
251
|
* @public
|
|
256
252
|
*/
|
|
257
253
|
export declare class ValidationException extends __BaseException {
|
|
@@ -283,8 +279,7 @@ export interface DeleteAlertManagerDefinitionRequest {
|
|
|
283
279
|
*/
|
|
284
280
|
workspaceId: string | undefined;
|
|
285
281
|
/**
|
|
286
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
287
|
-
* Case-sensitive.</p>
|
|
282
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
288
283
|
* @public
|
|
289
284
|
*/
|
|
290
285
|
clientToken?: string | undefined;
|
|
@@ -301,8 +296,7 @@ export interface DescribeAlertManagerDefinitionRequest {
|
|
|
301
296
|
workspaceId: string | undefined;
|
|
302
297
|
}
|
|
303
298
|
/**
|
|
304
|
-
* <p>The details of an alert manager definition. It is the configuration for the
|
|
305
|
-
* alert manager, including information about receivers for routing alerts.</p>
|
|
299
|
+
* <p>The details of an alert manager definition. It is the configuration for the alert manager, including information about receivers for routing alerts.</p>
|
|
306
300
|
* @public
|
|
307
301
|
*/
|
|
308
302
|
export interface AlertManagerDefinitionDescription {
|
|
@@ -312,8 +306,7 @@ export interface AlertManagerDefinitionDescription {
|
|
|
312
306
|
*/
|
|
313
307
|
status: AlertManagerDefinitionStatus | undefined;
|
|
314
308
|
/**
|
|
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>
|
|
309
|
+
* <p>The actual alert manager definition.</p> <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>
|
|
317
310
|
* @public
|
|
318
311
|
*/
|
|
319
312
|
data: Uint8Array | undefined;
|
|
@@ -350,15 +343,12 @@ export interface PutAlertManagerDefinitionRequest {
|
|
|
350
343
|
*/
|
|
351
344
|
workspaceId: string | undefined;
|
|
352
345
|
/**
|
|
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>
|
|
346
|
+
* <p>The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file.</p> <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>
|
|
356
347
|
* @public
|
|
357
348
|
*/
|
|
358
349
|
data: Uint8Array | undefined;
|
|
359
350
|
/**
|
|
360
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
361
|
-
* Case-sensitive.</p>
|
|
351
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
362
352
|
* @public
|
|
363
353
|
*/
|
|
364
354
|
clientToken?: string | undefined;
|
|
@@ -386,9 +376,7 @@ export interface GetDefaultScraperConfigurationRequest {
|
|
|
386
376
|
*/
|
|
387
377
|
export interface GetDefaultScraperConfigurationResponse {
|
|
388
378
|
/**
|
|
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>
|
|
379
|
+
* <p>The configuration file. Base 64 encoded. 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 Guide</i>.</p>
|
|
392
380
|
* @public
|
|
393
381
|
*/
|
|
394
382
|
configuration: Uint8Array | undefined;
|
|
@@ -398,8 +386,7 @@ export interface GetDefaultScraperConfigurationResponse {
|
|
|
398
386
|
*/
|
|
399
387
|
export interface ListTagsForResourceRequest {
|
|
400
388
|
/**
|
|
401
|
-
* <p>The ARN of the resource to list tages for. Must be a workspace, scraper, or rule groups
|
|
402
|
-
* namespace resource.</p>
|
|
389
|
+
* <p>The ARN of the resource to list tages for. Must be a workspace, scraper, or rule groups namespace resource.</p>
|
|
403
390
|
* @public
|
|
404
391
|
*/
|
|
405
392
|
resourceArn: string | undefined;
|
|
@@ -415,8 +402,7 @@ export interface ListTagsForResourceResponse {
|
|
|
415
402
|
tags?: Record<string, string> | undefined;
|
|
416
403
|
}
|
|
417
404
|
/**
|
|
418
|
-
* <p>The <code>AmpConfiguration</code> structure defines the Amazon Managed Service for Prometheus instance a scraper
|
|
419
|
-
* should send metrics to.</p>
|
|
405
|
+
* <p>The <code>AmpConfiguration</code> structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.</p>
|
|
420
406
|
* @public
|
|
421
407
|
*/
|
|
422
408
|
export interface AmpConfiguration {
|
|
@@ -462,21 +448,18 @@ export declare namespace Destination {
|
|
|
462
448
|
*/
|
|
463
449
|
export interface RoleConfiguration {
|
|
464
450
|
/**
|
|
465
|
-
* <p>The Amazon Resource Name (ARN) of the role used in the source account to enable cross-account scraping. For information about
|
|
466
|
-
* the contents of this policy, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#cross-account-remote-write">Cross-account setup</a>.</p>
|
|
451
|
+
* <p>The Amazon Resource Name (ARN) of the role used in the source account to enable cross-account scraping. For information about the contents of this policy, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#cross-account-remote-write">Cross-account setup</a>.</p>
|
|
467
452
|
* @public
|
|
468
453
|
*/
|
|
469
454
|
sourceRoleArn?: string | undefined;
|
|
470
455
|
/**
|
|
471
|
-
* <p>The Amazon Resource Name (ARN) of the role used in the target account to enable cross-account scraping. For information about
|
|
472
|
-
* the contents of this policy, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#cross-account-remote-write">Cross-account setup</a>.</p>
|
|
456
|
+
* <p>The Amazon Resource Name (ARN) of the role used in the target account to enable cross-account scraping. For information about the contents of this policy, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#cross-account-remote-write">Cross-account setup</a>.</p>
|
|
473
457
|
* @public
|
|
474
458
|
*/
|
|
475
459
|
targetRoleArn?: string | undefined;
|
|
476
460
|
}
|
|
477
461
|
/**
|
|
478
|
-
* <p>A scrape configuration for a scraper, base 64 encoded. 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
|
|
479
|
-
* Guide</i>.</p>
|
|
462
|
+
* <p>A scrape configuration for a scraper, base 64 encoded. 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 Guide</i>.</p>
|
|
480
463
|
* @public
|
|
481
464
|
*/
|
|
482
465
|
export type ScrapeConfiguration = ScrapeConfiguration.ConfigurationBlobMember | ScrapeConfiguration.$UnknownMember;
|
|
@@ -506,8 +489,7 @@ export declare namespace ScrapeConfiguration {
|
|
|
506
489
|
const visit: <T>(value: ScrapeConfiguration, visitor: Visitor<T>) => T;
|
|
507
490
|
}
|
|
508
491
|
/**
|
|
509
|
-
* <p>The <code>EksConfiguration</code> structure describes the connection to the
|
|
510
|
-
* Amazon EKS cluster from which a scraper collects metrics.</p>
|
|
492
|
+
* <p>The <code>EksConfiguration</code> structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.</p>
|
|
511
493
|
* @public
|
|
512
494
|
*/
|
|
513
495
|
export interface EksConfiguration {
|
|
@@ -563,14 +545,12 @@ export declare namespace Source {
|
|
|
563
545
|
*/
|
|
564
546
|
export interface CreateScraperRequest {
|
|
565
547
|
/**
|
|
566
|
-
* <p>(optional) An alias to associate with the scraper. This is for your use, and does not
|
|
567
|
-
* need to be unique.</p>
|
|
548
|
+
* <p>(optional) An alias to associate with the scraper. This is for your use, and does not need to be unique.</p>
|
|
568
549
|
* @public
|
|
569
550
|
*/
|
|
570
551
|
alias?: string | undefined;
|
|
571
552
|
/**
|
|
572
|
-
* <p>The configuration file to use in the new scraper. 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
|
|
573
|
-
* Guide</i>.</p>
|
|
553
|
+
* <p>The configuration file to use in the new scraper. 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 Guide</i>.</p>
|
|
574
554
|
* @public
|
|
575
555
|
*/
|
|
576
556
|
scrapeConfiguration: ScrapeConfiguration | undefined;
|
|
@@ -590,8 +570,7 @@ export interface CreateScraperRequest {
|
|
|
590
570
|
*/
|
|
591
571
|
roleConfiguration?: RoleConfiguration | undefined;
|
|
592
572
|
/**
|
|
593
|
-
* <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the
|
|
594
|
-
* idempotency of the request.</p>
|
|
573
|
+
* <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.</p>
|
|
595
574
|
* @public
|
|
596
575
|
*/
|
|
597
576
|
clientToken?: string | undefined;
|
|
@@ -640,8 +619,7 @@ export declare const ScraperStatusCode: {
|
|
|
640
619
|
*/
|
|
641
620
|
export type ScraperStatusCode = (typeof ScraperStatusCode)[keyof typeof ScraperStatusCode];
|
|
642
621
|
/**
|
|
643
|
-
* <p>The <code>ScraperStatus</code> structure contains status information about the
|
|
644
|
-
* scraper.</p>
|
|
622
|
+
* <p>The <code>ScraperStatus</code> structure contains status information about the scraper.</p>
|
|
645
623
|
* @public
|
|
646
624
|
*/
|
|
647
625
|
export interface ScraperStatus {
|
|
@@ -688,8 +666,7 @@ export interface DeleteScraperRequest {
|
|
|
688
666
|
*/
|
|
689
667
|
scraperId: string | undefined;
|
|
690
668
|
/**
|
|
691
|
-
* <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the
|
|
692
|
-
* idempotency of the request.</p>
|
|
669
|
+
* <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.</p>
|
|
693
670
|
* @public
|
|
694
671
|
*/
|
|
695
672
|
clientToken?: string | undefined;
|
|
@@ -722,8 +699,7 @@ export interface DescribeScraperRequest {
|
|
|
722
699
|
scraperId: string | undefined;
|
|
723
700
|
}
|
|
724
701
|
/**
|
|
725
|
-
* <p>The <code>ScraperDescription</code> structure contains the full details about one
|
|
726
|
-
* scraper in your account.</p>
|
|
702
|
+
* <p>The <code>ScraperDescription</code> structure contains the full details about one scraper in your account.</p>
|
|
727
703
|
* @public
|
|
728
704
|
*/
|
|
729
705
|
export interface ScraperDescription {
|
|
@@ -738,15 +714,12 @@ export interface ScraperDescription {
|
|
|
738
714
|
*/
|
|
739
715
|
scraperId: string | undefined;
|
|
740
716
|
/**
|
|
741
|
-
* <p>The Amazon Resource Name (ARN) of the scraper. For example,
|
|
742
|
-
* <code>arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34</code>.</p>
|
|
717
|
+
* <p>The Amazon Resource Name (ARN) of the scraper. For example, <code>arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34</code>.</p>
|
|
743
718
|
* @public
|
|
744
719
|
*/
|
|
745
720
|
arn: string | undefined;
|
|
746
721
|
/**
|
|
747
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that provides
|
|
748
|
-
* permissions for the scraper to discover and collect metrics on your behalf.</p>
|
|
749
|
-
* <p>For example, <code>arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example</code>.</p>
|
|
722
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.</p> <p>For example, <code>arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example</code>.</p>
|
|
750
723
|
* @public
|
|
751
724
|
*/
|
|
752
725
|
roleArn: string | undefined;
|
|
@@ -813,41 +786,23 @@ export interface DescribeScraperResponse {
|
|
|
813
786
|
*/
|
|
814
787
|
export interface ListScrapersRequest {
|
|
815
788
|
/**
|
|
816
|
-
* <p>(Optional) A list of key-value pairs to filter the list of scrapers returned.
|
|
817
|
-
* Keys include <code>status</code>, <code>sourceArn</code>,
|
|
818
|
-
* <code>destinationArn</code>, and <code>alias</code>.</p>
|
|
819
|
-
* <p>Filters on the same key are <code>OR</code>'d together, and filters on different
|
|
820
|
-
* keys are <code>AND</code>'d together. For example,
|
|
821
|
-
* <code>status=ACTIVE&status=CREATING&alias=Test</code>, will return all
|
|
822
|
-
* scrapers that have the alias Test, and are either in status ACTIVE or CREATING.</p>
|
|
823
|
-
* <p>To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus
|
|
824
|
-
* workspace, you would use the ARN of the workspace in a query:</p>
|
|
825
|
-
* <p>
|
|
826
|
-
* <code>status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012</code>
|
|
827
|
-
* </p>
|
|
828
|
-
* <p>If this is included, it filters the results to only the scrapers that match
|
|
829
|
-
* the filter.</p>
|
|
789
|
+
* <p>(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include <code>status</code>, <code>sourceArn</code>, <code>destinationArn</code>, and <code>alias</code>.</p> <p>Filters on the same key are <code>OR</code>'d together, and filters on different keys are <code>AND</code>'d together. For example, <code>status=ACTIVE&status=CREATING&alias=Test</code>, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.</p> <p>To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:</p> <p> <code>status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012</code> </p> <p>If this is included, it filters the results to only the scrapers that match the filter.</p>
|
|
830
790
|
* @public
|
|
831
791
|
*/
|
|
832
792
|
filters?: Record<string, string[]> | undefined;
|
|
833
793
|
/**
|
|
834
|
-
* <p>(Optional) The token for the next set of
|
|
835
|
-
* items to return. (You received this token from a previous call.)</p>
|
|
794
|
+
* <p>(Optional) The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
836
795
|
* @public
|
|
837
796
|
*/
|
|
838
797
|
nextToken?: string | undefined;
|
|
839
798
|
/**
|
|
840
|
-
* <p>Optional) The maximum number of
|
|
841
|
-
* scrapers to return in one <code>ListScrapers</code> operation. The range is
|
|
842
|
-
* 1-1000.</p>
|
|
843
|
-
* <p>If you omit this parameter, the default of 100 is used.</p>
|
|
799
|
+
* <p>Optional) The maximum number of scrapers to return in one <code>ListScrapers</code> operation. The range is 1-1000.</p> <p>If you omit this parameter, the default of 100 is used.</p>
|
|
844
800
|
* @public
|
|
845
801
|
*/
|
|
846
802
|
maxResults?: number | undefined;
|
|
847
803
|
}
|
|
848
804
|
/**
|
|
849
|
-
* <p>The <code>ScraperSummary</code> structure contains a summary of the details about one
|
|
850
|
-
* scraper in your account.</p>
|
|
805
|
+
* <p>The <code>ScraperSummary</code> structure contains a summary of the details about one scraper in your account.</p>
|
|
851
806
|
* @public
|
|
852
807
|
*/
|
|
853
808
|
export interface ScraperSummary {
|
|
@@ -867,8 +822,7 @@ export interface ScraperSummary {
|
|
|
867
822
|
*/
|
|
868
823
|
arn: string | undefined;
|
|
869
824
|
/**
|
|
870
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role that provides
|
|
871
|
-
* permissions for the scraper to discover and collect metrics on your behalf.</p>
|
|
825
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.</p>
|
|
872
826
|
* @public
|
|
873
827
|
*/
|
|
874
828
|
roleArn: string | undefined;
|
|
@@ -919,15 +873,12 @@ export interface ScraperSummary {
|
|
|
919
873
|
*/
|
|
920
874
|
export interface ListScrapersResponse {
|
|
921
875
|
/**
|
|
922
|
-
* <p>A list of <code>ScraperSummary</code> structures giving information about scrapers
|
|
923
|
-
* in the account that match the filters provided.</p>
|
|
876
|
+
* <p>A list of <code>ScraperSummary</code> structures giving information about scrapers in the account that match the filters provided.</p>
|
|
924
877
|
* @public
|
|
925
878
|
*/
|
|
926
879
|
scrapers: ScraperSummary[] | undefined;
|
|
927
880
|
/**
|
|
928
|
-
* <p>A token indicating that there are more
|
|
929
|
-
* results to retrieve. You can use this token as part of your next
|
|
930
|
-
* <code>ListScrapers</code> operation to retrieve those results.</p>
|
|
881
|
+
* <p>A token indicating that there are more results to retrieve. You can use this token as part of your next <code>ListScrapers</code> operation to retrieve those results.</p>
|
|
931
882
|
* @public
|
|
932
883
|
*/
|
|
933
884
|
nextToken?: string | undefined;
|
|
@@ -947,12 +898,7 @@ export interface UpdateScraperRequest {
|
|
|
947
898
|
*/
|
|
948
899
|
alias?: string | undefined;
|
|
949
900
|
/**
|
|
950
|
-
* <p>Contains the base-64 encoded YAML configuration for the scraper.</p>
|
|
951
|
-
* <note>
|
|
952
|
-
* <p>For more information about configuring a scraper, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html">Using an
|
|
953
|
-
* Amazon Web Services managed collector</a> in the <i>Amazon Managed Service for Prometheus
|
|
954
|
-
* User Guide</i>.</p>
|
|
955
|
-
* </note>
|
|
901
|
+
* <p>Contains the base-64 encoded YAML configuration for the scraper.</p> <note> <p>For more information about configuring a scraper, see <a href="https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html">Using an Amazon Web Services managed collector</a> in the <i>Amazon Managed Service for Prometheus User Guide</i>.</p> </note>
|
|
956
902
|
* @public
|
|
957
903
|
*/
|
|
958
904
|
scrapeConfiguration?: ScrapeConfiguration | undefined;
|
|
@@ -967,8 +913,7 @@ export interface UpdateScraperRequest {
|
|
|
967
913
|
*/
|
|
968
914
|
roleConfiguration?: RoleConfiguration | undefined;
|
|
969
915
|
/**
|
|
970
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
971
|
-
* Case-sensitive.</p>
|
|
916
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
972
917
|
* @public
|
|
973
918
|
*/
|
|
974
919
|
clientToken?: string | undefined;
|
|
@@ -1008,8 +953,7 @@ export interface TagResourceRequest {
|
|
|
1008
953
|
*/
|
|
1009
954
|
resourceArn: string | undefined;
|
|
1010
955
|
/**
|
|
1011
|
-
* <p>The list of tag keys and values to associate with the resource.</p>
|
|
1012
|
-
* <p>Keys must not begin with <code>aws:</code>.</p>
|
|
956
|
+
* <p>The list of tag keys and values to associate with the resource.</p> <p>Keys must not begin with <code>aws:</code>.</p>
|
|
1013
957
|
* @public
|
|
1014
958
|
*/
|
|
1015
959
|
tags: Record<string, string> | undefined;
|
|
@@ -1045,16 +989,12 @@ export interface UntagResourceResponse {
|
|
|
1045
989
|
*/
|
|
1046
990
|
export interface CreateWorkspaceRequest {
|
|
1047
991
|
/**
|
|
1048
|
-
* <p>An alias that you assign to this workspace to help you identify it. It does not need
|
|
1049
|
-
* to be unique.</p>
|
|
1050
|
-
* <p>Blank spaces at the beginning or end of the alias that you specify will be trimmed
|
|
1051
|
-
* from the value used.</p>
|
|
992
|
+
* <p>An alias that you assign to this workspace to help you identify it. It does not need to be unique.</p> <p>Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.</p>
|
|
1052
993
|
* @public
|
|
1053
994
|
*/
|
|
1054
995
|
alias?: string | undefined;
|
|
1055
996
|
/**
|
|
1056
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1057
|
-
* Case-sensitive.</p>
|
|
997
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
1058
998
|
* @public
|
|
1059
999
|
*/
|
|
1060
1000
|
clientToken?: string | undefined;
|
|
@@ -1064,10 +1004,7 @@ export interface CreateWorkspaceRequest {
|
|
|
1064
1004
|
*/
|
|
1065
1005
|
tags?: Record<string, string> | undefined;
|
|
1066
1006
|
/**
|
|
1067
|
-
* <p>(optional) The ARN for a customer managed KMS key to use for
|
|
1068
|
-
* encrypting data within your workspace. For more information about using your
|
|
1069
|
-
* 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
|
|
1070
|
-
* Guide</i>.</p>
|
|
1007
|
+
* <p>(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your 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 Guide</i>.</p>
|
|
1071
1008
|
* @public
|
|
1072
1009
|
*/
|
|
1073
1010
|
kmsKeyArn?: string | undefined;
|
|
@@ -1129,8 +1066,7 @@ export interface CreateWorkspaceResponse {
|
|
|
1129
1066
|
*/
|
|
1130
1067
|
arn: string | undefined;
|
|
1131
1068
|
/**
|
|
1132
|
-
* <p>The current status of the new workspace. Immediately after you create the workspace,
|
|
1133
|
-
* the status is usually <code>CREATING</code>.</p>
|
|
1069
|
+
* <p>The current status of the new workspace. Immediately after you create the workspace, the status is usually <code>CREATING</code>.</p>
|
|
1134
1070
|
* @public
|
|
1135
1071
|
*/
|
|
1136
1072
|
status: WorkspaceStatus | undefined;
|
|
@@ -1140,8 +1076,7 @@ export interface CreateWorkspaceResponse {
|
|
|
1140
1076
|
*/
|
|
1141
1077
|
tags?: Record<string, string> | undefined;
|
|
1142
1078
|
/**
|
|
1143
|
-
* <p>(optional) If the workspace was created with a customer managed KMS
|
|
1144
|
-
* key, the ARN for the key used.</p>
|
|
1079
|
+
* <p>(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.</p>
|
|
1145
1080
|
* @public
|
|
1146
1081
|
*/
|
|
1147
1082
|
kmsKeyArn?: string | undefined;
|
|
@@ -1157,8 +1092,7 @@ export interface DeleteWorkspaceRequest {
|
|
|
1157
1092
|
*/
|
|
1158
1093
|
workspaceId: string | undefined;
|
|
1159
1094
|
/**
|
|
1160
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1161
|
-
* Case-sensitive.</p>
|
|
1095
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
1162
1096
|
* @public
|
|
1163
1097
|
*/
|
|
1164
1098
|
clientToken?: string | undefined;
|
|
@@ -1180,20 +1114,17 @@ export interface DescribeWorkspaceRequest {
|
|
|
1180
1114
|
*/
|
|
1181
1115
|
export interface WorkspaceDescription {
|
|
1182
1116
|
/**
|
|
1183
|
-
* <p>The unique ID for the workspace. For example,
|
|
1184
|
-
* <code>ws-example1-1234-abcd-5678-ef90abcd1234</code>.</p>
|
|
1117
|
+
* <p>The unique ID for the workspace. For example, <code>ws-example1-1234-abcd-5678-ef90abcd1234</code>.</p>
|
|
1185
1118
|
* @public
|
|
1186
1119
|
*/
|
|
1187
1120
|
workspaceId: string | undefined;
|
|
1188
1121
|
/**
|
|
1189
|
-
* <p>The alias that is assigned to this workspace to help identify it. It does not need
|
|
1190
|
-
* to be unique.</p>
|
|
1122
|
+
* <p>The alias that is assigned to this workspace to help identify it. It does not need to be unique.</p>
|
|
1191
1123
|
* @public
|
|
1192
1124
|
*/
|
|
1193
1125
|
alias?: string | undefined;
|
|
1194
1126
|
/**
|
|
1195
|
-
* <p>The ARN of the workspace. For example,
|
|
1196
|
-
* <code>arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234</code>.</p>
|
|
1127
|
+
* <p>The ARN of the workspace. For example, <code>arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234</code>.</p>
|
|
1197
1128
|
* @public
|
|
1198
1129
|
*/
|
|
1199
1130
|
arn: string | undefined;
|
|
@@ -1203,8 +1134,7 @@ export interface WorkspaceDescription {
|
|
|
1203
1134
|
*/
|
|
1204
1135
|
status: WorkspaceStatus | undefined;
|
|
1205
1136
|
/**
|
|
1206
|
-
* <p>The Prometheus endpoint available for this workspace. For example,
|
|
1207
|
-
* <code>https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/</code>.</p>
|
|
1137
|
+
* <p>The Prometheus endpoint available for this workspace. For example, <code>https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/</code>.</p>
|
|
1208
1138
|
* @public
|
|
1209
1139
|
*/
|
|
1210
1140
|
prometheusEndpoint?: string | undefined;
|
|
@@ -1219,8 +1149,7 @@ export interface WorkspaceDescription {
|
|
|
1219
1149
|
*/
|
|
1220
1150
|
tags?: Record<string, string> | undefined;
|
|
1221
1151
|
/**
|
|
1222
|
-
* <p>(optional) If the workspace was created with a customer managed KMS
|
|
1223
|
-
* key, the ARN for the key used.</p>
|
|
1152
|
+
* <p>(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.</p>
|
|
1224
1153
|
* @public
|
|
1225
1154
|
*/
|
|
1226
1155
|
kmsKeyArn?: string | undefined;
|
|
@@ -1242,21 +1171,12 @@ export interface DescribeWorkspaceResponse {
|
|
|
1242
1171
|
*/
|
|
1243
1172
|
export interface ListWorkspacesRequest {
|
|
1244
1173
|
/**
|
|
1245
|
-
* <p>The token for the next set of items to return. You receive this token from a previous
|
|
1246
|
-
* call, and use it to get the next page of results. The other parameters must be the same
|
|
1247
|
-
* as the initial call.</p>
|
|
1248
|
-
* <p>For example, if your initial request has <code>maxResults</code> of 10, and there are
|
|
1249
|
-
* 12 workspaces to return, then your initial request will return 10 and a
|
|
1250
|
-
* <code>nextToken</code>. Using the next token in a subsequent call will return the
|
|
1251
|
-
* remaining 2 workspaces.</p>
|
|
1174
|
+
* <p>The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.</p> <p>For example, if your initial request has <code>maxResults</code> of 10, and there are 12 workspaces to return, then your initial request will return 10 and a <code>nextToken</code>. Using the next token in a subsequent call will return the remaining 2 workspaces.</p>
|
|
1252
1175
|
* @public
|
|
1253
1176
|
*/
|
|
1254
1177
|
nextToken?: string | undefined;
|
|
1255
1178
|
/**
|
|
1256
|
-
* <p>If this is included, it filters the results to only the workspaces with names that
|
|
1257
|
-
* start with the value that you specify here.</p>
|
|
1258
|
-
* <p>Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning
|
|
1259
|
-
* and end of the alias that you specify.</p>
|
|
1179
|
+
* <p>If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.</p> <p>Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.</p>
|
|
1260
1180
|
* @public
|
|
1261
1181
|
*/
|
|
1262
1182
|
alias?: string | undefined;
|
|
@@ -1277,8 +1197,7 @@ export interface WorkspaceSummary {
|
|
|
1277
1197
|
*/
|
|
1278
1198
|
workspaceId: string | undefined;
|
|
1279
1199
|
/**
|
|
1280
|
-
* <p>The alias that is assigned to this workspace to help identify it. It does not
|
|
1281
|
-
* need to be unique.</p>
|
|
1200
|
+
* <p>The alias that is assigned to this workspace to help identify it. It does not need to be unique.</p>
|
|
1282
1201
|
* @public
|
|
1283
1202
|
*/
|
|
1284
1203
|
alias?: string | undefined;
|
|
@@ -1303,8 +1222,7 @@ export interface WorkspaceSummary {
|
|
|
1303
1222
|
*/
|
|
1304
1223
|
tags?: Record<string, string> | undefined;
|
|
1305
1224
|
/**
|
|
1306
|
-
* <p>(optional) If the workspace was created with a customer managed KMS
|
|
1307
|
-
* key, the ARN for the key used.</p>
|
|
1225
|
+
* <p>(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.</p>
|
|
1308
1226
|
* @public
|
|
1309
1227
|
*/
|
|
1310
1228
|
kmsKeyArn?: string | undefined;
|
|
@@ -1315,14 +1233,12 @@ export interface WorkspaceSummary {
|
|
|
1315
1233
|
*/
|
|
1316
1234
|
export interface ListWorkspacesResponse {
|
|
1317
1235
|
/**
|
|
1318
|
-
* <p>An array of <code>WorkspaceSummary</code> structures containing information about the
|
|
1319
|
-
* workspaces requested.</p>
|
|
1236
|
+
* <p>An array of <code>WorkspaceSummary</code> structures containing information about the workspaces requested.</p>
|
|
1320
1237
|
* @public
|
|
1321
1238
|
*/
|
|
1322
1239
|
workspaces: WorkspaceSummary[] | undefined;
|
|
1323
1240
|
/**
|
|
1324
|
-
* <p>A token indicating that there are more results to retrieve. You can use this token as
|
|
1325
|
-
* part of your next <code>ListWorkspaces</code> request to retrieve those results.</p>
|
|
1241
|
+
* <p>A token indicating that there are more results to retrieve. You can use this token as part of your next <code>ListWorkspaces</code> request to retrieve those results.</p>
|
|
1326
1242
|
* @public
|
|
1327
1243
|
*/
|
|
1328
1244
|
nextToken?: string | undefined;
|
|
@@ -1338,14 +1254,12 @@ export interface CreateLoggingConfigurationRequest {
|
|
|
1338
1254
|
*/
|
|
1339
1255
|
workspaceId: string | undefined;
|
|
1340
1256
|
/**
|
|
1341
|
-
* <p>The ARN of the CloudWatch log group to which the vended log data will be
|
|
1342
|
-
* published. This log group must exist prior to calling this operation.</p>
|
|
1257
|
+
* <p>The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.</p>
|
|
1343
1258
|
* @public
|
|
1344
1259
|
*/
|
|
1345
1260
|
logGroupArn: string | undefined;
|
|
1346
1261
|
/**
|
|
1347
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1348
|
-
* Case-sensitive.</p>
|
|
1262
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
1349
1263
|
* @public
|
|
1350
1264
|
*/
|
|
1351
1265
|
clientToken?: string | undefined;
|
|
@@ -1390,7 +1304,7 @@ export type LoggingConfigurationStatusCode = (typeof LoggingConfigurationStatusC
|
|
|
1390
1304
|
*/
|
|
1391
1305
|
export interface LoggingConfigurationStatus {
|
|
1392
1306
|
/**
|
|
1393
|
-
* <p>The current status of the logging configuration.</p>
|
|
1307
|
+
* <p>The current status of the current rules and alerting logging configuration.</p> <note> <p>These logging configurations are only for rules and alerting logs.</p> </note>
|
|
1394
1308
|
* @public
|
|
1395
1309
|
*/
|
|
1396
1310
|
statusCode: LoggingConfigurationStatusCode | undefined;
|
|
@@ -1422,8 +1336,7 @@ export interface DeleteLoggingConfigurationRequest {
|
|
|
1422
1336
|
*/
|
|
1423
1337
|
workspaceId: string | undefined;
|
|
1424
1338
|
/**
|
|
1425
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1426
|
-
* Case-sensitive.</p>
|
|
1339
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
1427
1340
|
* @public
|
|
1428
1341
|
*/
|
|
1429
1342
|
clientToken?: string | undefined;
|
|
@@ -1440,7 +1353,7 @@ export interface DescribeLoggingConfigurationRequest {
|
|
|
1440
1353
|
workspaceId: string | undefined;
|
|
1441
1354
|
}
|
|
1442
1355
|
/**
|
|
1443
|
-
* <p>Contains information about the logging configuration for the workspace.</p>
|
|
1356
|
+
* <p>Contains information about the current rules and alerting logging configuration for the workspace.</p> <note> <p>These logging configurations are only for rules and alerting logs.</p> </note>
|
|
1444
1357
|
* @public
|
|
1445
1358
|
*/
|
|
1446
1359
|
export interface LoggingConfigurationMetadata {
|
|
@@ -1455,8 +1368,7 @@ export interface LoggingConfigurationMetadata {
|
|
|
1455
1368
|
*/
|
|
1456
1369
|
workspace: string | undefined;
|
|
1457
1370
|
/**
|
|
1458
|
-
* <p>The ARN of the CloudWatch log group to which the vended log data will be
|
|
1459
|
-
* published.</p>
|
|
1371
|
+
* <p>The ARN of the CloudWatch log group to which the vended log data will be published.</p>
|
|
1460
1372
|
* @public
|
|
1461
1373
|
*/
|
|
1462
1374
|
logGroupArn: string | undefined;
|
|
@@ -1493,14 +1405,12 @@ export interface UpdateLoggingConfigurationRequest {
|
|
|
1493
1405
|
*/
|
|
1494
1406
|
workspaceId: string | undefined;
|
|
1495
1407
|
/**
|
|
1496
|
-
* <p>The ARN of the CloudWatch log group to which the vended log data will be
|
|
1497
|
-
* published.</p>
|
|
1408
|
+
* <p>The ARN of the CloudWatch log group to which the vended log data will be published.</p>
|
|
1498
1409
|
* @public
|
|
1499
1410
|
*/
|
|
1500
1411
|
logGroupArn: string | undefined;
|
|
1501
1412
|
/**
|
|
1502
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1503
|
-
* Case-sensitive.</p>
|
|
1413
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
1504
1414
|
* @public
|
|
1505
1415
|
*/
|
|
1506
1416
|
clientToken?: string | undefined;
|
|
@@ -1516,6 +1426,220 @@ export interface UpdateLoggingConfigurationResponse {
|
|
|
1516
1426
|
*/
|
|
1517
1427
|
status: LoggingConfigurationStatus | undefined;
|
|
1518
1428
|
}
|
|
1429
|
+
/**
|
|
1430
|
+
* <p>Configuration details for logging to CloudWatch Logs.</p>
|
|
1431
|
+
* @public
|
|
1432
|
+
*/
|
|
1433
|
+
export interface CloudWatchLogDestination {
|
|
1434
|
+
/**
|
|
1435
|
+
* <p>The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.</p>
|
|
1436
|
+
* @public
|
|
1437
|
+
*/
|
|
1438
|
+
logGroupArn: string | undefined;
|
|
1439
|
+
}
|
|
1440
|
+
/**
|
|
1441
|
+
* <p>Filtering criteria that determine which queries are logged.</p>
|
|
1442
|
+
* @public
|
|
1443
|
+
*/
|
|
1444
|
+
export interface LoggingFilter {
|
|
1445
|
+
/**
|
|
1446
|
+
* <p>The Query Samples Processed (QSP) threshold above which queries will be logged. Queries processing more samples than this threshold will be captured in logs.</p>
|
|
1447
|
+
* @public
|
|
1448
|
+
*/
|
|
1449
|
+
qspThreshold: number | undefined;
|
|
1450
|
+
}
|
|
1451
|
+
/**
|
|
1452
|
+
* <p>Defines a destination and its associated filtering criteria for query logging.</p>
|
|
1453
|
+
* @public
|
|
1454
|
+
*/
|
|
1455
|
+
export interface LoggingDestination {
|
|
1456
|
+
/**
|
|
1457
|
+
* <p>Configuration details for logging to CloudWatch Logs.</p>
|
|
1458
|
+
* @public
|
|
1459
|
+
*/
|
|
1460
|
+
cloudWatchLogs: CloudWatchLogDestination | undefined;
|
|
1461
|
+
/**
|
|
1462
|
+
* <p>Filtering criteria that determine which queries are logged.</p>
|
|
1463
|
+
* @public
|
|
1464
|
+
*/
|
|
1465
|
+
filters: LoggingFilter | undefined;
|
|
1466
|
+
}
|
|
1467
|
+
/**
|
|
1468
|
+
* @public
|
|
1469
|
+
*/
|
|
1470
|
+
export interface CreateQueryLoggingConfigurationRequest {
|
|
1471
|
+
/**
|
|
1472
|
+
* <p>The ID of the workspace for which to create the query logging configuration.</p>
|
|
1473
|
+
* @public
|
|
1474
|
+
*/
|
|
1475
|
+
workspaceId: string | undefined;
|
|
1476
|
+
/**
|
|
1477
|
+
* <p>The destinations where query logs will be sent. Only CloudWatch Logs destination is supported. The list must contain exactly one element.</p>
|
|
1478
|
+
* @public
|
|
1479
|
+
*/
|
|
1480
|
+
destinations: LoggingDestination[] | undefined;
|
|
1481
|
+
/**
|
|
1482
|
+
* <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.</p>
|
|
1483
|
+
* @public
|
|
1484
|
+
*/
|
|
1485
|
+
clientToken?: string | undefined;
|
|
1486
|
+
}
|
|
1487
|
+
/**
|
|
1488
|
+
* @public
|
|
1489
|
+
* @enum
|
|
1490
|
+
*/
|
|
1491
|
+
export declare const QueryLoggingConfigurationStatusCode: {
|
|
1492
|
+
/**
|
|
1493
|
+
* Query logging configuration is active.
|
|
1494
|
+
*/
|
|
1495
|
+
readonly ACTIVE: "ACTIVE";
|
|
1496
|
+
/**
|
|
1497
|
+
* Query logging configuration is being created.
|
|
1498
|
+
*/
|
|
1499
|
+
readonly CREATING: "CREATING";
|
|
1500
|
+
/**
|
|
1501
|
+
* Query logging configuration creation failed.
|
|
1502
|
+
*/
|
|
1503
|
+
readonly CREATION_FAILED: "CREATION_FAILED";
|
|
1504
|
+
/**
|
|
1505
|
+
* Query logging configuration is being deleted.
|
|
1506
|
+
*/
|
|
1507
|
+
readonly DELETING: "DELETING";
|
|
1508
|
+
/**
|
|
1509
|
+
* Query logging configuration update failed.
|
|
1510
|
+
*/
|
|
1511
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
1512
|
+
/**
|
|
1513
|
+
* Query logging configuration is being updated.
|
|
1514
|
+
*/
|
|
1515
|
+
readonly UPDATING: "UPDATING";
|
|
1516
|
+
};
|
|
1517
|
+
/**
|
|
1518
|
+
* @public
|
|
1519
|
+
*/
|
|
1520
|
+
export type QueryLoggingConfigurationStatusCode = (typeof QueryLoggingConfigurationStatusCode)[keyof typeof QueryLoggingConfigurationStatusCode];
|
|
1521
|
+
/**
|
|
1522
|
+
* <p>The status information for a query logging configuration.</p>
|
|
1523
|
+
* @public
|
|
1524
|
+
*/
|
|
1525
|
+
export interface QueryLoggingConfigurationStatus {
|
|
1526
|
+
/**
|
|
1527
|
+
* <p>The current status of the query logging configuration.</p>
|
|
1528
|
+
* @public
|
|
1529
|
+
*/
|
|
1530
|
+
statusCode: QueryLoggingConfigurationStatusCode | undefined;
|
|
1531
|
+
/**
|
|
1532
|
+
* <p>If there is a failure, the reason for the failure.</p>
|
|
1533
|
+
* @public
|
|
1534
|
+
*/
|
|
1535
|
+
statusReason?: string | undefined;
|
|
1536
|
+
}
|
|
1537
|
+
/**
|
|
1538
|
+
* @public
|
|
1539
|
+
*/
|
|
1540
|
+
export interface CreateQueryLoggingConfigurationResponse {
|
|
1541
|
+
/**
|
|
1542
|
+
* <p>The current status of the query logging configuration.</p>
|
|
1543
|
+
* @public
|
|
1544
|
+
*/
|
|
1545
|
+
status: QueryLoggingConfigurationStatus | undefined;
|
|
1546
|
+
}
|
|
1547
|
+
/**
|
|
1548
|
+
* @public
|
|
1549
|
+
*/
|
|
1550
|
+
export interface DeleteQueryLoggingConfigurationRequest {
|
|
1551
|
+
/**
|
|
1552
|
+
* <p>The ID of the workspace from which to delete the query logging configuration.</p>
|
|
1553
|
+
* @public
|
|
1554
|
+
*/
|
|
1555
|
+
workspaceId: string | undefined;
|
|
1556
|
+
/**
|
|
1557
|
+
* <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.</p>
|
|
1558
|
+
* @public
|
|
1559
|
+
*/
|
|
1560
|
+
clientToken?: string | undefined;
|
|
1561
|
+
}
|
|
1562
|
+
/**
|
|
1563
|
+
* @public
|
|
1564
|
+
*/
|
|
1565
|
+
export interface DescribeQueryLoggingConfigurationRequest {
|
|
1566
|
+
/**
|
|
1567
|
+
* <p>The ID of the workspace for which to retrieve the query logging configuration.</p>
|
|
1568
|
+
* @public
|
|
1569
|
+
*/
|
|
1570
|
+
workspaceId: string | undefined;
|
|
1571
|
+
}
|
|
1572
|
+
/**
|
|
1573
|
+
* <p>The metadata for a query logging configuration.</p>
|
|
1574
|
+
* @public
|
|
1575
|
+
*/
|
|
1576
|
+
export interface QueryLoggingConfigurationMetadata {
|
|
1577
|
+
/**
|
|
1578
|
+
* <p>The current status of the query logging configuration.</p>
|
|
1579
|
+
* @public
|
|
1580
|
+
*/
|
|
1581
|
+
status: QueryLoggingConfigurationStatus | undefined;
|
|
1582
|
+
/**
|
|
1583
|
+
* <p>The ID of the workspace associated with this query logging configuration.</p>
|
|
1584
|
+
* @public
|
|
1585
|
+
*/
|
|
1586
|
+
workspace: string | undefined;
|
|
1587
|
+
/**
|
|
1588
|
+
* <p>The configured destinations for the query logging configuration.</p>
|
|
1589
|
+
* @public
|
|
1590
|
+
*/
|
|
1591
|
+
destinations: LoggingDestination[] | undefined;
|
|
1592
|
+
/**
|
|
1593
|
+
* <p>The date and time when the query logging configuration was created.</p>
|
|
1594
|
+
* @public
|
|
1595
|
+
*/
|
|
1596
|
+
createdAt: Date | undefined;
|
|
1597
|
+
/**
|
|
1598
|
+
* <p>The date and time when the query logging configuration was last modified.</p>
|
|
1599
|
+
* @public
|
|
1600
|
+
*/
|
|
1601
|
+
modifiedAt: Date | undefined;
|
|
1602
|
+
}
|
|
1603
|
+
/**
|
|
1604
|
+
* @public
|
|
1605
|
+
*/
|
|
1606
|
+
export interface DescribeQueryLoggingConfigurationResponse {
|
|
1607
|
+
/**
|
|
1608
|
+
* <p>The detailed information about the query logging configuration for the specified workspace.</p>
|
|
1609
|
+
* @public
|
|
1610
|
+
*/
|
|
1611
|
+
queryLoggingConfiguration: QueryLoggingConfigurationMetadata | undefined;
|
|
1612
|
+
}
|
|
1613
|
+
/**
|
|
1614
|
+
* @public
|
|
1615
|
+
*/
|
|
1616
|
+
export interface UpdateQueryLoggingConfigurationRequest {
|
|
1617
|
+
/**
|
|
1618
|
+
* <p>The ID of the workspace for which to update the query logging configuration.</p>
|
|
1619
|
+
* @public
|
|
1620
|
+
*/
|
|
1621
|
+
workspaceId: string | undefined;
|
|
1622
|
+
/**
|
|
1623
|
+
* <p>The destinations where query logs will be sent. Only CloudWatch Logs destination is supported. The list must contain exactly one element.</p>
|
|
1624
|
+
* @public
|
|
1625
|
+
*/
|
|
1626
|
+
destinations: LoggingDestination[] | undefined;
|
|
1627
|
+
/**
|
|
1628
|
+
* <p>(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.</p>
|
|
1629
|
+
* @public
|
|
1630
|
+
*/
|
|
1631
|
+
clientToken?: string | undefined;
|
|
1632
|
+
}
|
|
1633
|
+
/**
|
|
1634
|
+
* @public
|
|
1635
|
+
*/
|
|
1636
|
+
export interface UpdateQueryLoggingConfigurationResponse {
|
|
1637
|
+
/**
|
|
1638
|
+
* <p>The current status of the query logging configuration.</p>
|
|
1639
|
+
* @public
|
|
1640
|
+
*/
|
|
1641
|
+
status: QueryLoggingConfigurationStatus | undefined;
|
|
1642
|
+
}
|
|
1519
1643
|
/**
|
|
1520
1644
|
* <p>Represents the input of a <code>CreateRuleGroupsNamespace</code> operation.</p>
|
|
1521
1645
|
* @public
|
|
@@ -1532,15 +1656,12 @@ export interface CreateRuleGroupsNamespaceRequest {
|
|
|
1532
1656
|
*/
|
|
1533
1657
|
name: string | undefined;
|
|
1534
1658
|
/**
|
|
1535
|
-
* <p>The rules file to use in the new namespace.</p>
|
|
1536
|
-
* <p>Contains the base64-encoded version of the YAML rules file.</p>
|
|
1537
|
-
* <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>
|
|
1659
|
+
* <p>The rules file to use in the new namespace.</p> <p>Contains the base64-encoded version of the YAML rules file.</p> <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>
|
|
1538
1660
|
* @public
|
|
1539
1661
|
*/
|
|
1540
1662
|
data: Uint8Array | undefined;
|
|
1541
1663
|
/**
|
|
1542
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1543
|
-
* Case-sensitive.</p>
|
|
1664
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
1544
1665
|
* @public
|
|
1545
1666
|
*/
|
|
1546
1667
|
clientToken?: string | undefined;
|
|
@@ -1632,8 +1753,7 @@ export interface CreateRuleGroupsNamespaceResponse {
|
|
|
1632
1753
|
*/
|
|
1633
1754
|
export interface DeleteRuleGroupsNamespaceRequest {
|
|
1634
1755
|
/**
|
|
1635
|
-
* <p>The ID of the workspace containing the rule groups namespace and definition to
|
|
1636
|
-
* delete.</p>
|
|
1756
|
+
* <p>The ID of the workspace containing the rule groups namespace and definition to delete.</p>
|
|
1637
1757
|
* @public
|
|
1638
1758
|
*/
|
|
1639
1759
|
workspaceId: string | undefined;
|
|
@@ -1643,8 +1763,7 @@ export interface DeleteRuleGroupsNamespaceRequest {
|
|
|
1643
1763
|
*/
|
|
1644
1764
|
name: string | undefined;
|
|
1645
1765
|
/**
|
|
1646
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1647
|
-
* Case-sensitive.</p>
|
|
1766
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
1648
1767
|
* @public
|
|
1649
1768
|
*/
|
|
1650
1769
|
clientToken?: string | undefined;
|
|
@@ -1671,8 +1790,7 @@ export interface DescribeRuleGroupsNamespaceRequest {
|
|
|
1671
1790
|
*/
|
|
1672
1791
|
export interface RuleGroupsNamespaceDescription {
|
|
1673
1792
|
/**
|
|
1674
|
-
* <p>The ARN of the rule groups namespace. For example,
|
|
1675
|
-
* <code>arn:aws:aps:<region>:123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1</code>.</p>
|
|
1793
|
+
* <p>The ARN of the rule groups namespace. For example, <code>arn:aws:aps:<region>:123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1</code>.</p>
|
|
1676
1794
|
* @public
|
|
1677
1795
|
*/
|
|
1678
1796
|
arn: string | undefined;
|
|
@@ -1687,8 +1805,7 @@ export interface RuleGroupsNamespaceDescription {
|
|
|
1687
1805
|
*/
|
|
1688
1806
|
status: RuleGroupsNamespaceStatus | undefined;
|
|
1689
1807
|
/**
|
|
1690
|
-
* <p>The rule groups file used in the namespace.</p>
|
|
1691
|
-
* <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>
|
|
1808
|
+
* <p>The rule groups file used in the namespace.</p> <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>
|
|
1692
1809
|
* @public
|
|
1693
1810
|
*/
|
|
1694
1811
|
data: Uint8Array | undefined;
|
|
@@ -1703,8 +1820,7 @@ export interface RuleGroupsNamespaceDescription {
|
|
|
1703
1820
|
*/
|
|
1704
1821
|
modifiedAt: Date | undefined;
|
|
1705
1822
|
/**
|
|
1706
|
-
* <p>The list of tag keys and values that are associated with the rule groups
|
|
1707
|
-
* namespace.</p>
|
|
1823
|
+
* <p>The list of tag keys and values that are associated with the rule groups namespace.</p>
|
|
1708
1824
|
* @public
|
|
1709
1825
|
*/
|
|
1710
1826
|
tags?: Record<string, string> | undefined;
|
|
@@ -1731,19 +1847,12 @@ export interface ListRuleGroupsNamespacesRequest {
|
|
|
1731
1847
|
*/
|
|
1732
1848
|
workspaceId: string | undefined;
|
|
1733
1849
|
/**
|
|
1734
|
-
* <p>Use this parameter to filter the rule groups namespaces that are returned. Only the
|
|
1735
|
-
* namespaces with names that begin with the value that you specify are returned.</p>
|
|
1850
|
+
* <p>Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.</p>
|
|
1736
1851
|
* @public
|
|
1737
1852
|
*/
|
|
1738
1853
|
name?: string | undefined;
|
|
1739
1854
|
/**
|
|
1740
|
-
* <p>The token for the next set of items to return. You receive this token from a previous
|
|
1741
|
-
* call, and use it to get the next page of results. The other parameters must be the same
|
|
1742
|
-
* as the initial call.</p>
|
|
1743
|
-
* <p>For example, if your initial request has <code>maxResults</code> of 10, and there are
|
|
1744
|
-
* 12 rule groups namespaces to return, then your initial request will return 10 and a
|
|
1745
|
-
* <code>nextToken</code>. Using the next token in a subsequent call will return the
|
|
1746
|
-
* remaining 2 namespaces.</p>
|
|
1855
|
+
* <p>The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.</p> <p>For example, if your initial request has <code>maxResults</code> of 10, and there are 12 rule groups namespaces to return, then your initial request will return 10 and a <code>nextToken</code>. Using the next token in a subsequent call will return the remaining 2 namespaces.</p>
|
|
1747
1856
|
* @public
|
|
1748
1857
|
*/
|
|
1749
1858
|
nextToken?: string | undefined;
|
|
@@ -1754,8 +1863,7 @@ export interface ListRuleGroupsNamespacesRequest {
|
|
|
1754
1863
|
maxResults?: number | undefined;
|
|
1755
1864
|
}
|
|
1756
1865
|
/**
|
|
1757
|
-
* <p>The high-level information about a rule groups namespace. To retrieve more
|
|
1758
|
-
* information, use <code>DescribeRuleGroupsNamespace</code>.</p>
|
|
1866
|
+
* <p>The high-level information about a rule groups namespace. To retrieve more information, use <code>DescribeRuleGroupsNamespace</code>.</p>
|
|
1759
1867
|
* @public
|
|
1760
1868
|
*/
|
|
1761
1869
|
export interface RuleGroupsNamespaceSummary {
|
|
@@ -1785,8 +1893,7 @@ export interface RuleGroupsNamespaceSummary {
|
|
|
1785
1893
|
*/
|
|
1786
1894
|
modifiedAt: Date | undefined;
|
|
1787
1895
|
/**
|
|
1788
|
-
* <p>The list of tag keys and values that are associated with the rule groups
|
|
1789
|
-
* namespace.</p>
|
|
1896
|
+
* <p>The list of tag keys and values that are associated with the rule groups namespace.</p>
|
|
1790
1897
|
* @public
|
|
1791
1898
|
*/
|
|
1792
1899
|
tags?: Record<string, string> | undefined;
|
|
@@ -1802,9 +1909,7 @@ export interface ListRuleGroupsNamespacesResponse {
|
|
|
1802
1909
|
*/
|
|
1803
1910
|
ruleGroupsNamespaces: RuleGroupsNamespaceSummary[] | undefined;
|
|
1804
1911
|
/**
|
|
1805
|
-
* <p>A token indicating that there are more results to retrieve. You can use this token as
|
|
1806
|
-
* part of your next <code>ListRuleGroupsNamespaces</code> request to retrieve those
|
|
1807
|
-
* results.</p>
|
|
1912
|
+
* <p>A token indicating that there are more results to retrieve. You can use this token as part of your next <code>ListRuleGroupsNamespaces</code> request to retrieve those results.</p>
|
|
1808
1913
|
* @public
|
|
1809
1914
|
*/
|
|
1810
1915
|
nextToken?: string | undefined;
|
|
@@ -1825,15 +1930,12 @@ export interface PutRuleGroupsNamespaceRequest {
|
|
|
1825
1930
|
*/
|
|
1826
1931
|
name: string | undefined;
|
|
1827
1932
|
/**
|
|
1828
|
-
* <p>The new rules file to use in the namespace. A base64-encoded version of the YAML rule
|
|
1829
|
-
* groups file.</p>
|
|
1830
|
-
* <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>
|
|
1933
|
+
* <p>The new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file.</p> <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>
|
|
1831
1934
|
* @public
|
|
1832
1935
|
*/
|
|
1833
1936
|
data: Uint8Array | undefined;
|
|
1834
1937
|
/**
|
|
1835
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1836
|
-
* Case-sensitive.</p>
|
|
1938
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
1837
1939
|
* @public
|
|
1838
1940
|
*/
|
|
1839
1941
|
clientToken?: string | undefined;
|
|
@@ -1875,15 +1977,12 @@ export interface UpdateWorkspaceAliasRequest {
|
|
|
1875
1977
|
*/
|
|
1876
1978
|
workspaceId: string | undefined;
|
|
1877
1979
|
/**
|
|
1878
|
-
* <p>The new alias for the workspace. It does not need to be unique.</p>
|
|
1879
|
-
* <p>Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning
|
|
1880
|
-
* and end of the alias that you specify.</p>
|
|
1980
|
+
* <p>The new alias for the workspace. It does not need to be unique.</p> <p>Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.</p>
|
|
1881
1981
|
* @public
|
|
1882
1982
|
*/
|
|
1883
1983
|
alias?: string | undefined;
|
|
1884
1984
|
/**
|
|
1885
|
-
* <p>A unique identifier that you can provide to ensure the idempotency of the request.
|
|
1886
|
-
* Case-sensitive.</p>
|
|
1985
|
+
* <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
|
|
1887
1986
|
* @public
|
|
1888
1987
|
*/
|
|
1889
1988
|
clientToken?: string | undefined;
|
|
@@ -1893,8 +1992,7 @@ export interface UpdateWorkspaceAliasRequest {
|
|
|
1893
1992
|
*/
|
|
1894
1993
|
export interface DescribeWorkspaceConfigurationRequest {
|
|
1895
1994
|
/**
|
|
1896
|
-
* <p>The ID of the workspace that you want to retrieve information for. To find the IDs of your workspaces, use
|
|
1897
|
-
* the <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/API_ListWorkspaces.htm">ListWorkspaces</a> operation.</p>
|
|
1995
|
+
* <p>The ID of the workspace that you want to retrieve information for. To find the IDs of your workspaces, use the <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/API_ListWorkspaces.htm">ListWorkspaces</a> operation.</p>
|
|
1898
1996
|
* @public
|
|
1899
1997
|
*/
|
|
1900
1998
|
workspaceId: string | undefined;
|
|
@@ -1905,18 +2003,13 @@ export interface DescribeWorkspaceConfigurationRequest {
|
|
|
1905
2003
|
*/
|
|
1906
2004
|
export interface LimitsPerLabelSetEntry {
|
|
1907
2005
|
/**
|
|
1908
|
-
* <p>The maximum number of active series that can be ingested that match this label set. </p>
|
|
1909
|
-
* <p>Setting this to 0 causes no label set limit to be enforced, but it does cause Amazon Managed Service for Prometheus to vend label set metrics to CloudWatch</p>
|
|
2006
|
+
* <p>The maximum number of active series that can be ingested that match this label set. </p> <p>Setting this to 0 causes no label set limit to be enforced, but it does cause Amazon Managed Service for Prometheus to vend label set metrics to CloudWatch</p>
|
|
1910
2007
|
* @public
|
|
1911
2008
|
*/
|
|
1912
2009
|
maxSeries?: number | undefined;
|
|
1913
2010
|
}
|
|
1914
2011
|
/**
|
|
1915
|
-
* <p>This structure defines one label set used to enforce
|
|
1916
|
-
* <p>A label set is
|
|
1917
|
-
* a unique combination of label-value pairs. Use them to control time series ingestion limits and to monitor usage by specific label groups.
|
|
1918
|
-
* Example label sets might be <code>team:finance</code> or <code>env:prod</code>
|
|
1919
|
-
* </p>
|
|
2012
|
+
* <p>This structure defines one label set used to enforce active time series limits for the workspace, and defines the limit for that label set.</p> <p>A label set is a unique combination of label-value pairs. Use them to control time series limits and to monitor usage by specific label groups. Example label sets might be <code>team:finance</code> or <code>env:prod</code> </p>
|
|
1920
2013
|
* @public
|
|
1921
2014
|
*/
|
|
1922
2015
|
export interface LimitsPerLabelSet {
|
|
@@ -1926,11 +2019,7 @@ export interface LimitsPerLabelSet {
|
|
|
1926
2019
|
*/
|
|
1927
2020
|
limits: LimitsPerLabelSetEntry | undefined;
|
|
1928
2021
|
/**
|
|
1929
|
-
* <p>This defines one label set that will have an enforced
|
|
1930
|
-
* <p>Label values accept ASCII characters and must contain at least one character that isn't whitespace. ASCII control characters are not accepted.
|
|
1931
|
-
* If the label name is metric name label <code>__<i>name</i>__</code>, then the <i>metric</i> part of the name
|
|
1932
|
-
* must conform to the following pattern: <code>[a-zA-Z_:][a-zA-Z0-9_:]*</code>
|
|
1933
|
-
* </p>
|
|
2022
|
+
* <p>This defines one label set that will have an enforced active time series limit. </p> <p>Label values accept ASCII characters and must contain at least one character that isn't whitespace. ASCII control characters are not accepted. If the label name is metric name label <code>__<i>name</i>__</code>, then the <i>metric</i> part of the name must conform to the following pattern: <code>[a-zA-Z_:][a-zA-Z0-9_:]*</code> </p>
|
|
1934
2023
|
* @public
|
|
1935
2024
|
*/
|
|
1936
2025
|
labelSet: Record<string, string> | undefined;
|
|
@@ -2009,8 +2098,7 @@ export interface DescribeWorkspaceConfigurationResponse {
|
|
|
2009
2098
|
*/
|
|
2010
2099
|
export interface UpdateWorkspaceConfigurationRequest {
|
|
2011
2100
|
/**
|
|
2012
|
-
* <p>The ID of the workspace that you want to update. To find the IDs of your workspaces, use
|
|
2013
|
-
* the <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/API_ListWorkspaces.htm">ListWorkspaces</a> operation.</p>
|
|
2101
|
+
* <p>The ID of the workspace that you want to update. To find the IDs of your workspaces, use the <a href="https://docs.aws.amazon.com/prometheus/latest/APIReference/API_ListWorkspaces.htm">ListWorkspaces</a> operation.</p>
|
|
2014
2102
|
* @public
|
|
2015
2103
|
*/
|
|
2016
2104
|
workspaceId: string | undefined;
|
|
@@ -2020,8 +2108,7 @@ export interface UpdateWorkspaceConfigurationRequest {
|
|
|
2020
2108
|
*/
|
|
2021
2109
|
clientToken?: string | undefined;
|
|
2022
2110
|
/**
|
|
2023
|
-
* <p>This is an array of structures, where each structure defines a label set for the workspace, and
|
|
2024
|
-
* defines the ingestion limit for active time series for each of those label sets. Each label name in a label set must be unique.</p>
|
|
2111
|
+
* <p>This is an array of structures, where each structure defines a label set for the workspace, and defines the active time series limit for each of those label sets. Each label name in a label set must be unique.</p>
|
|
2025
2112
|
* @public
|
|
2026
2113
|
*/
|
|
2027
2114
|
limitsPerLabelSet?: LimitsPerLabelSet[] | undefined;
|