@aws-sdk/client-pi 3.379.1 → 3.385.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.
|
@@ -6,10 +6,12 @@ import { PIServiceException as __BaseException } from "./PIServiceException";
|
|
|
6
6
|
*/
|
|
7
7
|
export interface DataPoint {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>The time, in epoch format, associated with a particular <code>Value</code>.</p>
|
|
10
11
|
*/
|
|
11
12
|
Timestamp: Date | undefined;
|
|
12
13
|
/**
|
|
14
|
+
* @public
|
|
13
15
|
* <p>The actual value associated with a particular <code>Timestamp</code>.</p>
|
|
14
16
|
*/
|
|
15
17
|
Value: number | undefined;
|
|
@@ -45,6 +47,7 @@ export interface DataPoint {
|
|
|
45
47
|
*/
|
|
46
48
|
export interface DimensionGroup {
|
|
47
49
|
/**
|
|
50
|
+
* @public
|
|
48
51
|
* <p>The name of the dimension group. Valid values are as follows:</p>
|
|
49
52
|
* <ul>
|
|
50
53
|
* <li>
|
|
@@ -131,6 +134,7 @@ export interface DimensionGroup {
|
|
|
131
134
|
*/
|
|
132
135
|
Group: string | undefined;
|
|
133
136
|
/**
|
|
137
|
+
* @public
|
|
134
138
|
* <p>A list of specific dimensions from a dimension group. If this parameter is not present,
|
|
135
139
|
* then it signifies that all of the dimensions in the group were requested, or are present in
|
|
136
140
|
* the response.</p>
|
|
@@ -280,6 +284,7 @@ export interface DimensionGroup {
|
|
|
280
284
|
*/
|
|
281
285
|
Dimensions?: string[];
|
|
282
286
|
/**
|
|
287
|
+
* @public
|
|
283
288
|
* <p>The maximum number of items to fetch for this dimension group.</p>
|
|
284
289
|
*/
|
|
285
290
|
Limit?: number;
|
|
@@ -301,6 +306,7 @@ export type ServiceType = (typeof ServiceType)[keyof typeof ServiceType];
|
|
|
301
306
|
*/
|
|
302
307
|
export interface DescribeDimensionKeysRequest {
|
|
303
308
|
/**
|
|
309
|
+
* @public
|
|
304
310
|
* <p>The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:</p>
|
|
305
311
|
* <ul>
|
|
306
312
|
* <li>
|
|
@@ -317,6 +323,7 @@ export interface DescribeDimensionKeysRequest {
|
|
|
317
323
|
*/
|
|
318
324
|
ServiceType: ServiceType | string | undefined;
|
|
319
325
|
/**
|
|
326
|
+
* @public
|
|
320
327
|
* <p>An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from
|
|
321
328
|
* this data source.</p>
|
|
322
329
|
* <p>To use an Amazon RDS instance as a data source, you specify its <code>DbiResourceId</code> value.
|
|
@@ -325,6 +332,7 @@ export interface DescribeDimensionKeysRequest {
|
|
|
325
332
|
*/
|
|
326
333
|
Identifier: string | undefined;
|
|
327
334
|
/**
|
|
335
|
+
* @public
|
|
328
336
|
* <p>The date and time specifying the beginning of the requested time series data. You must specify a
|
|
329
337
|
* <code>StartTime</code> within the past 7 days. The value specified is <i>inclusive</i>,
|
|
330
338
|
* which means that data points equal to or greater than <code>StartTime</code> are returned.
|
|
@@ -334,6 +342,7 @@ export interface DescribeDimensionKeysRequest {
|
|
|
334
342
|
*/
|
|
335
343
|
StartTime: Date | undefined;
|
|
336
344
|
/**
|
|
345
|
+
* @public
|
|
337
346
|
* <p>The date and time specifying the end of the requested time series data. The value specified is
|
|
338
347
|
* <i>exclusive</i>, which means that data points less than (but not equal to) <code>EndTime</code> are
|
|
339
348
|
* returned.</p>
|
|
@@ -341,6 +350,7 @@ export interface DescribeDimensionKeysRequest {
|
|
|
341
350
|
*/
|
|
342
351
|
EndTime: Date | undefined;
|
|
343
352
|
/**
|
|
353
|
+
* @public
|
|
344
354
|
* <p>The name of a Performance Insights metric to be measured.</p>
|
|
345
355
|
* <p>Valid values for <code>Metric</code> are:</p>
|
|
346
356
|
* <ul>
|
|
@@ -363,6 +373,7 @@ export interface DescribeDimensionKeysRequest {
|
|
|
363
373
|
*/
|
|
364
374
|
Metric: string | undefined;
|
|
365
375
|
/**
|
|
376
|
+
* @public
|
|
366
377
|
* <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as
|
|
367
378
|
* one second, or as long as one day (86400 seconds). Valid values are:
|
|
368
379
|
* </p>
|
|
@@ -394,24 +405,28 @@ export interface DescribeDimensionKeysRequest {
|
|
|
394
405
|
*/
|
|
395
406
|
PeriodInSeconds?: number;
|
|
396
407
|
/**
|
|
408
|
+
* @public
|
|
397
409
|
* <p>A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all
|
|
398
410
|
* dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return
|
|
399
411
|
* a limited number of values for a dimension. </p>
|
|
400
412
|
*/
|
|
401
413
|
GroupBy: DimensionGroup | undefined;
|
|
402
414
|
/**
|
|
415
|
+
* @public
|
|
403
416
|
* <p>Additional metrics for the top <code>N</code> dimension keys. If the specified dimension group in the <code>GroupBy</code> parameter is
|
|
404
417
|
* <code>db.sql_tokenized</code>, you can specify per-SQL metrics to get the values for the top <code>N</code> SQL digests. The response
|
|
405
418
|
* syntax is as follows: <code>"AdditionalMetrics" : \{ "<i>string</i>" : "<i>string</i>" \}</code>. </p>
|
|
406
419
|
*/
|
|
407
420
|
AdditionalMetrics?: string[];
|
|
408
421
|
/**
|
|
422
|
+
* @public
|
|
409
423
|
* <p>For each dimension specified in <code>GroupBy</code>, specify a secondary dimension
|
|
410
424
|
* to further subdivide the partition keys in the response.
|
|
411
425
|
* </p>
|
|
412
426
|
*/
|
|
413
427
|
PartitionBy?: DimensionGroup;
|
|
414
428
|
/**
|
|
429
|
+
* @public
|
|
415
430
|
* <p>One or more filters to apply in the request. Restrictions:</p>
|
|
416
431
|
* <ul>
|
|
417
432
|
* <li>
|
|
@@ -425,11 +440,13 @@ export interface DescribeDimensionKeysRequest {
|
|
|
425
440
|
*/
|
|
426
441
|
Filter?: Record<string, string>;
|
|
427
442
|
/**
|
|
443
|
+
* @public
|
|
428
444
|
* <p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a
|
|
429
445
|
* pagination token is included in the response so that the remaining results can be retrieved. </p>
|
|
430
446
|
*/
|
|
431
447
|
MaxResults?: number;
|
|
432
448
|
/**
|
|
449
|
+
* @public
|
|
433
450
|
* <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond
|
|
434
451
|
* the token, up to the value specified by <code>MaxRecords</code>.</p>
|
|
435
452
|
*/
|
|
@@ -442,18 +459,22 @@ export interface DescribeDimensionKeysRequest {
|
|
|
442
459
|
*/
|
|
443
460
|
export interface DimensionKeyDescription {
|
|
444
461
|
/**
|
|
462
|
+
* @public
|
|
445
463
|
* <p>A map of name-value pairs for the dimensions in the group.</p>
|
|
446
464
|
*/
|
|
447
465
|
Dimensions?: Record<string, string>;
|
|
448
466
|
/**
|
|
467
|
+
* @public
|
|
449
468
|
* <p>The aggregated metric value for the dimensions, over the requested time range.</p>
|
|
450
469
|
*/
|
|
451
470
|
Total?: number;
|
|
452
471
|
/**
|
|
472
|
+
* @public
|
|
453
473
|
* <p>A map that contains the value for each additional metric.</p>
|
|
454
474
|
*/
|
|
455
475
|
AdditionalMetrics?: Record<string, number>;
|
|
456
476
|
/**
|
|
477
|
+
* @public
|
|
457
478
|
* <p>If <code>PartitionBy</code> was specified, <code>PartitionKeys</code> contains the dimensions that were.</p>
|
|
458
479
|
*/
|
|
459
480
|
Partitions?: number[];
|
|
@@ -466,6 +487,7 @@ export interface DimensionKeyDescription {
|
|
|
466
487
|
*/
|
|
467
488
|
export interface ResponsePartitionKey {
|
|
468
489
|
/**
|
|
490
|
+
* @public
|
|
469
491
|
* <p>A dimension map that contains the dimensions for this partition.</p>
|
|
470
492
|
*/
|
|
471
493
|
Dimensions: Record<string, string> | undefined;
|
|
@@ -475,25 +497,30 @@ export interface ResponsePartitionKey {
|
|
|
475
497
|
*/
|
|
476
498
|
export interface DescribeDimensionKeysResponse {
|
|
477
499
|
/**
|
|
500
|
+
* @public
|
|
478
501
|
* <p>The start time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
|
|
479
502
|
* <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>. </p>
|
|
480
503
|
*/
|
|
481
504
|
AlignedStartTime?: Date;
|
|
482
505
|
/**
|
|
506
|
+
* @public
|
|
483
507
|
* <p>The end time for the returned dimension keys, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
|
|
484
508
|
* <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>. </p>
|
|
485
509
|
*/
|
|
486
510
|
AlignedEndTime?: Date;
|
|
487
511
|
/**
|
|
512
|
+
* @public
|
|
488
513
|
* <p>If <code>PartitionBy</code> was present in the request, <code>PartitionKeys</code> contains the breakdown of dimension keys by the
|
|
489
514
|
* specified partitions. </p>
|
|
490
515
|
*/
|
|
491
516
|
PartitionKeys?: ResponsePartitionKey[];
|
|
492
517
|
/**
|
|
518
|
+
* @public
|
|
493
519
|
* <p>The dimension keys that were requested.</p>
|
|
494
520
|
*/
|
|
495
521
|
Keys?: DimensionKeyDescription[];
|
|
496
522
|
/**
|
|
523
|
+
* @public
|
|
497
524
|
* <p>A pagination token that indicates the response didn’t return all available records because <code>MaxRecords</code> was specified in the
|
|
498
525
|
* previous request. To get the remaining records, specify <code>NextToken</code> in a separate request with this value. </p>
|
|
499
526
|
*/
|
|
@@ -557,6 +584,7 @@ export type DetailStatus = (typeof DetailStatus)[keyof typeof DetailStatus];
|
|
|
557
584
|
*/
|
|
558
585
|
export interface DimensionDetail {
|
|
559
586
|
/**
|
|
587
|
+
* @public
|
|
560
588
|
* <p>The identifier of a dimension.</p>
|
|
561
589
|
*/
|
|
562
590
|
Identifier?: string;
|
|
@@ -567,10 +595,12 @@ export interface DimensionDetail {
|
|
|
567
595
|
*/
|
|
568
596
|
export interface DimensionGroupDetail {
|
|
569
597
|
/**
|
|
598
|
+
* @public
|
|
570
599
|
* <p>The name of the dimension group.</p>
|
|
571
600
|
*/
|
|
572
601
|
Group?: string;
|
|
573
602
|
/**
|
|
603
|
+
* @public
|
|
574
604
|
* <p>The dimensions within a dimension group.</p>
|
|
575
605
|
*/
|
|
576
606
|
Dimensions?: DimensionDetail[];
|
|
@@ -581,6 +611,7 @@ export interface DimensionGroupDetail {
|
|
|
581
611
|
*/
|
|
582
612
|
export interface DimensionKeyDetail {
|
|
583
613
|
/**
|
|
614
|
+
* @public
|
|
584
615
|
* <p>The value of the dimension detail data. Depending on the return status, this value is either the
|
|
585
616
|
* full or truncated SQL query for the following dimensions:</p>
|
|
586
617
|
* <ul>
|
|
@@ -596,6 +627,7 @@ export interface DimensionKeyDetail {
|
|
|
596
627
|
*/
|
|
597
628
|
Value?: string;
|
|
598
629
|
/**
|
|
630
|
+
* @public
|
|
599
631
|
* <p>The full name of the dimension. The full name includes the group name and key name. The following values are valid:</p>
|
|
600
632
|
* <ul>
|
|
601
633
|
* <li>
|
|
@@ -610,6 +642,7 @@ export interface DimensionKeyDetail {
|
|
|
610
642
|
*/
|
|
611
643
|
Dimension?: string;
|
|
612
644
|
/**
|
|
645
|
+
* @public
|
|
613
646
|
* <p>The status of the dimension detail data. Possible values include the following:</p>
|
|
614
647
|
* <ul>
|
|
615
648
|
* <li>
|
|
@@ -652,6 +685,7 @@ export type FeatureStatus = (typeof FeatureStatus)[keyof typeof FeatureStatus];
|
|
|
652
685
|
*/
|
|
653
686
|
export interface FeatureMetadata {
|
|
654
687
|
/**
|
|
688
|
+
* @public
|
|
655
689
|
* <p>The status of the feature on the DB instance. Possible values include the following:</p>
|
|
656
690
|
* <ul>
|
|
657
691
|
* <li>
|
|
@@ -687,10 +721,12 @@ export interface FeatureMetadata {
|
|
|
687
721
|
*/
|
|
688
722
|
export interface GetDimensionKeyDetailsRequest {
|
|
689
723
|
/**
|
|
724
|
+
* @public
|
|
690
725
|
* <p>The Amazon Web Services service for which Performance Insights returns data. The only valid value is <code>RDS</code>.</p>
|
|
691
726
|
*/
|
|
692
727
|
ServiceType: ServiceType | string | undefined;
|
|
693
728
|
/**
|
|
729
|
+
* @public
|
|
694
730
|
* <p>The ID for a data source from which to gather dimension data. This ID must be immutable and
|
|
695
731
|
* unique within an Amazon Web Services Region. When a DB instance is the data source, specify its
|
|
696
732
|
* <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.
|
|
@@ -698,6 +734,7 @@ export interface GetDimensionKeyDetailsRequest {
|
|
|
698
734
|
*/
|
|
699
735
|
Identifier: string | undefined;
|
|
700
736
|
/**
|
|
737
|
+
* @public
|
|
701
738
|
* <p>The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are
|
|
702
739
|
* valid:</p>
|
|
703
740
|
* <ul>
|
|
@@ -713,6 +750,7 @@ export interface GetDimensionKeyDetailsRequest {
|
|
|
713
750
|
*/
|
|
714
751
|
Group: string | undefined;
|
|
715
752
|
/**
|
|
753
|
+
* @public
|
|
716
754
|
* <p>The ID of the dimension group from which to retrieve dimension details. For dimension group <code>db.sql</code>, the group ID is
|
|
717
755
|
* <code>db.sql.id</code>. The following group ID values are valid:</p>
|
|
718
756
|
* <ul>
|
|
@@ -728,6 +766,7 @@ export interface GetDimensionKeyDetailsRequest {
|
|
|
728
766
|
*/
|
|
729
767
|
GroupIdentifier: string | undefined;
|
|
730
768
|
/**
|
|
769
|
+
* @public
|
|
731
770
|
* <p>A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns
|
|
732
771
|
* all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:</p>
|
|
733
772
|
* <ul>
|
|
@@ -750,6 +789,7 @@ export interface GetDimensionKeyDetailsRequest {
|
|
|
750
789
|
*/
|
|
751
790
|
export interface GetDimensionKeyDetailsResponse {
|
|
752
791
|
/**
|
|
792
|
+
* @public
|
|
753
793
|
* <p>The details for the requested dimensions.</p>
|
|
754
794
|
*/
|
|
755
795
|
Dimensions?: DimensionKeyDetail[];
|
|
@@ -759,10 +799,12 @@ export interface GetDimensionKeyDetailsResponse {
|
|
|
759
799
|
*/
|
|
760
800
|
export interface GetResourceMetadataRequest {
|
|
761
801
|
/**
|
|
802
|
+
* @public
|
|
762
803
|
* <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
|
|
763
804
|
*/
|
|
764
805
|
ServiceType: ServiceType | string | undefined;
|
|
765
806
|
/**
|
|
807
|
+
* @public
|
|
766
808
|
* <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region.
|
|
767
809
|
* Performance Insights gathers metrics from this data source. To use a DB instance as a data source,
|
|
768
810
|
* specify its <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VW2X</code>.
|
|
@@ -775,6 +817,7 @@ export interface GetResourceMetadataRequest {
|
|
|
775
817
|
*/
|
|
776
818
|
export interface GetResourceMetadataResponse {
|
|
777
819
|
/**
|
|
820
|
+
* @public
|
|
778
821
|
* <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region.
|
|
779
822
|
*
|
|
780
823
|
* Performance Insights gathers metrics from this data source. To use a DB instance as a data source,
|
|
@@ -783,6 +826,7 @@ export interface GetResourceMetadataResponse {
|
|
|
783
826
|
*/
|
|
784
827
|
Identifier?: string;
|
|
785
828
|
/**
|
|
829
|
+
* @public
|
|
786
830
|
* <p>The metadata for different features. For example, the metadata might indicate that a feature is
|
|
787
831
|
* turned on or off on a specific DB instance.</p>
|
|
788
832
|
*/
|
|
@@ -797,6 +841,7 @@ export interface GetResourceMetadataResponse {
|
|
|
797
841
|
*/
|
|
798
842
|
export interface MetricQuery {
|
|
799
843
|
/**
|
|
844
|
+
* @public
|
|
800
845
|
* <p>The name of a Performance Insights metric to be measured.</p>
|
|
801
846
|
* <p>Valid values for <code>Metric</code> are:</p>
|
|
802
847
|
* <ul>
|
|
@@ -821,6 +866,7 @@ export interface MetricQuery {
|
|
|
821
866
|
*/
|
|
822
867
|
Metric: string | undefined;
|
|
823
868
|
/**
|
|
869
|
+
* @public
|
|
824
870
|
* <p>A specification for how to aggregate the data points from a query result. You must
|
|
825
871
|
* specify a valid dimension group. Performance Insights will return all of the dimensions within that group,
|
|
826
872
|
* unless you provide the names of specific dimensions within that group. You can also request
|
|
@@ -828,6 +874,7 @@ export interface MetricQuery {
|
|
|
828
874
|
*/
|
|
829
875
|
GroupBy?: DimensionGroup;
|
|
830
876
|
/**
|
|
877
|
+
* @public
|
|
831
878
|
* <p>One or more filters to apply in the request. Restrictions:</p>
|
|
832
879
|
* <ul>
|
|
833
880
|
* <li>
|
|
@@ -857,6 +904,7 @@ export type PeriodAlignment = (typeof PeriodAlignment)[keyof typeof PeriodAlignm
|
|
|
857
904
|
*/
|
|
858
905
|
export interface GetResourceMetricsRequest {
|
|
859
906
|
/**
|
|
907
|
+
* @public
|
|
860
908
|
* <p>The Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:</p>
|
|
861
909
|
* <ul>
|
|
862
910
|
* <li>
|
|
@@ -873,6 +921,7 @@ export interface GetResourceMetricsRequest {
|
|
|
873
921
|
*/
|
|
874
922
|
ServiceType: ServiceType | string | undefined;
|
|
875
923
|
/**
|
|
924
|
+
* @public
|
|
876
925
|
* <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the
|
|
877
926
|
* console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is
|
|
878
927
|
* returned as <code>DbiResourceId</code>.</p>
|
|
@@ -881,11 +930,13 @@ export interface GetResourceMetricsRequest {
|
|
|
881
930
|
*/
|
|
882
931
|
Identifier: string | undefined;
|
|
883
932
|
/**
|
|
933
|
+
* @public
|
|
884
934
|
* <p>An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering
|
|
885
935
|
* criteria.</p>
|
|
886
936
|
*/
|
|
887
937
|
MetricQueries: MetricQuery[] | undefined;
|
|
888
938
|
/**
|
|
939
|
+
* @public
|
|
889
940
|
* <p>The date and time specifying the beginning of the requested time series query range. You can't
|
|
890
941
|
* specify a <code>StartTime</code> that is earlier than 7 days ago. By default, Performance Insights has 7 days of
|
|
891
942
|
* retention, but you can extend this range up to 2 years. The value specified is
|
|
@@ -895,6 +946,7 @@ export interface GetResourceMetricsRequest {
|
|
|
895
946
|
*/
|
|
896
947
|
StartTime: Date | undefined;
|
|
897
948
|
/**
|
|
949
|
+
* @public
|
|
898
950
|
* <p>The date and time specifying the end of the requested time series query range. The value
|
|
899
951
|
* specified is <i>exclusive</i>. Thus, the command returns data points less than
|
|
900
952
|
* (but not equal to) <code>EndTime</code>.</p>
|
|
@@ -902,6 +954,7 @@ export interface GetResourceMetricsRequest {
|
|
|
902
954
|
*/
|
|
903
955
|
EndTime: Date | undefined;
|
|
904
956
|
/**
|
|
957
|
+
* @public
|
|
905
958
|
* <p>The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400
|
|
906
959
|
* seconds). Valid values are:</p>
|
|
907
960
|
* <ul>
|
|
@@ -931,16 +984,19 @@ export interface GetResourceMetricsRequest {
|
|
|
931
984
|
*/
|
|
932
985
|
PeriodInSeconds?: number;
|
|
933
986
|
/**
|
|
987
|
+
* @public
|
|
934
988
|
* <p>The maximum number of items to return in the response. If more items exist than the specified <code>MaxRecords</code> value, a
|
|
935
989
|
* pagination token is included in the response so that the remaining results can be retrieved. </p>
|
|
936
990
|
*/
|
|
937
991
|
MaxResults?: number;
|
|
938
992
|
/**
|
|
993
|
+
* @public
|
|
939
994
|
* <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond
|
|
940
995
|
* the token, up to the value specified by <code>MaxRecords</code>.</p>
|
|
941
996
|
*/
|
|
942
997
|
NextToken?: string;
|
|
943
998
|
/**
|
|
999
|
+
* @public
|
|
944
1000
|
* <p>The returned timestamp which is the start or end time of the time periods. The default value is <code>END_TIME</code>.</p>
|
|
945
1001
|
*/
|
|
946
1002
|
PeriodAlignment?: PeriodAlignment | string;
|
|
@@ -951,6 +1007,7 @@ export interface GetResourceMetricsRequest {
|
|
|
951
1007
|
*/
|
|
952
1008
|
export interface ResponseResourceMetricKey {
|
|
953
1009
|
/**
|
|
1010
|
+
* @public
|
|
954
1011
|
* <p>The name of a Performance Insights metric to be measured.</p>
|
|
955
1012
|
* <p>Valid values for <code>Metric</code> are:</p>
|
|
956
1013
|
* <ul>
|
|
@@ -976,6 +1033,7 @@ export interface ResponseResourceMetricKey {
|
|
|
976
1033
|
*/
|
|
977
1034
|
Metric: string | undefined;
|
|
978
1035
|
/**
|
|
1036
|
+
* @public
|
|
979
1037
|
* <p>The valid dimensions for the metric.</p>
|
|
980
1038
|
*/
|
|
981
1039
|
Dimensions?: Record<string, string>;
|
|
@@ -987,10 +1045,12 @@ export interface ResponseResourceMetricKey {
|
|
|
987
1045
|
*/
|
|
988
1046
|
export interface MetricKeyDataPoints {
|
|
989
1047
|
/**
|
|
1048
|
+
* @public
|
|
990
1049
|
* <p>The dimensions to which the data points apply.</p>
|
|
991
1050
|
*/
|
|
992
1051
|
Key?: ResponseResourceMetricKey;
|
|
993
1052
|
/**
|
|
1053
|
+
* @public
|
|
994
1054
|
* <p>An array of timestamp-value pairs, representing measurements over a period of time.</p>
|
|
995
1055
|
*/
|
|
996
1056
|
DataPoints?: DataPoint[];
|
|
@@ -1000,27 +1060,32 @@ export interface MetricKeyDataPoints {
|
|
|
1000
1060
|
*/
|
|
1001
1061
|
export interface GetResourceMetricsResponse {
|
|
1002
1062
|
/**
|
|
1063
|
+
* @public
|
|
1003
1064
|
* <p>The start time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
|
|
1004
1065
|
* <code>AlignedStartTime</code> will be less than or equal to the value of the user-specified <code>StartTime</code>.</p>
|
|
1005
1066
|
*/
|
|
1006
1067
|
AlignedStartTime?: Date;
|
|
1007
1068
|
/**
|
|
1069
|
+
* @public
|
|
1008
1070
|
* <p>The end time for the returned metrics, after alignment to a granular boundary (as specified by <code>PeriodInSeconds</code>).
|
|
1009
1071
|
* <code>AlignedEndTime</code> will be greater than or equal to the value of the user-specified <code>Endtime</code>.</p>
|
|
1010
1072
|
*/
|
|
1011
1073
|
AlignedEndTime?: Date;
|
|
1012
1074
|
/**
|
|
1075
|
+
* @public
|
|
1013
1076
|
* <p>An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the
|
|
1014
1077
|
* console, the identifier is shown as <i>ResourceID</i>. When you call <code>DescribeDBInstances</code>, the identifier is
|
|
1015
1078
|
* returned as <code>DbiResourceId</code>.</p>
|
|
1016
1079
|
*/
|
|
1017
1080
|
Identifier?: string;
|
|
1018
1081
|
/**
|
|
1082
|
+
* @public
|
|
1019
1083
|
* <p>An array of metric results, where each array element contains all of the data points for a
|
|
1020
1084
|
* particular dimension.</p>
|
|
1021
1085
|
*/
|
|
1022
1086
|
MetricList?: MetricKeyDataPoints[];
|
|
1023
1087
|
/**
|
|
1088
|
+
* @public
|
|
1024
1089
|
* <p>An optional pagination token provided by a previous request. If this parameter is specified,
|
|
1025
1090
|
* the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
|
|
1026
1091
|
* </p>
|
|
@@ -1032,26 +1097,31 @@ export interface GetResourceMetricsResponse {
|
|
|
1032
1097
|
*/
|
|
1033
1098
|
export interface ListAvailableResourceDimensionsRequest {
|
|
1034
1099
|
/**
|
|
1100
|
+
* @public
|
|
1035
1101
|
* <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
|
|
1036
1102
|
*/
|
|
1037
1103
|
ServiceType: ServiceType | string | undefined;
|
|
1038
1104
|
/**
|
|
1105
|
+
* @public
|
|
1039
1106
|
* <p>An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers
|
|
1040
1107
|
* metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its
|
|
1041
1108
|
* <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>. </p>
|
|
1042
1109
|
*/
|
|
1043
1110
|
Identifier: string | undefined;
|
|
1044
1111
|
/**
|
|
1112
|
+
* @public
|
|
1045
1113
|
* <p>The types of metrics for which to retrieve dimensions. Valid values include <code>db.load</code>.</p>
|
|
1046
1114
|
*/
|
|
1047
1115
|
Metrics: string[] | undefined;
|
|
1048
1116
|
/**
|
|
1117
|
+
* @public
|
|
1049
1118
|
* <p>The maximum number of items to return in the response. If more items exist than the specified
|
|
1050
1119
|
* <code>MaxRecords</code> value, a pagination token is included in the response so that the remaining
|
|
1051
1120
|
* results can be retrieved.</p>
|
|
1052
1121
|
*/
|
|
1053
1122
|
MaxResults?: number;
|
|
1054
1123
|
/**
|
|
1124
|
+
* @public
|
|
1055
1125
|
* <p>An optional pagination token provided by a previous request. If this parameter is specified,
|
|
1056
1126
|
* the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
|
|
1057
1127
|
* </p>
|
|
@@ -1064,10 +1134,12 @@ export interface ListAvailableResourceDimensionsRequest {
|
|
|
1064
1134
|
*/
|
|
1065
1135
|
export interface MetricDimensionGroups {
|
|
1066
1136
|
/**
|
|
1137
|
+
* @public
|
|
1067
1138
|
* <p>The metric type to which the dimension information belongs.</p>
|
|
1068
1139
|
*/
|
|
1069
1140
|
Metric?: string;
|
|
1070
1141
|
/**
|
|
1142
|
+
* @public
|
|
1071
1143
|
* <p>The available dimension groups for a metric type.</p>
|
|
1072
1144
|
*/
|
|
1073
1145
|
Groups?: DimensionGroupDetail[];
|
|
@@ -1077,10 +1149,12 @@ export interface MetricDimensionGroups {
|
|
|
1077
1149
|
*/
|
|
1078
1150
|
export interface ListAvailableResourceDimensionsResponse {
|
|
1079
1151
|
/**
|
|
1152
|
+
* @public
|
|
1080
1153
|
* <p>The dimension information returned for requested metric types.</p>
|
|
1081
1154
|
*/
|
|
1082
1155
|
MetricDimensions?: MetricDimensionGroups[];
|
|
1083
1156
|
/**
|
|
1157
|
+
* @public
|
|
1084
1158
|
* <p>An optional pagination token provided by a previous request. If this parameter is specified,
|
|
1085
1159
|
* the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.</p>
|
|
1086
1160
|
*/
|
|
@@ -1091,16 +1165,19 @@ export interface ListAvailableResourceDimensionsResponse {
|
|
|
1091
1165
|
*/
|
|
1092
1166
|
export interface ListAvailableResourceMetricsRequest {
|
|
1093
1167
|
/**
|
|
1168
|
+
* @public
|
|
1094
1169
|
* <p>The Amazon Web Services service for which Performance Insights returns metrics.</p>
|
|
1095
1170
|
*/
|
|
1096
1171
|
ServiceType: ServiceType | string | undefined;
|
|
1097
1172
|
/**
|
|
1173
|
+
* @public
|
|
1098
1174
|
* <p>An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers
|
|
1099
1175
|
* metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its
|
|
1100
1176
|
* <code>DbiResourceId</code> value. For example, specify <code>db-ABCDEFGHIJKLMNOPQRSTU1VWZ</code>. </p>
|
|
1101
1177
|
*/
|
|
1102
1178
|
Identifier: string | undefined;
|
|
1103
1179
|
/**
|
|
1180
|
+
* @public
|
|
1104
1181
|
* <p>The types of metrics to return in the response. Valid values in the array include the following:</p>
|
|
1105
1182
|
* <ul>
|
|
1106
1183
|
* <li>
|
|
@@ -1123,12 +1200,14 @@ export interface ListAvailableResourceMetricsRequest {
|
|
|
1123
1200
|
*/
|
|
1124
1201
|
MetricTypes: string[] | undefined;
|
|
1125
1202
|
/**
|
|
1203
|
+
* @public
|
|
1126
1204
|
* <p>An optional pagination token provided by a previous request. If this parameter is specified,
|
|
1127
1205
|
* the response includes only records beyond the token, up to the value specified by <code>MaxRecords</code>.
|
|
1128
1206
|
* </p>
|
|
1129
1207
|
*/
|
|
1130
1208
|
NextToken?: string;
|
|
1131
1209
|
/**
|
|
1210
|
+
* @public
|
|
1132
1211
|
* <p>The maximum number of items to return. If the <code>MaxRecords</code> value is less than the number
|
|
1133
1212
|
* of existing items, the response includes a pagination token. </p>
|
|
1134
1213
|
*/
|
|
@@ -1141,14 +1220,17 @@ export interface ListAvailableResourceMetricsRequest {
|
|
|
1141
1220
|
*/
|
|
1142
1221
|
export interface ResponseResourceMetric {
|
|
1143
1222
|
/**
|
|
1223
|
+
* @public
|
|
1144
1224
|
* <p>The full name of the metric.</p>
|
|
1145
1225
|
*/
|
|
1146
1226
|
Metric?: string;
|
|
1147
1227
|
/**
|
|
1228
|
+
* @public
|
|
1148
1229
|
* <p>The description of the metric.</p>
|
|
1149
1230
|
*/
|
|
1150
1231
|
Description?: string;
|
|
1151
1232
|
/**
|
|
1233
|
+
* @public
|
|
1152
1234
|
* <p>The unit of the metric.</p>
|
|
1153
1235
|
*/
|
|
1154
1236
|
Unit?: string;
|
|
@@ -1158,12 +1240,14 @@ export interface ResponseResourceMetric {
|
|
|
1158
1240
|
*/
|
|
1159
1241
|
export interface ListAvailableResourceMetricsResponse {
|
|
1160
1242
|
/**
|
|
1243
|
+
* @public
|
|
1161
1244
|
* <p>An array of metrics available to query. Each array element contains the full name,
|
|
1162
1245
|
* description, and unit of the metric.
|
|
1163
1246
|
* </p>
|
|
1164
1247
|
*/
|
|
1165
1248
|
Metrics?: ResponseResourceMetric[];
|
|
1166
1249
|
/**
|
|
1250
|
+
* @public
|
|
1167
1251
|
* <p>A pagination token that indicates the response didn’t return all available records because <code>MaxRecords</code> was specified in the
|
|
1168
1252
|
* previous request. To get the remaining records, specify <code>NextToken</code> in a separate request with this value. </p>
|
|
1169
1253
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-pi",
|
|
3
3
|
"description": "AWS SDK for JavaScript Pi Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.385.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.385.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.385.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|