aws-sdk 2.1435.0 → 2.1437.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/clients/pi.d.ts CHANGED
@@ -11,6 +11,22 @@ declare class PI extends Service {
11
11
  */
12
12
  constructor(options?: PI.Types.ClientConfiguration)
13
13
  config: Config & PI.Types.ClientConfiguration;
14
+ /**
15
+ * Creates a new performance analysis report for a specific time period for the DB instance.
16
+ */
17
+ createPerformanceAnalysisReport(params: PI.Types.CreatePerformanceAnalysisReportRequest, callback?: (err: AWSError, data: PI.Types.CreatePerformanceAnalysisReportResponse) => void): Request<PI.Types.CreatePerformanceAnalysisReportResponse, AWSError>;
18
+ /**
19
+ * Creates a new performance analysis report for a specific time period for the DB instance.
20
+ */
21
+ createPerformanceAnalysisReport(callback?: (err: AWSError, data: PI.Types.CreatePerformanceAnalysisReportResponse) => void): Request<PI.Types.CreatePerformanceAnalysisReportResponse, AWSError>;
22
+ /**
23
+ * Deletes a performance analysis report.
24
+ */
25
+ deletePerformanceAnalysisReport(params: PI.Types.DeletePerformanceAnalysisReportRequest, callback?: (err: AWSError, data: PI.Types.DeletePerformanceAnalysisReportResponse) => void): Request<PI.Types.DeletePerformanceAnalysisReportResponse, AWSError>;
26
+ /**
27
+ * Deletes a performance analysis report.
28
+ */
29
+ deletePerformanceAnalysisReport(callback?: (err: AWSError, data: PI.Types.DeletePerformanceAnalysisReportResponse) => void): Request<PI.Types.DeletePerformanceAnalysisReportResponse, AWSError>;
14
30
  /**
15
31
  * For a specific time period, retrieve the top N dimension keys for a metric. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
16
32
  */
@@ -27,6 +43,14 @@ declare class PI extends Service {
27
43
  * Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.
28
44
  */
29
45
  getDimensionKeyDetails(callback?: (err: AWSError, data: PI.Types.GetDimensionKeyDetailsResponse) => void): Request<PI.Types.GetDimensionKeyDetailsResponse, AWSError>;
46
+ /**
47
+ * Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.
48
+ */
49
+ getPerformanceAnalysisReport(params: PI.Types.GetPerformanceAnalysisReportRequest, callback?: (err: AWSError, data: PI.Types.GetPerformanceAnalysisReportResponse) => void): Request<PI.Types.GetPerformanceAnalysisReportResponse, AWSError>;
50
+ /**
51
+ * Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.
52
+ */
53
+ getPerformanceAnalysisReport(callback?: (err: AWSError, data: PI.Types.GetPerformanceAnalysisReportResponse) => void): Request<PI.Types.GetPerformanceAnalysisReportResponse, AWSError>;
30
54
  /**
31
55
  * Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
32
56
  */
@@ -59,10 +83,144 @@ declare class PI extends Service {
59
83
  * Retrieve metrics of the specified types that can be queried for a specified DB instance.
60
84
  */
61
85
  listAvailableResourceMetrics(callback?: (err: AWSError, data: PI.Types.ListAvailableResourceMetricsResponse) => void): Request<PI.Types.ListAvailableResourceMetricsResponse, AWSError>;
86
+ /**
87
+ * Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
88
+ */
89
+ listPerformanceAnalysisReports(params: PI.Types.ListPerformanceAnalysisReportsRequest, callback?: (err: AWSError, data: PI.Types.ListPerformanceAnalysisReportsResponse) => void): Request<PI.Types.ListPerformanceAnalysisReportsResponse, AWSError>;
90
+ /**
91
+ * Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
92
+ */
93
+ listPerformanceAnalysisReports(callback?: (err: AWSError, data: PI.Types.ListPerformanceAnalysisReportsResponse) => void): Request<PI.Types.ListPerformanceAnalysisReportsResponse, AWSError>;
94
+ /**
95
+ * Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
96
+ */
97
+ listTagsForResource(params: PI.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: PI.Types.ListTagsForResourceResponse) => void): Request<PI.Types.ListTagsForResourceResponse, AWSError>;
98
+ /**
99
+ * Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
100
+ */
101
+ listTagsForResource(callback?: (err: AWSError, data: PI.Types.ListTagsForResourceResponse) => void): Request<PI.Types.ListTagsForResourceResponse, AWSError>;
102
+ /**
103
+ * Adds metadata tags to the Amazon RDS Performance Insights resource.
104
+ */
105
+ tagResource(params: PI.Types.TagResourceRequest, callback?: (err: AWSError, data: PI.Types.TagResourceResponse) => void): Request<PI.Types.TagResourceResponse, AWSError>;
106
+ /**
107
+ * Adds metadata tags to the Amazon RDS Performance Insights resource.
108
+ */
109
+ tagResource(callback?: (err: AWSError, data: PI.Types.TagResourceResponse) => void): Request<PI.Types.TagResourceResponse, AWSError>;
110
+ /**
111
+ * Deletes the metadata tags from the Amazon RDS Performance Insights resource.
112
+ */
113
+ untagResource(params: PI.Types.UntagResourceRequest, callback?: (err: AWSError, data: PI.Types.UntagResourceResponse) => void): Request<PI.Types.UntagResourceResponse, AWSError>;
114
+ /**
115
+ * Deletes the metadata tags from the Amazon RDS Performance Insights resource.
116
+ */
117
+ untagResource(callback?: (err: AWSError, data: PI.Types.UntagResourceResponse) => void): Request<PI.Types.UntagResourceResponse, AWSError>;
62
118
  }
63
119
  declare namespace PI {
120
+ export type AcceptLanguage = "EN_US"|string;
64
121
  export type AdditionalMetricsList = RequestString[];
65
122
  export type AdditionalMetricsMap = {[key: string]: Double};
123
+ export type AmazonResourceName = string;
124
+ export interface AnalysisReport {
125
+ /**
126
+ * The name of the analysis report.
127
+ */
128
+ AnalysisReportId: AnalysisReportId;
129
+ /**
130
+ * The unique identifier of the analysis report.
131
+ */
132
+ Identifier?: IdentifierString;
133
+ /**
134
+ * List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows: RDS DOCDB
135
+ */
136
+ ServiceType?: ServiceType;
137
+ /**
138
+ * The time you created the analysis report.
139
+ */
140
+ CreateTime?: ISOTimestamp;
141
+ /**
142
+ * The analysis start time in the report.
143
+ */
144
+ StartTime?: ISOTimestamp;
145
+ /**
146
+ * The analysis end time in the report.
147
+ */
148
+ EndTime?: ISOTimestamp;
149
+ /**
150
+ * The status of the created analysis report.
151
+ */
152
+ Status?: AnalysisStatus;
153
+ /**
154
+ * The list of identified insights in the analysis report.
155
+ */
156
+ Insights?: InsightList;
157
+ }
158
+ export type AnalysisReportId = string;
159
+ export interface AnalysisReportSummary {
160
+ /**
161
+ * The name of the analysis report.
162
+ */
163
+ AnalysisReportId?: String;
164
+ /**
165
+ * The time you created the analysis report.
166
+ */
167
+ CreateTime?: ISOTimestamp;
168
+ /**
169
+ * The start time of the analysis in the report.
170
+ */
171
+ StartTime?: ISOTimestamp;
172
+ /**
173
+ * The end time of the analysis in the report.
174
+ */
175
+ EndTime?: ISOTimestamp;
176
+ /**
177
+ * The status of the analysis report.
178
+ */
179
+ Status?: AnalysisStatus;
180
+ /**
181
+ * List of all the tags added to the analysis report.
182
+ */
183
+ Tags?: TagList;
184
+ }
185
+ export type AnalysisReportSummaryList = AnalysisReportSummary[];
186
+ export type AnalysisStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|string;
187
+ export type Boolean = boolean;
188
+ export type ContextType = "CAUSAL"|"CONTEXTUAL"|string;
189
+ export interface CreatePerformanceAnalysisReportRequest {
190
+ /**
191
+ * The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
192
+ */
193
+ ServiceType: ServiceType;
194
+ /**
195
+ * An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-ADECBTYHKTSAUMUZQYPDS2GW4A.
196
+ */
197
+ Identifier: IdentifierString;
198
+ /**
199
+ * The start time defined for the analysis report.
200
+ */
201
+ StartTime: ISOTimestamp;
202
+ /**
203
+ * The end time defined for the analysis report.
204
+ */
205
+ EndTime: ISOTimestamp;
206
+ /**
207
+ * The metadata assigned to the analysis report consisting of a key-value pair.
208
+ */
209
+ Tags?: TagList;
210
+ }
211
+ export interface CreatePerformanceAnalysisReportResponse {
212
+ /**
213
+ * A unique identifier for the created analysis report.
214
+ */
215
+ AnalysisReportId?: AnalysisReportId;
216
+ }
217
+ export interface Data {
218
+ /**
219
+ * This field determines the Performance Insights metric to render for the insight. The name field refers to a Performance Insights metric.
220
+ */
221
+ PerformanceInsightsMetric?: PerformanceInsightsMetric;
222
+ }
223
+ export type DataList = Data[];
66
224
  export interface DataPoint {
67
225
  /**
68
226
  * The time, in epoch format, associated with a particular Value.
@@ -74,6 +232,22 @@ declare namespace PI {
74
232
  Value: Double;
75
233
  }
76
234
  export type DataPointsList = DataPoint[];
235
+ export interface DeletePerformanceAnalysisReportRequest {
236
+ /**
237
+ * The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
238
+ */
239
+ ServiceType: ServiceType;
240
+ /**
241
+ * 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 console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
242
+ */
243
+ Identifier: IdentifierString;
244
+ /**
245
+ * The unique identifier of the analysis report for deletion.
246
+ */
247
+ AnalysisReportId: AnalysisReportId;
248
+ }
249
+ export interface DeletePerformanceAnalysisReportResponse {
250
+ }
77
251
  export interface DescribeDimensionKeysRequest {
78
252
  /**
79
253
  * The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows: RDS DOCDB
@@ -82,7 +256,7 @@ declare namespace PI {
82
256
  /**
83
257
  * An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.
84
258
  */
85
- Identifier: RequestString;
259
+ Identifier: IdentifierString;
86
260
  /**
87
261
  * The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned. The value for StartTime must be earlier than the value for EndTime.
88
262
  */
@@ -147,6 +321,8 @@ declare namespace PI {
147
321
  NextToken?: NextToken;
148
322
  }
149
323
  export type Description = string;
324
+ export type DescriptiveMap = {[key: string]: DescriptiveString};
325
+ export type DescriptiveString = string;
150
326
  export type DetailStatus = "AVAILABLE"|"PROCESSING"|"UNAVAILABLE"|string;
151
327
  export interface DimensionDetail {
152
328
  /**
@@ -253,6 +429,34 @@ declare namespace PI {
253
429
  */
254
430
  Dimensions?: DimensionKeyDetailList;
255
431
  }
432
+ export interface GetPerformanceAnalysisReportRequest {
433
+ /**
434
+ * The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.
435
+ */
436
+ ServiceType: ServiceType;
437
+ /**
438
+ * 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 console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
439
+ */
440
+ Identifier: IdentifierString;
441
+ /**
442
+ * A unique identifier of the created analysis report. For example, report-12345678901234567
443
+ */
444
+ AnalysisReportId: AnalysisReportId;
445
+ /**
446
+ * Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default value is plain text.
447
+ */
448
+ TextFormat?: TextFormat;
449
+ /**
450
+ * The text language in the report. The default language is EN_US (English).
451
+ */
452
+ AcceptLanguage?: AcceptLanguage;
453
+ }
454
+ export interface GetPerformanceAnalysisReportResponse {
455
+ /**
456
+ * The summary of the performance analysis report created for a time period.
457
+ */
458
+ AnalysisReport?: AnalysisReport;
459
+ }
256
460
  export interface GetResourceMetadataRequest {
257
461
  /**
258
462
  * The Amazon Web Services service for which Performance Insights returns metrics.
@@ -261,7 +465,7 @@ declare namespace PI {
261
465
  /**
262
466
  * An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
263
467
  */
264
- Identifier: RequestString;
468
+ Identifier: IdentifierString;
265
469
  }
266
470
  export interface GetResourceMetadataResponse {
267
471
  /**
@@ -281,7 +485,7 @@ declare namespace PI {
281
485
  /**
282
486
  * 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 console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
283
487
  */
284
- Identifier: RequestString;
488
+ Identifier: IdentifierString;
285
489
  /**
286
490
  * An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.
287
491
  */
@@ -335,6 +539,53 @@ declare namespace PI {
335
539
  }
336
540
  export type ISOTimestamp = Date;
337
541
  export type IdentifierString = string;
542
+ export interface Insight {
543
+ /**
544
+ * The unique identifier for the insight. For example, insight-12345678901234567.
545
+ */
546
+ InsightId: String;
547
+ /**
548
+ * The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.
549
+ */
550
+ InsightType?: String;
551
+ /**
552
+ * Indicates if the insight is causal or correlated insight.
553
+ */
554
+ Context?: ContextType;
555
+ /**
556
+ * The start time of the insight. For example, 2018-10-30T00:00:00Z.
557
+ */
558
+ StartTime?: ISOTimestamp;
559
+ /**
560
+ * The end time of the insight. For example, 2018-10-30T00:00:00Z.
561
+ */
562
+ EndTime?: ISOTimestamp;
563
+ /**
564
+ * The severity of the insight. The values are: Low, Medium, or High.
565
+ */
566
+ Severity?: Severity;
567
+ /**
568
+ * List of supporting insights that provide additional factors for the insight.
569
+ */
570
+ SupportingInsights?: InsightList;
571
+ /**
572
+ * Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact.
573
+ */
574
+ Description?: MarkdownString;
575
+ /**
576
+ * List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id.
577
+ */
578
+ Recommendations?: RecommendationList;
579
+ /**
580
+ * List of data objects containing metrics and references from the time range while generating the insight.
581
+ */
582
+ InsightData?: DataList;
583
+ /**
584
+ * Metric names and values from the timeframe used as baseline to generate the insight.
585
+ */
586
+ BaselineData?: DataList;
587
+ }
588
+ export type InsightList = Insight[];
338
589
  export type Integer = number;
339
590
  export type Limit = number;
340
591
  export interface ListAvailableResourceDimensionsRequest {
@@ -345,7 +596,7 @@ declare namespace PI {
345
596
  /**
346
597
  * An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
347
598
  */
348
- Identifier: RequestString;
599
+ Identifier: IdentifierString;
349
600
  /**
350
601
  * The types of metrics for which to retrieve dimensions. Valid values include db.load.
351
602
  */
@@ -377,7 +628,7 @@ declare namespace PI {
377
628
  /**
378
629
  * An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.
379
630
  */
380
- Identifier: RequestString;
631
+ Identifier: IdentifierString;
381
632
  /**
382
633
  * The types of metrics to return in the response. Valid values in the array include the following: os (OS counter metrics) - All engines db (DB load metrics) - All engines except for Amazon DocumentDB db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB
383
634
  */
@@ -401,6 +652,55 @@ declare namespace PI {
401
652
  */
402
653
  NextToken?: NextToken;
403
654
  }
655
+ export interface ListPerformanceAnalysisReportsRequest {
656
+ /**
657
+ * The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
658
+ */
659
+ ServiceType: ServiceType;
660
+ /**
661
+ * 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 console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
662
+ */
663
+ Identifier: IdentifierString;
664
+ /**
665
+ * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.
666
+ */
667
+ NextToken?: NextToken;
668
+ /**
669
+ * The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a pagination token is included in the response so that the remaining results can be retrieved.
670
+ */
671
+ MaxResults?: MaxResults;
672
+ /**
673
+ * Specifies whether or not to include the list of tags in the response.
674
+ */
675
+ ListTags?: Boolean;
676
+ }
677
+ export interface ListPerformanceAnalysisReportsResponse {
678
+ /**
679
+ * List of reports including the report identifier, start and end time, creation time, and status.
680
+ */
681
+ AnalysisReports?: AnalysisReportSummaryList;
682
+ /**
683
+ * An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.
684
+ */
685
+ NextToken?: NextToken;
686
+ }
687
+ export interface ListTagsForResourceRequest {
688
+ /**
689
+ * List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
690
+ */
691
+ ServiceType: ServiceType;
692
+ /**
693
+ * Lists all the tags for the Amazon RDS Performance Insights resource. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
694
+ */
695
+ ResourceARN: AmazonResourceName;
696
+ }
697
+ export interface ListTagsForResourceResponse {
698
+ /**
699
+ * The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
700
+ */
701
+ Tags?: TagList;
702
+ }
703
+ export type MarkdownString = string;
404
704
  export type MaxResults = number;
405
705
  export interface MetricDimensionGroups {
406
706
  /**
@@ -443,7 +743,36 @@ declare namespace PI {
443
743
  export type MetricTypeList = RequestString[];
444
744
  export type MetricValuesList = Double[];
445
745
  export type NextToken = string;
746
+ export interface PerformanceInsightsMetric {
747
+ /**
748
+ * The Performance Insights metric.
749
+ */
750
+ Metric?: DescriptiveString;
751
+ /**
752
+ * The Performance Insights metric name.
753
+ */
754
+ DisplayName?: DescriptiveString;
755
+ /**
756
+ * A dimension map that contains the dimensions for this partition.
757
+ */
758
+ Dimensions?: DescriptiveMap;
759
+ /**
760
+ * The value of the metric. For example, 9 for db.load.avg.
761
+ */
762
+ Value?: Double;
763
+ }
446
764
  export type PeriodAlignment = "END_TIME"|"START_TIME"|string;
765
+ export interface Recommendation {
766
+ /**
767
+ * The unique identifier for the recommendation.
768
+ */
769
+ RecommendationId?: String;
770
+ /**
771
+ * The recommendation details to help resolve the performance issue. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id
772
+ */
773
+ RecommendationDescription?: MarkdownString;
774
+ }
775
+ export type RecommendationList = Recommendation[];
447
776
  export type RequestString = string;
448
777
  export type RequestStringList = RequestString[];
449
778
  export type RequestedDimensionList = RequestString[];
@@ -480,7 +809,55 @@ declare namespace PI {
480
809
  }
481
810
  export type ResponseResourceMetricList = ResponseResourceMetric[];
482
811
  export type ServiceType = "RDS"|"DOCDB"|string;
812
+ export type Severity = "LOW"|"MEDIUM"|"HIGH"|string;
483
813
  export type String = string;
814
+ export interface Tag {
815
+ /**
816
+ * A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
817
+ */
818
+ Key: TagKey;
819
+ /**
820
+ * A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$").
821
+ */
822
+ Value: TagValue;
823
+ }
824
+ export type TagKey = string;
825
+ export type TagKeyList = TagKey[];
826
+ export type TagList = Tag[];
827
+ export interface TagResourceRequest {
828
+ /**
829
+ * The Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
830
+ */
831
+ ServiceType: ServiceType;
832
+ /**
833
+ * The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
834
+ */
835
+ ResourceARN: AmazonResourceName;
836
+ /**
837
+ * The metadata assigned to an Amazon RDS resource consisting of a key-value pair.
838
+ */
839
+ Tags: TagList;
840
+ }
841
+ export interface TagResourceResponse {
842
+ }
843
+ export type TagValue = string;
844
+ export type TextFormat = "PLAIN_TEXT"|"MARKDOWN"|string;
845
+ export interface UntagResourceRequest {
846
+ /**
847
+ * List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid value is RDS.
848
+ */
849
+ ServiceType: ServiceType;
850
+ /**
851
+ * The Amazon RDS Performance Insights resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).
852
+ */
853
+ ResourceARN: AmazonResourceName;
854
+ /**
855
+ * The metadata assigned to an Amazon RDS Performance Insights resource consisting of a key-value pair.
856
+ */
857
+ TagKeys: TagKeyList;
858
+ }
859
+ export interface UntagResourceResponse {
860
+ }
484
861
  /**
485
862
  * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
486
863
  */
@@ -293,7 +293,7 @@ declare namespace Route53Domains {
293
293
  /**
294
294
  * The password that was returned by the TransferDomainToAnotherAwsAccount request.
295
295
  */
296
- Password: String;
296
+ Password: Password;
297
297
  }
298
298
  export interface AcceptDomainTransferFromAnotherAwsAccountResponse {
299
299
  /**
@@ -386,6 +386,10 @@ declare namespace Route53Domains {
386
386
  * A complex type that contains information about whether the specified domain can be transferred to Route 53.
387
387
  */
388
388
  Transferability?: DomainTransferability;
389
+ /**
390
+ * Provides an explanation for when a domain can't be transferred.
391
+ */
392
+ Message?: Message;
389
393
  }
390
394
  export type City = string;
391
395
  export interface Consent {
@@ -973,6 +977,7 @@ declare namespace Route53Domains {
973
977
  */
974
978
  TagList?: TagList;
975
979
  }
980
+ export type Message = string;
976
981
  export interface Nameserver {
977
982
  /**
978
983
  * The fully qualified host name of the name server. Constraint: Maximum 255 characters
@@ -1028,6 +1033,7 @@ declare namespace Route53Domains {
1028
1033
  export type Operator = "LE"|"GE"|"BEGINS_WITH"|string;
1029
1034
  export type PageMarker = string;
1030
1035
  export type PageMaxItems = number;
1036
+ export type Password = string;
1031
1037
  export type Price = number;
1032
1038
  export interface PriceWithCurrency {
1033
1039
  /**
@@ -1277,7 +1283,7 @@ declare namespace Route53Domains {
1277
1283
  /**
1278
1284
  * To finish transferring a domain to another Amazon Web Services account, the account that the domain is being transferred to must submit an AcceptDomainTransferFromAnotherAwsAccount request. The request must include the value of the Password element that was returned in the TransferDomainToAnotherAwsAccount response.
1279
1285
  */
1280
- Password?: String;
1286
+ Password?: Password;
1281
1287
  }
1282
1288
  export type Transferable = "TRANSFERABLE"|"UNTRANSFERABLE"|"DONT_KNOW"|"DOMAIN_IN_OWN_ACCOUNT"|"DOMAIN_IN_ANOTHER_ACCOUNT"|"PREMIUM_DOMAIN"|string;
1283
1289
  export interface UpdateDomainContactPrivacyRequest {
@@ -173,11 +173,11 @@ declare class SageMaker extends Service {
173
173
  */
174
174
  createEdgePackagingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
175
175
  /**
176
- * Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API to deploy models using SageMaker hosting services. For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook. You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read. When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role. Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy. Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [ "arn:aws:sagemaker:region:account-id:endpoint/endpointName" "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" ] For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
176
+ * Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API to deploy models using SageMaker hosting services. You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read. When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role. Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy. Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [ "arn:aws:sagemaker:region:account-id:endpoint/endpointName" "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" ] For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
177
177
  */
178
178
  createEndpoint(params: SageMaker.Types.CreateEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request<SageMaker.Types.CreateEndpointOutput, AWSError>;
179
179
  /**
180
- * Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API to deploy models using SageMaker hosting services. For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook. You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read. When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role. Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy. Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [ "arn:aws:sagemaker:region:account-id:endpoint/endpointName" "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" ] For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
180
+ * Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API to deploy models using SageMaker hosting services. You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read. When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role. Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy. Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [ "arn:aws:sagemaker:region:account-id:endpoint/endpointName" "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" ] For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
181
181
  */
182
182
  createEndpoint(callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request<SageMaker.Types.CreateEndpointOutput, AWSError>;
183
183
  /**
@@ -5471,7 +5471,7 @@ declare namespace SageMaker {
5471
5471
  */
5472
5472
  CertifyForMarketplace?: CertifyForMarketplace;
5473
5473
  /**
5474
- * A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
5474
+ * A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide. If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.
5475
5475
  */
5476
5476
  Tags?: TagList;
5477
5477
  /**
@@ -19429,6 +19429,10 @@ declare namespace SageMaker {
19429
19429
  * The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
19430
19430
  */
19431
19431
  SupportedEndpointType?: RecommendationJobSupportedEndpointType;
19432
+ /**
19433
+ * The supported MIME types for the output data.
19434
+ */
19435
+ SupportedResponseMIMETypes?: RecommendationJobSupportedResponseMIMETypes;
19432
19436
  }
19433
19437
  export type RecommendationJobDataInputConfig = string;
19434
19438
  export type RecommendationJobDescription = string;
@@ -19541,6 +19545,8 @@ declare namespace SageMaker {
19541
19545
  export type RecommendationJobSupportedContentTypes = String[];
19542
19546
  export type RecommendationJobSupportedEndpointType = "RealTime"|"Serverless"|string;
19543
19547
  export type RecommendationJobSupportedInstanceTypes = String[];
19548
+ export type RecommendationJobSupportedResponseMIMEType = string;
19549
+ export type RecommendationJobSupportedResponseMIMETypes = RecommendationJobSupportedResponseMIMEType[];
19544
19550
  export type RecommendationJobType = "Default"|"Advanced"|string;
19545
19551
  export interface RecommendationJobVpcConfig {
19546
19552
  /**
@@ -2514,7 +2514,7 @@ declare namespace Transfer {
2514
2514
  export type SftpAuthenticationMethods = "PASSWORD"|"PUBLIC_KEY"|"PUBLIC_KEY_OR_PASSWORD"|"PUBLIC_KEY_AND_PASSWORD"|string;
2515
2515
  export interface SftpConnectorConfig {
2516
2516
  /**
2517
- * The identifiers for the secrets (in Amazon Web Services Secrets Manager) that contain the SFTP user's private keys or passwords.
2517
+ * The identifier for the secret (in Amazon Web Services Secrets Manager) that contains the SFTP user's private key, password, or both. The identifier can be either the Amazon Resource Name (ARN) or the name of the secret.
2518
2518
  */
2519
2519
  UserSecretId?: SecretId;
2520
2520
  /**
@@ -2551,7 +2551,7 @@ declare namespace Transfer {
2551
2551
  */
2552
2552
  ConnectorId: ConnectorId;
2553
2553
  /**
2554
- * One or more source paths for the Transfer Family server. Each string represents a source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt . Replace DOC-EXAMPLE-BUCKET with one of your actual buckets.
2554
+ * One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, DOC-EXAMPLE-BUCKET/myfile.txt . Replace DOC-EXAMPLE-BUCKET with one of your actual buckets.
2555
2555
  */
2556
2556
  SendFilePaths?: FilePaths;
2557
2557
  /**
@@ -83,7 +83,7 @@ return /******/ (function(modules) { // webpackBootstrap
83
83
  /**
84
84
  * @constant
85
85
  */
86
- VERSION: '2.1435.0',
86
+ VERSION: '2.1437.0',
87
87
 
88
88
  /**
89
89
  * @api private