Skip to content

Commit aa902b4

Browse files
author
awstools
committed
feat(client-wellarchitected): AWS Well-Architected now has a Connector for Jira to allow customers to efficiently track workload risks and improvement efforts and create closed-loop mechanisms.
1 parent 639c711 commit aa902b4

22 files changed

+1470
-33
lines changed

‎clients/client-wellarchitected/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,14 @@ GetConsolidatedReport
400400

401401
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wellarchitected/command/GetConsolidatedReportCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wellarchitected/Interface/GetConsolidatedReportCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wellarchitected/Interface/GetConsolidatedReportCommandOutput/)
402402

403+
</details>
404+
<details>
405+
<summary>
406+
GetGlobalSettings
407+
</summary>
408+
409+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wellarchitected/command/GetGlobalSettingsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wellarchitected/Interface/GetGlobalSettingsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wellarchitected/Interface/GetGlobalSettingsCommandOutput/)
410+
403411
</details>
404412
<details>
405413
<summary>
@@ -680,6 +688,14 @@ UpdateGlobalSettings
680688

681689
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wellarchitected/command/UpdateGlobalSettingsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wellarchitected/Interface/UpdateGlobalSettingsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wellarchitected/Interface/UpdateGlobalSettingsCommandOutput/)
682690

691+
</details>
692+
<details>
693+
<summary>
694+
UpdateIntegration
695+
</summary>
696+
697+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/wellarchitected/command/UpdateIntegrationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wellarchitected/Interface/UpdateIntegrationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-wellarchitected/Interface/UpdateIntegrationCommandOutput/)
698+
683699
</details>
684700
<details>
685701
<summary>

