@aws-sdk/client-wellarchitected 3.301.0 → 3.306.0

package/dist-types/commands/GetConsolidatedReportCommand.d.ts

@@ -0,0 +1,82 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { GetConsolidatedReportInput, GetConsolidatedReportOutput } from "../models/models_0";
+import { ServiceInputTypes, ServiceOutputTypes, WellArchitectedClientResolvedConfig } from "../WellArchitectedClient";
+/**
+ * @public
+ *
+ * The input for {@link GetConsolidatedReportCommand}.
+ */
+export interface GetConsolidatedReportCommandInput extends GetConsolidatedReportInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetConsolidatedReportCommand}.
+ */
+export interface GetConsolidatedReportCommandOutput extends GetConsolidatedReportOutput, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Get a consolidated report of your workloads.</p>
+ *          <p>You can optionally choose to include workloads that have been shared with you.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WellArchitectedClient, GetConsolidatedReportCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
+ * // const { WellArchitectedClient, GetConsolidatedReportCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
+ * const client = new WellArchitectedClient(config);
+ * const input = { // GetConsolidatedReportInput
+ *   Format: "PDF" || "JSON", // required
+ *   IncludeSharedResources: true || false,
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new GetConsolidatedReportCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param GetConsolidatedReportCommandInput - {@link GetConsolidatedReportCommandInput}
+ * @returns {@link GetConsolidatedReportCommandOutput}
+ * @see {@link GetConsolidatedReportCommandInput} for command's `input` shape.
+ * @see {@link GetConsolidatedReportCommandOutput} 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 ConflictException} (client fault)
+ *  <p>The resource has already been processed, was deleted, or is too large.</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>
+ *
+ *
+ */
+export declare class GetConsolidatedReportCommand extends $Command<GetConsolidatedReportCommandInput, GetConsolidatedReportCommandOutput, WellArchitectedClientResolvedConfig> {
+    readonly input: GetConsolidatedReportCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: GetConsolidatedReportCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: WellArchitectedClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConsolidatedReportCommandInput, GetConsolidatedReportCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/ImportLensCommand.d.ts

@@ -19,15 +19,16 @@ export interface ImportLensCommandOutput extends ImportLensOutput, __MetadataBea
 }
 /**
  * @public
- * <p>Import a new lens.</p>
- *         <p>The lens cannot be applied to workloads or shared with other Amazon Web Services accounts
- *             until it's published with <a>CreateLensVersion</a>
- *          </p>
- *         <p>Lenses are defined in JSON. For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html">JSON format specification</a>
+ * <p>Import a new custom lens or update an existing custom lens.</p>
+ *          <p>To update an existing custom lens, specify its ARN as the  <code>LensAlias</code>. If
+ *             no ARN is specified, a new custom lens is created.</p>
+ *          <p>The new or updated lens will have a status of <code>DRAFT</code>. The lens cannot be
+ *             applied to workloads or shared with other Amazon Web Services accounts until it's
+ *             published with <a>CreateLensVersion</a>.</p>
+ *          <p>Lenses are defined in JSON. For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html">JSON format specification</a>
  *             in the <i>Well-Architected Tool User Guide</i>.</p>
- *         <p>A custom lens cannot exceed 500 KB in size.</p>
- *
- *         <note>
+ *          <p>A custom lens cannot exceed 500 KB in size.</p>
+ *          <note>
  *             <p>
  *                <b>Disclaimer</b>
  *             </p>
@@ -66,7 +67,7 @@ export interface ImportLensCommandOutput extends ImportLensOutput, __MetadataBea
  *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>The resource already exists.</p>
+ *  <p>The resource has already been processed, was deleted, or is too large.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>There is a problem with the Well-Architected Tool API service.</p>

package/dist-types/commands/ListAnswersCommand.d.ts

@@ -19,7 +19,7 @@ export interface ListAnswersCommandOutput extends ListAnswersOutput, __MetadataB
 }
 /**
  * @public
- * <p>List of answers.</p>
+ * <p>List of answers for a particular workload and lens.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListLensReviewsCommand.d.ts

@@ -19,7 +19,7 @@ export interface ListLensReviewsCommandOutput extends ListLensReviewsOutput, __M
 }
 /**
  * @public
- * <p>List lens reviews.</p>
+ * <p>List lens reviews for a particular workload.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -20,7 +20,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
 /**
  * @public
  * <p>List the tags for a resource.</p>
- *         <note>
+ *          <note>
  *             <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p>
  *          </note>
  * @example

package/dist-types/commands/ListWorkloadsCommand.d.ts

@@ -19,7 +19,7 @@ export interface ListWorkloadsCommandOutput extends ListWorkloadsOutput, __Metad
 }
 /**
  * @public
- * <p>List workloads. Paginated.</p>
+ * <p>Paginated list of workloads.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/TagResourceCommand.d.ts

@@ -20,7 +20,7 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
 /**
  * @public
  * <p>Adds one or more tags to the specified resource.</p>
- *         <note>
+ *          <note>
  *             <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p>
  *          </note>
  * @example

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -20,12 +20,11 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
 /**
  * @public
  * <p>Deletes specified tags from a resource.</p>
- *         <note>
+ *          <note>
  *             <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p>
  *          </note>
- *
- *         <p>To specify multiple tags, use separate <b>tagKeys</b> parameters, for example:</p>
- *         <p>
+ *          <p>To specify multiple tags, use separate <b>tagKeys</b> parameters, for example:</p>
+ *          <p>
  *             <code>DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2</code>
  *          </p>
  * @example

package/dist-types/commands/UpdateAnswerCommand.d.ts

@@ -58,7 +58,7 @@ export interface UpdateAnswerCommandOutput extends UpdateAnswerOutput, __Metadat
  *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>The resource already exists.</p>
+ *  <p>The resource has already been processed, was deleted, or is too large.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>There is a problem with the Well-Architected Tool API service.</p>

package/dist-types/commands/UpdateGlobalSettingsCommand.d.ts

@@ -43,7 +43,7 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {
  *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>The resource already exists.</p>
+ *  <p>The resource has already been processed, was deleted, or is too large.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>There is a problem with the Well-Architected Tool API service.</p>

package/dist-types/commands/UpdateLensReviewCommand.d.ts

@@ -19,7 +19,7 @@ export interface UpdateLensReviewCommandOutput extends UpdateLensReviewOutput, _
 }
 /**
  * @public
- * <p>Update lens review.</p>
+ * <p>Update lens review for a particular workload.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -48,7 +48,7 @@ export interface UpdateLensReviewCommandOutput extends UpdateLensReviewOutput, _
  *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>The resource already exists.</p>
+ *  <p>The resource has already been processed, was deleted, or is too large.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>There is a problem with the Well-Architected Tool API service.</p>

package/dist-types/commands/UpdateShareInvitationCommand.d.ts

@@ -20,7 +20,7 @@ export interface UpdateShareInvitationCommandOutput extends UpdateShareInvitatio
 /**
  * @public
  * <p>Update a workload or custom lens share invitation.</p>
- *         <note>
+ *          <note>
  *             <p>This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.</p>
  *          </note>
  * @example
@@ -47,7 +47,7 @@ export interface UpdateShareInvitationCommandOutput extends UpdateShareInvitatio
  *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>The resource already exists.</p>
+ *  <p>The resource has already been processed, was deleted, or is too large.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>There is a problem with the Well-Architected Tool API service.</p>

package/dist-types/commands/UpdateWorkloadCommand.d.ts

@@ -71,7 +71,7 @@ export interface UpdateWorkloadCommandOutput extends UpdateWorkloadOutput, __Met
  *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>The resource already exists.</p>
+ *  <p>The resource has already been processed, was deleted, or is too large.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>There is a problem with the Well-Architected Tool API service.</p>

package/dist-types/commands/UpdateWorkloadShareCommand.d.ts

@@ -45,7 +45,7 @@ export interface UpdateWorkloadShareCommandOutput extends UpdateWorkloadShareOut
  *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>The resource already exists.</p>
+ *  <p>The resource has already been processed, was deleted, or is too large.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>There is a problem with the Well-Architected Tool API service.</p>

package/dist-types/commands/UpgradeLensReviewCommand.d.ts

@@ -19,7 +19,7 @@ export interface UpgradeLensReviewCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Upgrade lens review.</p>
+ * <p>Upgrade lens review for a particular workload.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -46,7 +46,7 @@ export interface UpgradeLensReviewCommandOutput extends __MetadataBearer {
  *  <p>User does not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>The resource already exists.</p>
+ *  <p>The resource has already been processed, was deleted, or is too large.</p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>There is a problem with the Well-Architected Tool API service.</p>

package/dist-types/commands/index.d.ts

@@ -11,6 +11,7 @@ export * from "./DeleteWorkloadShareCommand";
 export * from "./DisassociateLensesCommand";
 export * from "./ExportLensCommand";
 export * from "./GetAnswerCommand";
+export * from "./GetConsolidatedReportCommand";
 export * from "./GetLensCommand";
 export * from "./GetLensReviewCommand";
 export * from "./GetLensReviewReportCommand";