Skip to content

Commit 2d4a1eb

Browse files
author
awstools
committed
feat(client-trustedadvisor): Adding a new enum attribute(statusReason) to TrustedAdvisorAPI response. This attribute explains reasoning behind check status for certain specific scenarios.
1 parent 20258a5 commit 2d4a1eb

17 files changed

+211
-140
lines changed

‎clients/client-trustedadvisor/src/commands/BatchUpdateRecommendationResourceExclusionCommand.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface BatchUpdateRecommendationResourceExclusionCommandInput extends
3434
export interface BatchUpdateRecommendationResourceExclusionCommandOutput extends BatchUpdateRecommendationResourceExclusionResponse, __MetadataBearer {}
3535

3636
/**
37-
* <p>Update one or more exclusion status for a list of recommendation resources</p>
37+
* <p>Update one or more exclusion statuses for a list of recommendation resources. This API supports up to 25 unique recommendation resource ARNs per request. This API currently doesn't support prioritized recommendation resources. This API updates global recommendations, eliminating the need to call the API in each AWS Region. After submitting an exclusion update, note that it might take a few minutes for the changes to be reflected in the system.</p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.
4040
* ```javascript

‎clients/client-trustedadvisor/src/commands/GetOrganizationRecommendationCommand.ts‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,7 @@ export interface GetOrganizationRecommendationCommandInput extends GetOrganizati
3131
export interface GetOrganizationRecommendationCommandOutput extends GetOrganizationRecommendationResponse, __MetadataBearer {}
3232

3333
/**
34-
* <p>Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized
35-
* recommendations.
36-
* </p>
34+
* <p>Get a specific recommendation within an AWS Organizations organization. This API supports only prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region. </p>
3735
* @example
3836
* Use a bare-bones client and the command you need to make an API call.
3937
* ```javascript
@@ -57,7 +55,7 @@ export interface GetOrganizationRecommendationCommandOutput extends GetOrganizat
5755
* // pillars: [ // RecommendationPillarList // required
5856
* // "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence",
5957
* // ],
60-
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required
58+
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected" || "cost_optimization_hub", // required
6159
* // awsServices: [ // RecommendationAwsServiceList
6260
* // "STRING_VALUE",
6361
* // ],
@@ -66,6 +64,7 @@ export interface GetOrganizationRecommendationCommandOutput extends GetOrganizat
6664
* // okCount: Number("long"), // required
6765
* // warningCount: Number("long"), // required
6866
* // errorCount: Number("long"), // required
67+
* // excludedCount: Number("long"),
6968
* // },
7069
* // pillarSpecificAggregates: { // RecommendationPillarSpecificAggregates
7170
* // costOptimizing: { // RecommendationCostOptimizingAggregates

‎clients/client-trustedadvisor/src/commands/GetRecommendationCommand.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface GetRecommendationCommandInput extends GetRecommendationRequest
3131
export interface GetRecommendationCommandOutput extends GetRecommendationResponse, __MetadataBearer {}
3232

3333
/**
34-
* <p>Get a specific Recommendation</p>
34+
* <p>Get a specific Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript
@@ -42,6 +42,7 @@ export interface GetRecommendationCommandOutput extends GetRecommendationRespons
4242
* const client = new TrustedAdvisorClient(config);
4343
* const input = { // GetRecommendationRequest
4444
* recommendationIdentifier: "STRING_VALUE", // required
45+
* language: "en" || "ja" || "zh" || "fr" || "de" || "ko" || "zh_TW" || "it" || "es" || "pt_BR" || "id",
4546
* };
4647
* const command = new GetRecommendationCommand(input);
4748
* const response = await client.send(command);
@@ -55,7 +56,7 @@ export interface GetRecommendationCommandOutput extends GetRecommendationRespons
5556
* // pillars: [ // RecommendationPillarList // required
5657
* // "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence",
5758
* // ],
58-
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required
59+
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected" || "cost_optimization_hub", // required
5960
* // awsServices: [ // RecommendationAwsServiceList
6061
* // "STRING_VALUE",
6162
* // ],
@@ -64,6 +65,7 @@ export interface GetRecommendationCommandOutput extends GetRecommendationRespons
6465
* // okCount: Number("long"), // required
6566
* // warningCount: Number("long"), // required
6667
* // errorCount: Number("long"), // required
68+
* // excludedCount: Number("long"),
6769
* // },
6870
* // pillarSpecificAggregates: { // RecommendationPillarSpecificAggregates
6971
* // costOptimizing: { // RecommendationCostOptimizingAggregates
@@ -74,6 +76,7 @@ export interface GetRecommendationCommandOutput extends GetRecommendationRespons
7476
* // createdAt: new Date("TIMESTAMP"),
7577
* // lastUpdatedAt: new Date("TIMESTAMP"),
7678
* // arn: "STRING_VALUE", // required
79+
* // statusReason: "no_data_ok",
7780
* // description: "STRING_VALUE", // required
7881
* // createdBy: "STRING_VALUE",
7982
* // updatedOnBehalfOf: "STRING_VALUE",

‎clients/client-trustedadvisor/src/commands/ListChecksCommand.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface ListChecksCommandInput extends ListChecksRequest {}
3131
export interface ListChecksCommandOutput extends ListChecksResponse, __MetadataBearer {}
3232

3333
/**
34-
* <p>List a filterable set of Checks</p>
34+
* <p>List a filterable set of Checks. This API provides global recommendations, eliminating the need to call the API in each AWS Region.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript
@@ -45,7 +45,7 @@ export interface ListChecksCommandOutput extends ListChecksResponse, __MetadataB
4545
* maxResults: Number("int"),
4646
* pillar: "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence",
4747
* awsService: "STRING_VALUE",
48-
* source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected",
48+
* source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected" || "cost_optimization_hub",
4949
* language: "en" || "ja" || "zh" || "fr" || "de" || "ko" || "zh_TW" || "it" || "es" || "pt_BR" || "id",
5050
* };
5151
* const command = new ListChecksCommand(input);
@@ -64,7 +64,7 @@ export interface ListChecksCommandOutput extends ListChecksResponse, __MetadataB
6464
* // awsServices: [ // RecommendationAwsServiceList // required
6565
* // "STRING_VALUE",
6666
* // ],
67-
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required
67+
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected" || "cost_optimization_hub", // required
6868
* // metadata: { // StringMap // required
6969
* // "<keys>": "STRING_VALUE",
7070
* // },

‎clients/client-trustedadvisor/src/commands/ListOrganizationRecommendationAccountsCommand.ts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ export interface ListOrganizationRecommendationAccountsCommandInput extends List
3434
export interface ListOrganizationRecommendationAccountsCommandOutput extends ListOrganizationRecommendationAccountsResponse, __MetadataBearer {}
3535

3636
/**
37-
* <p>Lists the accounts that own the resources for an organization aggregate recommendation. This API only
38-
* supports prioritized recommendations.
39-
* </p>
37+
* <p>Lists the accounts that own the resources for an organization aggregate recommendation. This API only supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region. </p>
4038
* @example
4139
* Use a bare-bones client and the command you need to make an API call.
4240
* ```javascript

‎clients/client-trustedadvisor/src/commands/ListOrganizationRecommendationResourcesCommand.ts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ export interface ListOrganizationRecommendationResourcesCommandInput extends Lis
3434
export interface ListOrganizationRecommendationResourcesCommandOutput extends ListOrganizationRecommendationResourcesResponse, __MetadataBearer {}
3535

3636
/**
37-
* <p>List Resources of a Recommendation within an Organization. This API only supports prioritized
38-
* recommendations.
39-
* </p>
37+
* <p>List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region. </p>
4038
* @example
4139
* Use a bare-bones client and the command you need to make an API call.
4240
* ```javascript

‎clients/client-trustedadvisor/src/commands/ListOrganizationRecommendationsCommand.ts‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ export interface ListOrganizationRecommendationsCommandInput extends ListOrganiz
3434
export interface ListOrganizationRecommendationsCommandOutput extends ListOrganizationRecommendationsResponse, __MetadataBearer {}
3535

3636
/**
37-
* <p>List a filterable set of Recommendations within an Organization. This API only supports prioritized
38-
* recommendations.
39-
* </p>
37+
* <p>List a filterable set of Recommendations within an Organization. This API only supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region. </p>
4038
* @example
4139
* Use a bare-bones client and the command you need to make an API call.
4240
* ```javascript
@@ -52,7 +50,7 @@ export interface ListOrganizationRecommendationsCommandOutput extends ListOrgani
5250
* status: "ok" || "warning" || "error",
5351
* pillar: "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence",
5452
* awsService: "STRING_VALUE",
55-
* source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected",
53+
* source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected" || "cost_optimization_hub",
5654
* checkIdentifier: "STRING_VALUE",
5755
* afterLastUpdatedAt: new Date("TIMESTAMP"),
5856
* beforeLastUpdatedAt: new Date("TIMESTAMP"),
@@ -71,7 +69,7 @@ export interface ListOrganizationRecommendationsCommandOutput extends ListOrgani
7169
* // pillars: [ // RecommendationPillarList // required
7270
* // "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence",
7371
* // ],
74-
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required
72+
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected" || "cost_optimization_hub", // required
7573
* // awsServices: [ // RecommendationAwsServiceList
7674
* // "STRING_VALUE",
7775
* // ],
@@ -80,6 +78,7 @@ export interface ListOrganizationRecommendationsCommandOutput extends ListOrgani
8078
* // okCount: Number("long"), // required
8179
* // warningCount: Number("long"), // required
8280
* // errorCount: Number("long"), // required
81+
* // excludedCount: Number("long"),
8382
* // },
8483
* // pillarSpecificAggregates: { // RecommendationPillarSpecificAggregates
8584
* // costOptimizing: { // RecommendationCostOptimizingAggregates

‎clients/client-trustedadvisor/src/commands/ListRecommendationResourcesCommand.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface ListRecommendationResourcesCommandInput extends ListRecommendat
3131
export interface ListRecommendationResourcesCommandOutput extends ListRecommendationResourcesResponse, __MetadataBearer {}
3232

3333
/**
34-
* <p>List Resources of a Recommendation</p>
34+
* <p>List Resources of a Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript
@@ -47,6 +47,7 @@ export interface ListRecommendationResourcesCommandOutput extends ListRecommenda
4747
* exclusionStatus: "excluded" || "included",
4848
* regionCode: "STRING_VALUE",
4949
* recommendationIdentifier: "STRING_VALUE", // required
50+
* language: "en" || "ja" || "zh" || "fr" || "de" || "ko" || "zh_TW" || "it" || "es" || "pt_BR" || "id",
5051
* };
5152
* const command = new ListRecommendationResourcesCommand(input);
5253
* const response = await client.send(command);

‎clients/client-trustedadvisor/src/commands/ListRecommendationsCommand.ts‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface ListRecommendationsCommandInput extends ListRecommendationsRequ
3131
export interface ListRecommendationsCommandOutput extends ListRecommendationsResponse, __MetadataBearer {}
3232

3333
/**
34-
* <p>List a filterable set of Recommendations</p>
34+
* <p>List a filterable set of Recommendations. This API provides global recommendations, eliminating the need to call the API in each AWS Region.</p>
3535
* @example
3636
* Use a bare-bones client and the command you need to make an API call.
3737
* ```javascript
@@ -47,10 +47,11 @@ export interface ListRecommendationsCommandOutput extends ListRecommendationsRes
4747
* status: "ok" || "warning" || "error",
4848
* pillar: "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence",
4949
* awsService: "STRING_VALUE",
50-
* source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected",
50+
* source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected" || "cost_optimization_hub",
5151
* checkIdentifier: "STRING_VALUE",
5252
* afterLastUpdatedAt: new Date("TIMESTAMP"),
5353
* beforeLastUpdatedAt: new Date("TIMESTAMP"),
54+
* language: "en" || "ja" || "zh" || "fr" || "de" || "ko" || "zh_TW" || "it" || "es" || "pt_BR" || "id",
5455
* };
5556
* const command = new ListRecommendationsCommand(input);
5657
* const response = await client.send(command);
@@ -66,7 +67,7 @@ export interface ListRecommendationsCommandOutput extends ListRecommendationsRes
6667
* // pillars: [ // RecommendationPillarList // required
6768
* // "cost_optimizing" || "performance" || "security" || "service_limits" || "fault_tolerance" || "operational_excellence",
6869
* // ],
69-
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected", // required
70+
* // source: "aws_config" || "compute_optimizer" || "cost_explorer" || "lse" || "manual" || "pse" || "rds" || "resilience" || "resilience_hub" || "security_hub" || "stir" || "ta_check" || "well_architected" || "cost_optimization_hub", // required
7071
* // awsServices: [ // RecommendationAwsServiceList
7172
* // "STRING_VALUE",
7273
* // ],
@@ -75,6 +76,7 @@ export interface ListRecommendationsCommandOutput extends ListRecommendationsRes
7576
* // okCount: Number("long"), // required
7677
* // warningCount: Number("long"), // required
7778
* // errorCount: Number("long"), // required
79+
* // excludedCount: Number("long"),
7880
* // },
7981
* // pillarSpecificAggregates: { // RecommendationPillarSpecificAggregates
8082
* // costOptimizing: { // RecommendationCostOptimizingAggregates
@@ -85,6 +87,7 @@ export interface ListRecommendationsCommandOutput extends ListRecommendationsRes
8587
* // createdAt: new Date("TIMESTAMP"),
8688
* // lastUpdatedAt: new Date("TIMESTAMP"),
8789
* // arn: "STRING_VALUE", // required
90+
* // statusReason: "no_data_ok",
8891
* // },
8992
* // ],
9093
* // };

‎clients/client-trustedadvisor/src/commands/UpdateOrganizationRecommendationLifecycleCommand.ts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,7 @@ export interface UpdateOrganizationRecommendationLifecycleCommandInput extends U
3131
export interface UpdateOrganizationRecommendationLifecycleCommandOutput extends __MetadataBearer {}
3232

3333
/**
34-
* <p>Update the lifecycle of a Recommendation within an Organization. This API only supports prioritized
35-
* recommendations.
36-
* </p>
34+
* <p>Update the lifecycle of a Recommendation within an Organization. This API only supports prioritized recommendations and updates global priority recommendations, eliminating the need to call the API in each AWS Region. </p>
3735
* @example
3836
* Use a bare-bones client and the command you need to make an API call.
3937
* ```javascript

0 commit comments

Comments
 (0)