‎clients/client-wellarchitected/src/WellArchitected.ts

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,11 @@ import {
110110
GetConsolidatedReportCommandInput,
111111
GetConsolidatedReportCommandOutput,
112112
} from "./commands/GetConsolidatedReportCommand";
113+
import {
114+
GetGlobalSettingsCommand,
115+
GetGlobalSettingsCommandInput,
116+
GetGlobalSettingsCommandOutput,
117+
} from "./commands/GetGlobalSettingsCommand";
113118
import { GetLensCommand, GetLensCommandInput, GetLensCommandOutput } from "./commands/GetLensCommand";
114119
import {
115120
GetLensReviewCommand,
@@ -257,6 +262,11 @@ import {
257262
UpdateGlobalSettingsCommandInput,
258263
UpdateGlobalSettingsCommandOutput,
259264
} from "./commands/UpdateGlobalSettingsCommand";
265+
import {
266+
UpdateIntegrationCommand,
267+
UpdateIntegrationCommandInput,
268+
UpdateIntegrationCommandOutput,
269+
} from "./commands/UpdateIntegrationCommand";
260270
import {
261271
UpdateLensReviewCommand,
262272
UpdateLensReviewCommandInput,
@@ -339,6 +349,7 @@ const commands = {
339349
ExportLensCommand,
340350
GetAnswerCommand,
341351
GetConsolidatedReportCommand,
352+
GetGlobalSettingsCommand,
342353
GetLensCommand,
343354
GetLensReviewCommand,
344355
GetLensReviewReportCommand,
@@ -374,6 +385,7 @@ const commands = {
374385
UntagResourceCommand,
375386
UpdateAnswerCommand,
376387
UpdateGlobalSettingsCommand,
388+
UpdateIntegrationCommand,
377389
UpdateLensReviewCommand,
378390
UpdateProfileCommand,
379391
UpdateReviewTemplateCommand,
@@ -748,6 +760,24 @@ export interface WellArchitected {
748760
cb: (err: any, data?: GetConsolidatedReportCommandOutput) => void
749761
): void;
750762

763+
/**
764+
* @see {@link GetGlobalSettingsCommand}
765+
*/
766+
getGlobalSettings(): Promise<GetGlobalSettingsCommandOutput>;
767+
getGlobalSettings(
768+
args: GetGlobalSettingsCommandInput,
769+
options?: __HttpHandlerOptions
770+
): Promise<GetGlobalSettingsCommandOutput>;
771+
getGlobalSettings(
772+
args: GetGlobalSettingsCommandInput,
773+
cb: (err: any, data?: GetGlobalSettingsCommandOutput) => void
774+
): void;
775+
getGlobalSettings(
776+
args: GetGlobalSettingsCommandInput,
777+
options: __HttpHandlerOptions,
778+
cb: (err: any, data?: GetGlobalSettingsCommandOutput) => void
779+
): void;
780+
751781
/**
752782
* @see {@link GetLensCommand}
753783
*/
@@ -1265,6 +1295,23 @@ export interface WellArchitected {
12651295
cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void
12661296
): void;
12671297

1298+
/**
1299+
* @see {@link UpdateIntegrationCommand}
1300+
*/
1301+
updateIntegration(
1302+
args: UpdateIntegrationCommandInput,
1303+
options?: __HttpHandlerOptions
1304+
): Promise<UpdateIntegrationCommandOutput>;
1305+
updateIntegration(
1306+
args: UpdateIntegrationCommandInput,
1307+
cb: (err: any, data?: UpdateIntegrationCommandOutput) => void
1308+
): void;
1309+
updateIntegration(
1310+
args: UpdateIntegrationCommandInput,
1311+
options: __HttpHandlerOptions,
1312+
cb: (err: any, data?: UpdateIntegrationCommandOutput) => void
1313+
): void;
1314+
12681315
/**
12691316
* @see {@link UpdateLensReviewCommand}
12701317
*/

‎clients/client-wellarchitected/src/WellArchitectedClient.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ import {
101101
GetConsolidatedReportCommandInput,
102102
GetConsolidatedReportCommandOutput,
103103
} from "./commands/GetConsolidatedReportCommand";
104+
import { GetGlobalSettingsCommandInput, GetGlobalSettingsCommandOutput } from "./commands/GetGlobalSettingsCommand";
104105
import { GetLensCommandInput, GetLensCommandOutput } from "./commands/GetLensCommand";
105106
import { GetLensReviewCommandInput, GetLensReviewCommandOutput } from "./commands/GetLensReviewCommand";
106107
import {
@@ -169,6 +170,7 @@ import {
169170
UpdateGlobalSettingsCommandInput,
170171
UpdateGlobalSettingsCommandOutput,
171172
} from "./commands/UpdateGlobalSettingsCommand";
173+
import { UpdateIntegrationCommandInput, UpdateIntegrationCommandOutput } from "./commands/UpdateIntegrationCommand";
172174
import { UpdateLensReviewCommandInput, UpdateLensReviewCommandOutput } from "./commands/UpdateLensReviewCommand";
173175
import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./commands/UpdateProfileCommand";
174176
import {
@@ -240,6 +242,7 @@ export type ServiceInputTypes =
240242
| ExportLensCommandInput
241243
| GetAnswerCommandInput
242244
| GetConsolidatedReportCommandInput
245+
| GetGlobalSettingsCommandInput
243246
| GetLensCommandInput
244247
| GetLensReviewCommandInput
245248
| GetLensReviewReportCommandInput
@@ -275,6 +278,7 @@ export type ServiceInputTypes =
275278
| UntagResourceCommandInput
276279
| UpdateAnswerCommandInput
277280
| UpdateGlobalSettingsCommandInput
281+
| UpdateIntegrationCommandInput
278282
| UpdateLensReviewCommandInput
279283
| UpdateProfileCommandInput
280284
| UpdateReviewTemplateAnswerCommandInput
@@ -315,6 +319,7 @@ export type ServiceOutputTypes =
315319
| ExportLensCommandOutput
316320
| GetAnswerCommandOutput
317321
| GetConsolidatedReportCommandOutput
322+
| GetGlobalSettingsCommandOutput
318323
| GetLensCommandOutput
319324
| GetLensReviewCommandOutput
320325
| GetLensReviewReportCommandOutput
@@ -350,6 +355,7 @@ export type ServiceOutputTypes =
350355
| UntagResourceCommandOutput
351356
| UpdateAnswerCommandOutput
352357
| UpdateGlobalSettingsCommandOutput
358+
| UpdateIntegrationCommandOutput
353359
| UpdateLensReviewCommandOutput
354360
| UpdateProfileCommandOutput
355361
| UpdateReviewTemplateAnswerCommandOutput

‎clients/client-wellarchitected/src/commands/CreateWorkloadCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,11 @@ export interface CreateWorkloadCommandOutput extends CreateWorkloadOutput, __Met
112112
* ReviewTemplateArns: [ // ReviewTemplateArns
113113
* "STRING_VALUE",
114114
* ],
115+
* JiraConfiguration: { // WorkloadJiraConfigurationInput
116+
* IssueManagementStatus: "ENABLED" || "DISABLED" || "INHERIT",
117+
* IssueManagementType: "AUTO" || "MANUAL",
118+
* JiraProjectKey: "STRING_VALUE",
119+
* },
115120
* };
116121
* const command = new CreateWorkloadCommand(input);
117122
* const response = await client.send(command);

‎clients/client-wellarchitected/src/commands/GetAnswerCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ export interface GetAnswerCommandOutput extends GetAnswerOutput, __MetadataBeare
9696
* // Risk: "UNANSWERED" || "HIGH" || "MEDIUM" || "NONE" || "NOT_APPLICABLE",
9797
* // Notes: "STRING_VALUE",
9898
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
99+
* // JiraConfiguration: { // JiraConfiguration
100+
* // JiraIssueUrl: "STRING_VALUE",
101+
* // LastSyncedTime: new Date("TIMESTAMP"),
102+
* // },
99103
* // },
100104
* // };
101105
*

‎clients/client-wellarchitected/src/commands/GetGlobalSettingsCommand.ts

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
// smithy-typescript generated code
2+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
3+
import { getSerdePlugin } from "@smithy/middleware-serde";
4+
import { Command as $Command } from "@smithy/smithy-client";
5+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
6+
7+
import { commonParams } from "../endpoint/EndpointParameters";
8+
import { GetGlobalSettingsOutput } from "../models/models_0";
9+
import { de_GetGlobalSettingsCommand, se_GetGlobalSettingsCommand } from "../protocols/Aws_restJson1";
10+
import { ServiceInputTypes, ServiceOutputTypes, WellArchitectedClientResolvedConfig } from "../WellArchitectedClient";
11+
12+
/**
13+
* @public
14+
*/
15+
export { __MetadataBearer, $Command };
16+
/**
17+
* @public
18+
*
19+
* The input for {@link GetGlobalSettingsCommand}.
20+
*/
21+
export interface GetGlobalSettingsCommandInput {}
22+
/**
23+
* @public
24+
*
25+
* The output of {@link GetGlobalSettingsCommand}.
26+
*/
27+
export interface GetGlobalSettingsCommandOutput extends GetGlobalSettingsOutput, __MetadataBearer {}
28+
29+
/**
30+
* <p>Global settings for all workloads.</p>
31+
* @example
32+
* Use a bare-bones client and the command you need to make an API call.
33+
* ```javascript
34+
* import { WellArchitectedClient, GetGlobalSettingsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
35+
* // const { WellArchitectedClient, GetGlobalSettingsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
36+
* const client = new WellArchitectedClient(config);
37+
* const input = {};
38+
* const command = new GetGlobalSettingsCommand(input);
39+
* const response = await client.send(command);
40+
* // { // GetGlobalSettingsOutput
41+
* // OrganizationSharingStatus: "ENABLED" || "DISABLED",
42+
* // DiscoveryIntegrationStatus: "ENABLED" || "DISABLED",
43+
* // JiraConfiguration: { // AccountJiraConfigurationOutput
44+
* // IntegrationStatus: "CONFIGURED" || "NOT_CONFIGURED",
45+
* // IssueManagementStatus: "ENABLED" || "DISABLED",
46+
* // IssueManagementType: "AUTO" || "MANUAL",
47+
* // Subdomain: "STRING_VALUE",
48+
* // JiraProjectKey: "STRING_VALUE",
49+
* // StatusMessage: "STRING_VALUE",
50+
* // },
51+
* // };
52+
*
53+
* ```
54+
*
55+
* @param GetGlobalSettingsCommandInput - {@link GetGlobalSettingsCommandInput}
56+
* @returns {@link GetGlobalSettingsCommandOutput}
57+
* @see {@link GetGlobalSettingsCommandInput} for command's `input` shape.
58+
* @see {@link GetGlobalSettingsCommandOutput} for command's `response` shape.
59+
* @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
60+
*
61+
* @throws {@link AccessDeniedException} (client fault)
62+
* <p>User does not have sufficient access to perform this action.</p>
63+
*
64+
* @throws {@link InternalServerException} (server fault)
65+
* <p>There is a problem with the Well-Architected Tool API service.</p>
66+
*
67+
* @throws {@link ThrottlingException} (client fault)
68+
* <p>Request was denied due to request throttling.</p>
69+
*
70+
* @throws {@link ValidationException} (client fault)
71+
* <p>The user input is not valid.</p>
72+
*
73+
* @throws {@link WellArchitectedServiceException}
74+
* <p>Base exception class for all service exceptions from WellArchitected service.</p>
75+
*
76+
* @public
77+
*/
78+
export class GetGlobalSettingsCommand extends $Command
79+
.classBuilder<
80+
GetGlobalSettingsCommandInput,
81+
GetGlobalSettingsCommandOutput,
82+
WellArchitectedClientResolvedConfig,
83+
ServiceInputTypes,
84+
ServiceOutputTypes
85+
>()
86+
.ep({
87+
...commonParams,
88+
})
89+
.m(function (this: any, Command: any, cs: any, config: WellArchitectedClientResolvedConfig, o: any) {
90+
return [
91+
getSerdePlugin(config, this.serialize, this.deserialize),
92+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
93+
];
94+
})
95+
.s("WellArchitectedApiServiceLambda", "GetGlobalSettings", {})
96+
.n("WellArchitectedClient", "GetGlobalSettingsCommand")
97+
.f(void 0, void 0)
98+
.ser(se_GetGlobalSettingsCommand)
99+
.de(de_GetGlobalSettingsCommand)
100+
.build() {}

‎clients/client-wellarchitected/src/commands/GetLensReviewCommand.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,16 @@ export interface GetLensReviewCommandOutput extends GetLensReviewOutput, __Metad
6363
* // },
6464
* // },
6565
* // ],
66+
* // JiraConfiguration: { // JiraSelectedQuestionConfiguration
67+
* // SelectedPillars: [ // SelectedPillars
68+
* // { // SelectedPillar
69+
* // PillarId: "STRING_VALUE",
70+
* // SelectedQuestionIds: [ // SelectedQuestionIds
71+
* // "STRING_VALUE",
72+
* // ],
73+
* // },
74+
* // ],
75+
* // },
6676
* // UpdatedAt: new Date("TIMESTAMP"),
6777
* // Notes: "STRING_VALUE",
6878
* // RiskCounts: {

‎clients/client-wellarchitected/src/commands/GetMilestoneCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,12 @@ export interface GetMilestoneCommandOutput extends GetMilestoneOutput, __Metadat
102102
* // PrioritizedRiskCounts: {
103103
* // "<keys>": Number("int"),
104104
* // },
105+
* // JiraConfiguration: { // WorkloadJiraConfigurationOutput
106+
* // IssueManagementStatus: "ENABLED" || "DISABLED" || "INHERIT",
107+
* // IssueManagementType: "AUTO" || "MANUAL",
108+
* // JiraProjectKey: "STRING_VALUE",
109+
* // StatusMessage: "STRING_VALUE",
110+
* // },
105111
* // },
106112
* // },
107113
* // };

‎clients/client-wellarchitected/src/commands/GetWorkloadCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ export interface GetWorkloadCommandOutput extends GetWorkloadOutput, __MetadataB
9696
* // PrioritizedRiskCounts: {
9797
* // "<keys>": Number("int"),
9898
* // },
99+
* // JiraConfiguration: { // WorkloadJiraConfigurationOutput
100+
* // IssueManagementStatus: "ENABLED" || "DISABLED" || "INHERIT",
101+
* // IssueManagementType: "AUTO" || "MANUAL",
102+
* // JiraProjectKey: "STRING_VALUE",
103+
* // StatusMessage: "STRING_VALUE",
104+
* // },
99105
* // },
100106
* // };
101107
*

‎clients/client-wellarchitected/src/commands/ListAnswersCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,10 @@ export interface ListAnswersCommandOutput extends ListAnswersOutput, __MetadataB
9595
* // Risk: "UNANSWERED" || "HIGH" || "MEDIUM" || "NONE" || "NOT_APPLICABLE",
9696
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
9797
* // QuestionType: "PRIORITIZED" || "NON_PRIORITIZED",
98+
* // JiraConfiguration: { // JiraConfiguration
99+
* // JiraIssueUrl: "STRING_VALUE",
100+
* // LastSyncedTime: new Date("TIMESTAMP"),
101+
* // },
98102
* // },
99103
* // ],
100104
* // NextToken: "STRING_VALUE",

‎clients/client-wellarchitected/src/commands/ListLensReviewImprovementsCommand.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface ListLensReviewImprovementsCommandInput extends ListLensReviewIm
2727
export interface ListLensReviewImprovementsCommandOutput extends ListLensReviewImprovementsOutput, __MetadataBearer {}
2828

2929
/**
30-
* <p>List lens review improvements.</p>
30+
* <p>List the improvements of a particular lens review.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript
@@ -64,6 +64,10 @@ export interface ListLensReviewImprovementsCommandOutput extends ListLensReviewI
6464
* // ImprovementPlanUrl: "STRING_VALUE",
6565
* // },
6666
* // ],
67+
* // JiraConfiguration: { // JiraConfiguration
68+
* // JiraIssueUrl: "STRING_VALUE",
69+
* // LastSyncedTime: new Date("TIMESTAMP"),
70+
* // },
6771
* // },
6872
* // ],
6973
* // NextToken: "STRING_VALUE",

‎clients/client-wellarchitected/src/commands/UpdateAnswerCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,10 @@ export interface UpdateAnswerCommandOutput extends UpdateAnswerOutput, __Metadat
107107
* // Risk: "UNANSWERED" || "HIGH" || "MEDIUM" || "NONE" || "NOT_APPLICABLE",
108108
* // Notes: "STRING_VALUE",
109109
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
110+
* // JiraConfiguration: { // JiraConfiguration
111+
* // JiraIssueUrl: "STRING_VALUE",
112+
* // LastSyncedTime: new Date("TIMESTAMP"),
113+
* // },
110114
* // },
111115
* // };
112116
*

‎clients/client-wellarchitected/src/commands/UpdateGlobalSettingsCommand.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface UpdateGlobalSettingsCommandInput extends UpdateGlobalSettingsIn
2727
export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {}
2828

2929
/**
30-
* <p>Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.</p>
30+
* <p>Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript
@@ -37,6 +37,12 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {}
3737
* const input = { // UpdateGlobalSettingsInput
3838
* OrganizationSharingStatus: "ENABLED" || "DISABLED",
3939
* DiscoveryIntegrationStatus: "ENABLED" || "DISABLED",
40+
* JiraConfiguration: { // AccountJiraConfigurationInput
41+
* IssueManagementStatus: "ENABLED" || "DISABLED",
42+
* IssueManagementType: "AUTO" || "MANUAL",
43+
* JiraProjectKey: "STRING_VALUE",
44+
* IntegrationStatus: "NOT_CONFIGURED",
45+
* },
4046
* };
4147
* const command = new UpdateGlobalSettingsCommand(input);
4248
* const response = await client.send(command);

0 commit comments

Comments
 (0)