Skip to content

Commit 88f2623

Browse files
author
awstools
committed
feat(client-eks): Add support for filtering ListInsights API calls on MISCONFIGURATION insight category
1 parent ee418d1 commit 88f2623

File tree

4 files changed

+41
-7
lines changed

4 files changed

+41
-7
lines changed

clients/client-eks/src/commands/DescribeInsightCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export interface DescribeInsightCommandOutput extends DescribeInsightResponse, _
4545
* // insight: { // Insight
4646
* // id: "STRING_VALUE",
4747
* // name: "STRING_VALUE",
48-
* // category: "UPGRADE_READINESS",
48+
* // category: "UPGRADE_READINESS" || "MISCONFIGURATION",
4949
* // kubernetesVersion: "STRING_VALUE",
5050
* // lastRefreshTime: new Date("TIMESTAMP"),
5151
* // lastTransitionTime: new Date("TIMESTAMP"),

clients/client-eks/src/commands/ListInsightsCommand.ts

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,21 @@ export interface ListInsightsCommandOutput extends ListInsightsResponse, __Metad
3030
/**
3131
* <p>Returns a list of all insights checked for against the specified cluster. You can
3232
* filter which insights are returned by category, associated Kubernetes version, and
33-
* status.</p>
33+
* status. The default filter lists all categories and every status.</p>
34+
* <p>The following lists the available categories:</p>
35+
* <ul>
36+
* <li>
37+
* <p>
38+
* <code>UPGRADE_READINESS</code>: Amazon EKS identifies issues that could impact your
39+
* ability to upgrade to new versions of Kubernetes. These are called upgrade insights.</p>
40+
* </li>
41+
* <li>
42+
* <p>
43+
* <code>MISCONFIGURATION</code>: Amazon EKS identifies misconfiguration in your EKS
44+
* Hybrid Nodes setup that could impair functionality of your cluster or
45+
* workloads. These are called configuration insights.</p>
46+
* </li>
47+
* </ul>
3448
* @example
3549
* Use a bare-bones client and the command you need to make an API call.
3650
* ```javascript
@@ -41,7 +55,7 @@ export interface ListInsightsCommandOutput extends ListInsightsResponse, __Metad
4155
* clusterName: "STRING_VALUE", // required
4256
* filter: { // InsightsFilter
4357
* categories: [ // CategoryList
44-
* "UPGRADE_READINESS",
58+
* "UPGRADE_READINESS" || "MISCONFIGURATION",
4559
* ],
4660
* kubernetesVersions: [ // StringList
4761
* "STRING_VALUE",
@@ -60,7 +74,7 @@ export interface ListInsightsCommandOutput extends ListInsightsResponse, __Metad
6074
* // { // InsightSummary
6175
* // id: "STRING_VALUE",
6276
* // name: "STRING_VALUE",
63-
* // category: "UPGRADE_READINESS",
77+
* // category: "UPGRADE_READINESS" || "MISCONFIGURATION",
6478
* // kubernetesVersion: "STRING_VALUE",
6579
* // lastRefreshTime: new Date("TIMESTAMP"),
6680
* // lastTransitionTime: new Date("TIMESTAMP"),

clients/client-eks/src/models/models_0.ts

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5546,6 +5546,7 @@ export interface DescribeInsightRequest {
55465546
* @enum
55475547
*/
55485548
export const Category = {
5549+
MISCONFIGURATION: "MISCONFIGURATION",
55495550
UPGRADE_READINESS: "UPGRADE_READINESS",
55505551
} as const;
55515552

@@ -6466,7 +6467,20 @@ export interface ListIdentityProviderConfigsResponse {
64666467
*/
64676468
export interface InsightsFilter {
64686469
/**
6469-
* <p>The categories to use to filter insights.</p>
6470+
* <p>The categories to use to filter insights. The following lists the available categories:</p>
6471+
* <ul>
6472+
* <li>
6473+
* <p>
6474+
* <code>UPGRADE_READINESS</code>: Amazon EKS identifies issues that could impact your
6475+
* ability to upgrade to new versions of Kubernetes. These are called upgrade insights.</p>
6476+
* </li>
6477+
* <li>
6478+
* <p>
6479+
* <code>MISCONFIGURATION</code>: Amazon EKS identifies misconfiguration in your EKS
6480+
* Hybrid Nodes setup that could impair functionality of your cluster or
6481+
* workloads. These are called configuration insights.</p>
6482+
* </li>
6483+
* </ul>
64706484
* @public
64716485
*/
64726486
categories?: Category[] | undefined;

codegen/sdk-codegen/aws-models/eks.json

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2414,6 +2414,12 @@
24142414
"traits": {
24152415
"smithy.api#enumValue": "UPGRADE_READINESS"
24162416
}
2417+
},
2418+
"MISCONFIGURATION": {
2419+
"target": "smithy.api#Unit",
2420+
"traits": {
2421+
"smithy.api#enumValue": "MISCONFIGURATION"
2422+
}
24172423
}
24182424
}
24192425
},
@@ -7077,7 +7083,7 @@
70777083
"categories": {
70787084
"target": "com.amazonaws.eks#CategoryList",
70797085
"traits": {
7080-
"smithy.api#documentation": "<p>The categories to use to filter insights.</p>"
7086+
"smithy.api#documentation": "<p>The categories to use to filter insights. The following lists the available categories:</p>\n <ul>\n <li>\n <p>\n <code>UPGRADE_READINESS</code>: Amazon EKS identifies issues that could impact your\n ability to upgrade to new versions of Kubernetes. These are called upgrade insights.</p>\n </li>\n <li>\n <p>\n <code>MISCONFIGURATION</code>: Amazon EKS identifies misconfiguration in your EKS\n Hybrid Nodes setup that could impair functionality of your cluster or\n workloads. These are called configuration insights.</p>\n </li>\n </ul>"
70817087
}
70827088
},
70837089
"kubernetesVersions": {
@@ -8169,7 +8175,7 @@
81698175
}
81708176
],
81718177
"traits": {
8172-
"smithy.api#documentation": "<p>Returns a list of all insights checked for against the specified cluster. You can\n filter which insights are returned by category, associated Kubernetes version, and\n status.</p>",
8178+
"smithy.api#documentation": "<p>Returns a list of all insights checked for against the specified cluster. You can\n filter which insights are returned by category, associated Kubernetes version, and\n status. The default filter lists all categories and every status.</p>\n <p>The following lists the available categories:</p>\n <ul>\n <li>\n <p>\n <code>UPGRADE_READINESS</code>: Amazon EKS identifies issues that could impact your\n ability to upgrade to new versions of Kubernetes. These are called upgrade insights.</p>\n </li>\n <li>\n <p>\n <code>MISCONFIGURATION</code>: Amazon EKS identifies misconfiguration in your EKS\n Hybrid Nodes setup that could impair functionality of your cluster or\n workloads. These are called configuration insights.</p>\n </li>\n </ul>",
81738179
"smithy.api#http": {
81748180
"method": "POST",
81758181
"uri": "/clusters/{clusterName}/insights",

0 commit comments

Comments
 (0)