Skip to content

Commit

Permalink
feat(client-wellarchitected): AWS Well-Architected now has a Connecto…
Browse files Browse the repository at this point in the history
…r for Jira to allow customers to efficiently track workload risks and improvement efforts and create closed-loop mechanisms.
  • Loading branch information
awstools committed Apr 16, 2024
1 parent 639c711 commit aa902b4
Show file tree
Hide file tree
Showing 22 changed files with 1,470 additions and 33 deletions.
16 changes: 16 additions & 0 deletions clients/client-wellarchitected/README.md
Expand Up @@ -400,6 +400,14 @@ GetConsolidatedReport

[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/)

</details>
<details>
<summary>
GetGlobalSettings
</summary>

[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/)

</details>
<details>
<summary>
Expand Down Expand Up @@ -680,6 +688,14 @@ UpdateGlobalSettings

[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/)

</details>
<details>
<summary>
UpdateIntegration
</summary>

[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/)

</details>
<details>
<summary>
Expand Down
47 changes: 47 additions & 0 deletions clients/client-wellarchitected/src/WellArchitected.ts
Expand Up @@ -110,6 +110,11 @@ import {
GetConsolidatedReportCommandInput,
GetConsolidatedReportCommandOutput,
} from "./commands/GetConsolidatedReportCommand";
import {
GetGlobalSettingsCommand,
GetGlobalSettingsCommandInput,
GetGlobalSettingsCommandOutput,
} from "./commands/GetGlobalSettingsCommand";
import { GetLensCommand, GetLensCommandInput, GetLensCommandOutput } from "./commands/GetLensCommand";
import {
GetLensReviewCommand,
Expand Down Expand Up @@ -257,6 +262,11 @@ import {
UpdateGlobalSettingsCommandInput,
UpdateGlobalSettingsCommandOutput,
} from "./commands/UpdateGlobalSettingsCommand";
import {
UpdateIntegrationCommand,
UpdateIntegrationCommandInput,
UpdateIntegrationCommandOutput,
} from "./commands/UpdateIntegrationCommand";
import {
UpdateLensReviewCommand,
UpdateLensReviewCommandInput,
Expand Down Expand Up @@ -339,6 +349,7 @@ const commands = {
ExportLensCommand,
GetAnswerCommand,
GetConsolidatedReportCommand,
GetGlobalSettingsCommand,
GetLensCommand,
GetLensReviewCommand,
GetLensReviewReportCommand,
Expand Down Expand Up @@ -374,6 +385,7 @@ const commands = {
UntagResourceCommand,
UpdateAnswerCommand,
UpdateGlobalSettingsCommand,
UpdateIntegrationCommand,
UpdateLensReviewCommand,
UpdateProfileCommand,
UpdateReviewTemplateCommand,
Expand Down Expand Up @@ -748,6 +760,24 @@ export interface WellArchitected {
cb: (err: any, data?: GetConsolidatedReportCommandOutput) => void
): void;

/**
* @see {@link GetGlobalSettingsCommand}
*/
getGlobalSettings(): Promise<GetGlobalSettingsCommandOutput>;
getGlobalSettings(
args: GetGlobalSettingsCommandInput,
options?: __HttpHandlerOptions
): Promise<GetGlobalSettingsCommandOutput>;
getGlobalSettings(
args: GetGlobalSettingsCommandInput,
cb: (err: any, data?: GetGlobalSettingsCommandOutput) => void
): void;
getGlobalSettings(
args: GetGlobalSettingsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetGlobalSettingsCommandOutput) => void
): void;

/**
* @see {@link GetLensCommand}
*/
Expand Down Expand Up @@ -1265,6 +1295,23 @@ export interface WellArchitected {
cb: (err: any, data?: UpdateGlobalSettingsCommandOutput) => void
): void;

/**
* @see {@link UpdateIntegrationCommand}
*/
updateIntegration(
args: UpdateIntegrationCommandInput,
options?: __HttpHandlerOptions
): Promise<UpdateIntegrationCommandOutput>;
updateIntegration(
args: UpdateIntegrationCommandInput,
cb: (err: any, data?: UpdateIntegrationCommandOutput) => void
): void;
updateIntegration(
args: UpdateIntegrationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: UpdateIntegrationCommandOutput) => void
): void;

/**
* @see {@link UpdateLensReviewCommand}
*/
Expand Down
6 changes: 6 additions & 0 deletions clients/client-wellarchitected/src/WellArchitectedClient.ts
Expand Up @@ -101,6 +101,7 @@ import {
GetConsolidatedReportCommandInput,
GetConsolidatedReportCommandOutput,
} from "./commands/GetConsolidatedReportCommand";
import { GetGlobalSettingsCommandInput, GetGlobalSettingsCommandOutput } from "./commands/GetGlobalSettingsCommand";
import { GetLensCommandInput, GetLensCommandOutput } from "./commands/GetLensCommand";
import { GetLensReviewCommandInput, GetLensReviewCommandOutput } from "./commands/GetLensReviewCommand";
import {
Expand Down Expand Up @@ -169,6 +170,7 @@ import {
UpdateGlobalSettingsCommandInput,
UpdateGlobalSettingsCommandOutput,
} from "./commands/UpdateGlobalSettingsCommand";
import { UpdateIntegrationCommandInput, UpdateIntegrationCommandOutput } from "./commands/UpdateIntegrationCommand";
import { UpdateLensReviewCommandInput, UpdateLensReviewCommandOutput } from "./commands/UpdateLensReviewCommand";
import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./commands/UpdateProfileCommand";
import {
Expand Down Expand Up @@ -240,6 +242,7 @@ export type ServiceInputTypes =
| ExportLensCommandInput
| GetAnswerCommandInput
| GetConsolidatedReportCommandInput
| GetGlobalSettingsCommandInput
| GetLensCommandInput
| GetLensReviewCommandInput
| GetLensReviewReportCommandInput
Expand Down Expand Up @@ -275,6 +278,7 @@ export type ServiceInputTypes =
| UntagResourceCommandInput
| UpdateAnswerCommandInput
| UpdateGlobalSettingsCommandInput
| UpdateIntegrationCommandInput
| UpdateLensReviewCommandInput
| UpdateProfileCommandInput
| UpdateReviewTemplateAnswerCommandInput
Expand Down Expand Up @@ -315,6 +319,7 @@ export type ServiceOutputTypes =
| ExportLensCommandOutput
| GetAnswerCommandOutput
| GetConsolidatedReportCommandOutput
| GetGlobalSettingsCommandOutput
| GetLensCommandOutput
| GetLensReviewCommandOutput
| GetLensReviewReportCommandOutput
Expand Down Expand Up @@ -350,6 +355,7 @@ export type ServiceOutputTypes =
| UntagResourceCommandOutput
| UpdateAnswerCommandOutput
| UpdateGlobalSettingsCommandOutput
| UpdateIntegrationCommandOutput
| UpdateLensReviewCommandOutput
| UpdateProfileCommandOutput
| UpdateReviewTemplateAnswerCommandOutput
Expand Down
Expand Up @@ -112,6 +112,11 @@ export interface CreateWorkloadCommandOutput extends CreateWorkloadOutput, __Met
* ReviewTemplateArns: [ // ReviewTemplateArns
* "STRING_VALUE",
* ],
* JiraConfiguration: { // WorkloadJiraConfigurationInput
* IssueManagementStatus: "ENABLED" || "DISABLED" || "INHERIT",
* IssueManagementType: "AUTO" || "MANUAL",
* JiraProjectKey: "STRING_VALUE",
* },
* };
* const command = new CreateWorkloadCommand(input);
* const response = await client.send(command);
Expand Down
Expand Up @@ -96,6 +96,10 @@ export interface GetAnswerCommandOutput extends GetAnswerOutput, __MetadataBeare
* // Risk: "UNANSWERED" || "HIGH" || "MEDIUM" || "NONE" || "NOT_APPLICABLE",
* // Notes: "STRING_VALUE",
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
* // JiraConfiguration: { // JiraConfiguration
* // JiraIssueUrl: "STRING_VALUE",
* // LastSyncedTime: new Date("TIMESTAMP"),
* // },
* // },
* // };
*
Expand Down
@@ -0,0 +1,100 @@
// smithy-typescript generated code
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
import { getSerdePlugin } from "@smithy/middleware-serde";
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { commonParams } from "../endpoint/EndpointParameters";
import { GetGlobalSettingsOutput } from "../models/models_0";
import { de_GetGlobalSettingsCommand, se_GetGlobalSettingsCommand } from "../protocols/Aws_restJson1";
import { ServiceInputTypes, ServiceOutputTypes, WellArchitectedClientResolvedConfig } from "../WellArchitectedClient";

/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link GetGlobalSettingsCommand}.
*/
export interface GetGlobalSettingsCommandInput {}
/**
* @public
*
* The output of {@link GetGlobalSettingsCommand}.
*/
export interface GetGlobalSettingsCommandOutput extends GetGlobalSettingsOutput, __MetadataBearer {}

/**
* <p>Global settings for all workloads.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { WellArchitectedClient, GetGlobalSettingsCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
* // const { WellArchitectedClient, GetGlobalSettingsCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
* const client = new WellArchitectedClient(config);
* const input = {};
* const command = new GetGlobalSettingsCommand(input);
* const response = await client.send(command);
* // { // GetGlobalSettingsOutput
* // OrganizationSharingStatus: "ENABLED" || "DISABLED",
* // DiscoveryIntegrationStatus: "ENABLED" || "DISABLED",
* // JiraConfiguration: { // AccountJiraConfigurationOutput
* // IntegrationStatus: "CONFIGURED" || "NOT_CONFIGURED",
* // IssueManagementStatus: "ENABLED" || "DISABLED",
* // IssueManagementType: "AUTO" || "MANUAL",
* // Subdomain: "STRING_VALUE",
* // JiraProjectKey: "STRING_VALUE",
* // StatusMessage: "STRING_VALUE",
* // },
* // };
*
* ```
*
* @param GetGlobalSettingsCommandInput - {@link GetGlobalSettingsCommandInput}
* @returns {@link GetGlobalSettingsCommandOutput}
* @see {@link GetGlobalSettingsCommandInput} for command's `input` shape.
* @see {@link GetGlobalSettingsCommandOutput} for command's `response` shape.
* @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
*
* @throws {@link AccessDeniedException} (client fault)
* <p>User does not have sufficient access to perform this action.</p>
*
* @throws {@link InternalServerException} (server fault)
* <p>There is a problem with the Well-Architected Tool API service.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>Request was denied due to request throttling.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>The user input is not valid.</p>
*
* @throws {@link WellArchitectedServiceException}
* <p>Base exception class for all service exceptions from WellArchitected service.</p>
*
* @public
*/
export class GetGlobalSettingsCommand extends $Command
.classBuilder<
GetGlobalSettingsCommandInput,
GetGlobalSettingsCommandOutput,
WellArchitectedClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes
>()
.ep({
...commonParams,
})
.m(function (this: any, Command: any, cs: any, config: WellArchitectedClientResolvedConfig, o: any) {
return [
getSerdePlugin(config, this.serialize, this.deserialize),
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
];
})
.s("WellArchitectedApiServiceLambda", "GetGlobalSettings", {})
.n("WellArchitectedClient", "GetGlobalSettingsCommand")
.f(void 0, void 0)
.ser(se_GetGlobalSettingsCommand)
.de(de_GetGlobalSettingsCommand)
.build() {}
Expand Up @@ -63,6 +63,16 @@ export interface GetLensReviewCommandOutput extends GetLensReviewOutput, __Metad
* // },
* // },
* // ],
* // JiraConfiguration: { // JiraSelectedQuestionConfiguration
* // SelectedPillars: [ // SelectedPillars
* // { // SelectedPillar
* // PillarId: "STRING_VALUE",
* // SelectedQuestionIds: [ // SelectedQuestionIds
* // "STRING_VALUE",
* // ],
* // },
* // ],
* // },
* // UpdatedAt: new Date("TIMESTAMP"),
* // Notes: "STRING_VALUE",
* // RiskCounts: {
Expand Down
Expand Up @@ -102,6 +102,12 @@ export interface GetMilestoneCommandOutput extends GetMilestoneOutput, __Metadat
* // PrioritizedRiskCounts: {
* // "<keys>": Number("int"),
* // },
* // JiraConfiguration: { // WorkloadJiraConfigurationOutput
* // IssueManagementStatus: "ENABLED" || "DISABLED" || "INHERIT",
* // IssueManagementType: "AUTO" || "MANUAL",
* // JiraProjectKey: "STRING_VALUE",
* // StatusMessage: "STRING_VALUE",
* // },
* // },
* // },
* // };
Expand Down
Expand Up @@ -96,6 +96,12 @@ export interface GetWorkloadCommandOutput extends GetWorkloadOutput, __MetadataB
* // PrioritizedRiskCounts: {
* // "<keys>": Number("int"),
* // },
* // JiraConfiguration: { // WorkloadJiraConfigurationOutput
* // IssueManagementStatus: "ENABLED" || "DISABLED" || "INHERIT",
* // IssueManagementType: "AUTO" || "MANUAL",
* // JiraProjectKey: "STRING_VALUE",
* // StatusMessage: "STRING_VALUE",
* // },
* // },
* // };
*
Expand Down
Expand Up @@ -95,6 +95,10 @@ export interface ListAnswersCommandOutput extends ListAnswersOutput, __MetadataB
* // Risk: "UNANSWERED" || "HIGH" || "MEDIUM" || "NONE" || "NOT_APPLICABLE",
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
* // QuestionType: "PRIORITIZED" || "NON_PRIORITIZED",
* // JiraConfiguration: { // JiraConfiguration
* // JiraIssueUrl: "STRING_VALUE",
* // LastSyncedTime: new Date("TIMESTAMP"),
* // },
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
Expand Up @@ -27,7 +27,7 @@ export interface ListLensReviewImprovementsCommandInput extends ListLensReviewIm
export interface ListLensReviewImprovementsCommandOutput extends ListLensReviewImprovementsOutput, __MetadataBearer {}

/**
* <p>List lens review improvements.</p>
* <p>List the improvements of a particular lens review.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down Expand Up @@ -64,6 +64,10 @@ export interface ListLensReviewImprovementsCommandOutput extends ListLensReviewI
* // ImprovementPlanUrl: "STRING_VALUE",
* // },
* // ],
* // JiraConfiguration: { // JiraConfiguration
* // JiraIssueUrl: "STRING_VALUE",
* // LastSyncedTime: new Date("TIMESTAMP"),
* // },
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
Expand Up @@ -107,6 +107,10 @@ export interface UpdateAnswerCommandOutput extends UpdateAnswerOutput, __Metadat
* // Risk: "UNANSWERED" || "HIGH" || "MEDIUM" || "NONE" || "NOT_APPLICABLE",
* // Notes: "STRING_VALUE",
* // Reason: "OUT_OF_SCOPE" || "BUSINESS_PRIORITIES" || "ARCHITECTURE_CONSTRAINTS" || "OTHER" || "NONE",
* // JiraConfiguration: { // JiraConfiguration
* // JiraIssueUrl: "STRING_VALUE",
* // LastSyncedTime: new Date("TIMESTAMP"),
* // },
* // },
* // };
*
Expand Down
Expand Up @@ -27,7 +27,7 @@ export interface UpdateGlobalSettingsCommandInput extends UpdateGlobalSettingsIn
export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {}

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

0 comments on commit aa902b4

Please sign in to comment.