@aws-sdk/client-wellarchitected 3.1107.0 → 3.1109.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/README.md +162 -6
  2. package/dist-cjs/index.js +1125 -107
  3. package/dist-es/WellArchitected.js +58 -0
  4. package/dist-es/commands/CreateAgentContextCommand.js +4 -0
  5. package/dist-es/commands/CreateAgentGoalCommand.js +4 -0
  6. package/dist-es/commands/CreateAgentProfileCommand.js +4 -0
  7. package/dist-es/commands/DeleteAgentContextCommand.js +4 -0
  8. package/dist-es/commands/DeleteAgentGoalCommand.js +4 -0
  9. package/dist-es/commands/DeleteAgentProfileCommand.js +4 -0
  10. package/dist-es/commands/GetAgentContextCommand.js +4 -0
  11. package/dist-es/commands/GetAgentGoalCommand.js +4 -0
  12. package/dist-es/commands/GetAgentProfileCommand.js +4 -0
  13. package/dist-es/commands/GetAgentRecommendationCommand.js +4 -0
  14. package/dist-es/commands/GetAgentRecommendationGenerationCommand.js +4 -0
  15. package/dist-es/commands/ListAgentContextsCommand.js +4 -0
  16. package/dist-es/commands/ListAgentGoalsCommand.js +4 -0
  17. package/dist-es/commands/ListAgentProfilesCommand.js +4 -0
  18. package/dist-es/commands/ListAgentRecommendationGenerationsCommand.js +4 -0
  19. package/dist-es/commands/ListAgentRecommendationItemsCommand.js +4 -0
  20. package/dist-es/commands/ListAgentRecommendationsCommand.js +4 -0
  21. package/dist-es/commands/PutAgentRecommendationFeedbackCommand.js +4 -0
  22. package/dist-es/commands/StartAgentRecommendationGenerationCommand.js +4 -0
  23. package/dist-es/commands/UpdateAgentContextCommand.js +4 -0
  24. package/dist-es/commands/UpdateAgentGoalCommand.js +4 -0
  25. package/dist-es/commands/UpdateAgentProfileCommand.js +4 -0
  26. package/dist-es/commands/UpdateAgentRecommendationStatusCommand.js +4 -0
  27. package/dist-es/commands/index.js +23 -0
  28. package/dist-es/models/enums.js +92 -0
  29. package/dist-es/pagination/ListAgentContextsPaginator.js +4 -0
  30. package/dist-es/pagination/ListAgentGoalsPaginator.js +4 -0
  31. package/dist-es/pagination/ListAgentProfilesPaginator.js +4 -0
  32. package/dist-es/pagination/ListAgentRecommendationGenerationsPaginator.js +4 -0
  33. package/dist-es/pagination/ListAgentRecommendationItemsPaginator.js +4 -0
  34. package/dist-es/pagination/ListAgentRecommendationsPaginator.js +4 -0
  35. package/dist-es/pagination/index.js +6 -0
  36. package/dist-es/schemas/schemas_0.js +799 -106
  37. package/dist-types/WellArchitected.d.ts +205 -6
  38. package/dist-types/WellArchitectedClient.d.ts +26 -8
  39. package/dist-types/commands/AssociateLensesCommand.d.ts +1 -11
  40. package/dist-types/commands/CreateAgentContextCommand.d.ts +158 -0
  41. package/dist-types/commands/CreateAgentGoalCommand.d.ts +110 -0
  42. package/dist-types/commands/CreateAgentProfileCommand.d.ts +146 -0
  43. package/dist-types/commands/CreateLensShareCommand.d.ts +1 -21
  44. package/dist-types/commands/CreateLensVersionCommand.d.ts +1 -7
  45. package/dist-types/commands/CreateReviewTemplateCommand.d.ts +1 -12
  46. package/dist-types/commands/CreateTemplateShareCommand.d.ts +1 -15
  47. package/dist-types/commands/CreateWorkloadCommand.d.ts +1 -36
  48. package/dist-types/commands/CreateWorkloadShareCommand.d.ts +1 -8
  49. package/dist-types/commands/DeleteAgentContextCommand.d.ts +85 -0
  50. package/dist-types/commands/DeleteAgentGoalCommand.d.ts +85 -0
  51. package/dist-types/commands/DeleteAgentProfileCommand.d.ts +87 -0
  52. package/dist-types/commands/DeleteLensCommand.d.ts +1 -15
  53. package/dist-types/commands/DeleteLensShareCommand.d.ts +1 -15
  54. package/dist-types/commands/DeleteProfileCommand.d.ts +1 -12
  55. package/dist-types/commands/DeleteReviewTemplateCommand.d.ts +1 -5
  56. package/dist-types/commands/DeleteTemplateShareCommand.d.ts +1 -4
  57. package/dist-types/commands/DisassociateLensesCommand.d.ts +1 -6
  58. package/dist-types/commands/ExportLensCommand.d.ts +1 -16
  59. package/dist-types/commands/GetAgentContextCommand.d.ts +124 -0
  60. package/dist-types/commands/GetAgentGoalCommand.d.ts +99 -0
  61. package/dist-types/commands/GetAgentProfileCommand.d.ts +119 -0
  62. package/dist-types/commands/GetAgentRecommendationCommand.d.ts +188 -0
  63. package/dist-types/commands/GetAgentRecommendationGenerationCommand.d.ts +123 -0
  64. package/dist-types/commands/GetConsolidatedReportCommand.d.ts +1 -2
  65. package/dist-types/commands/ImportLensCommand.d.ts +1 -20
  66. package/dist-types/commands/ListAgentContextsCommand.d.ts +125 -0
  67. package/dist-types/commands/ListAgentGoalsCommand.d.ts +100 -0
  68. package/dist-types/commands/ListAgentProfilesCommand.d.ts +122 -0
  69. package/dist-types/commands/ListAgentRecommendationGenerationsCommand.d.ts +102 -0
  70. package/dist-types/commands/ListAgentRecommendationItemsCommand.d.ts +101 -0
  71. package/dist-types/commands/ListAgentRecommendationsCommand.d.ts +124 -0
  72. package/dist-types/commands/ListShareInvitationsCommand.d.ts +1 -5
  73. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -4
  74. package/dist-types/commands/PutAgentRecommendationFeedbackCommand.d.ts +87 -0
  75. package/dist-types/commands/StartAgentRecommendationGenerationCommand.d.ts +118 -0
  76. package/dist-types/commands/TagResourceCommand.d.ts +1 -4
  77. package/dist-types/commands/UntagResourceCommand.d.ts +1 -8
  78. package/dist-types/commands/UpdateAgentContextCommand.d.ts +152 -0
  79. package/dist-types/commands/UpdateAgentGoalCommand.d.ts +105 -0
  80. package/dist-types/commands/UpdateAgentProfileCommand.d.ts +137 -0
  81. package/dist-types/commands/UpdateAgentRecommendationStatusCommand.d.ts +86 -0
  82. package/dist-types/commands/UpdateShareInvitationCommand.d.ts +1 -4
  83. package/dist-types/commands/index.d.ts +23 -0
  84. package/dist-types/index.d.ts +1 -6
  85. package/dist-types/models/enums.d.ts +228 -0
  86. package/dist-types/models/models_0.d.ts +2830 -1786
  87. package/dist-types/pagination/ListAgentContextsPaginator.d.ts +7 -0
  88. package/dist-types/pagination/ListAgentGoalsPaginator.d.ts +7 -0
  89. package/dist-types/pagination/ListAgentProfilesPaginator.d.ts +7 -0
  90. package/dist-types/pagination/ListAgentRecommendationGenerationsPaginator.d.ts +7 -0
  91. package/dist-types/pagination/ListAgentRecommendationItemsPaginator.d.ts +7 -0
  92. package/dist-types/pagination/ListAgentRecommendationsPaginator.d.ts +7 -0
  93. package/dist-types/pagination/index.d.ts +6 -0
  94. package/dist-types/schemas/schemas_0.d.ts +92 -0
  95. package/dist-types/ts3.4/WellArchitected.d.ts +434 -0
  96. package/dist-types/ts3.4/WellArchitectedClient.d.ts +138 -0
  97. package/dist-types/ts3.4/commands/CreateAgentContextCommand.d.ts +39 -0
  98. package/dist-types/ts3.4/commands/CreateAgentGoalCommand.d.ts +38 -0
  99. package/dist-types/ts3.4/commands/CreateAgentProfileCommand.d.ts +39 -0
  100. package/dist-types/ts3.4/commands/DeleteAgentContextCommand.d.ts +39 -0
  101. package/dist-types/ts3.4/commands/DeleteAgentGoalCommand.d.ts +38 -0
  102. package/dist-types/ts3.4/commands/DeleteAgentProfileCommand.d.ts +39 -0
  103. package/dist-types/ts3.4/commands/GetAgentContextCommand.d.ts +38 -0
  104. package/dist-types/ts3.4/commands/GetAgentGoalCommand.d.ts +38 -0
  105. package/dist-types/ts3.4/commands/GetAgentProfileCommand.d.ts +38 -0
  106. package/dist-types/ts3.4/commands/GetAgentRecommendationCommand.d.ts +39 -0
  107. package/dist-types/ts3.4/commands/GetAgentRecommendationGenerationCommand.d.ts +42 -0
  108. package/dist-types/ts3.4/commands/ListAgentContextsCommand.d.ts +39 -0
  109. package/dist-types/ts3.4/commands/ListAgentGoalsCommand.d.ts +38 -0
  110. package/dist-types/ts3.4/commands/ListAgentProfilesCommand.d.ts +39 -0
  111. package/dist-types/ts3.4/commands/ListAgentRecommendationGenerationsCommand.d.ts +42 -0
  112. package/dist-types/ts3.4/commands/ListAgentRecommendationItemsCommand.d.ts +42 -0
  113. package/dist-types/ts3.4/commands/ListAgentRecommendationsCommand.d.ts +42 -0
  114. package/dist-types/ts3.4/commands/PutAgentRecommendationFeedbackCommand.d.ts +42 -0
  115. package/dist-types/ts3.4/commands/StartAgentRecommendationGenerationCommand.d.ts +42 -0
  116. package/dist-types/ts3.4/commands/UpdateAgentContextCommand.d.ts +39 -0
  117. package/dist-types/ts3.4/commands/UpdateAgentGoalCommand.d.ts +38 -0
  118. package/dist-types/ts3.4/commands/UpdateAgentProfileCommand.d.ts +39 -0
  119. package/dist-types/ts3.4/commands/UpdateAgentRecommendationStatusCommand.d.ts +42 -0
  120. package/dist-types/ts3.4/commands/index.d.ts +23 -0
  121. package/dist-types/ts3.4/models/enums.d.ts +111 -0
  122. package/dist-types/ts3.4/models/models_0.d.ts +494 -0
  123. package/dist-types/ts3.4/pagination/ListAgentContextsPaginator.d.ts +11 -0
  124. package/dist-types/ts3.4/pagination/ListAgentGoalsPaginator.d.ts +11 -0
  125. package/dist-types/ts3.4/pagination/ListAgentProfilesPaginator.d.ts +11 -0
  126. package/dist-types/ts3.4/pagination/ListAgentRecommendationGenerationsPaginator.d.ts +11 -0
  127. package/dist-types/ts3.4/pagination/ListAgentRecommendationItemsPaginator.d.ts +11 -0
  128. package/dist-types/ts3.4/pagination/ListAgentRecommendationsPaginator.d.ts +11 -0
  129. package/dist-types/ts3.4/pagination/index.d.ts +6 -0
  130. package/dist-types/ts3.4/schemas/schemas_0.d.ts +92 -0
  131. package/package.json +6 -6
@@ -0,0 +1,87 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { DeleteAgentProfileRequest, DeleteAgentProfileResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link DeleteAgentProfileCommand}.
11
+ */
12
+ export interface DeleteAgentProfileCommandInput extends DeleteAgentProfileRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link DeleteAgentProfileCommand}.
18
+ */
19
+ export interface DeleteAgentProfileCommandOutput extends DeleteAgentProfileResponse, __MetadataBearer {
20
+ }
21
+ declare const DeleteAgentProfileCommand_base: {
22
+ new (input: DeleteAgentProfileCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentProfileCommandInput, DeleteAgentProfileCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: DeleteAgentProfileCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentProfileCommandInput, DeleteAgentProfileCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Deletes an optimization profile and its associated configuration. This action cannot be undone.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { WellArchitectedClient, DeleteAgentProfileCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
32
+ * // const { WellArchitectedClient, DeleteAgentProfileCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
33
+ * // import type { WellArchitectedClientConfig } from "@aws-sdk/client-wellarchitected";
34
+ * const config = {}; // type is WellArchitectedClientConfig
35
+ * const client = new WellArchitectedClient(config);
36
+ * const input = { // DeleteAgentProfileRequest
37
+ * profileArn: "STRING_VALUE", // required
38
+ * };
39
+ * const command = new DeleteAgentProfileCommand(input);
40
+ * const response = await client.send(command);
41
+ * // {};
42
+ *
43
+ * ```
44
+ *
45
+ * @param DeleteAgentProfileCommandInput - {@link DeleteAgentProfileCommandInput}
46
+ * @returns {@link DeleteAgentProfileCommandOutput}
47
+ * @see {@link DeleteAgentProfileCommandInput} for command's `input` shape.
48
+ * @see {@link DeleteAgentProfileCommandOutput} for command's `response` shape.
49
+ * @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
50
+ *
51
+ * @throws {@link AccessDeniedException} (client fault)
52
+ * <p>User does not have sufficient access to perform this action.</p>
53
+ *
54
+ * @throws {@link ConflictException} (client fault)
55
+ * <p>The resource has already been processed, was deleted, or is too large.</p>
56
+ *
57
+ * @throws {@link InternalServerException} (server fault)
58
+ * <p>There is a problem with the Well-Architected Tool API service.</p>
59
+ *
60
+ * @throws {@link ResourceNotFoundException} (client fault)
61
+ * <p>The requested resource was not found.</p>
62
+ *
63
+ * @throws {@link ThrottlingException} (client fault)
64
+ * <p>Request was denied due to request throttling.</p>
65
+ *
66
+ * @throws {@link ValidationException} (client fault)
67
+ * <p>The user input is not valid.</p>
68
+ *
69
+ * @throws {@link WellArchitectedServiceException}
70
+ * <p>Base exception class for all service exceptions from WellArchitected service.</p>
71
+ *
72
+ *
73
+ * @public
74
+ */
75
+ export declare class DeleteAgentProfileCommand extends DeleteAgentProfileCommand_base {
76
+ /** @internal type navigation helper, not in runtime. */
77
+ protected static __types: {
78
+ api: {
79
+ input: DeleteAgentProfileRequest;
80
+ output: {};
81
+ };
82
+ sdk: {
83
+ input: DeleteAgentProfileCommandInput;
84
+ output: DeleteAgentProfileCommandOutput;
85
+ };
86
+ };
87
+ }
@@ -24,21 +24,7 @@ declare const DeleteLensCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Delete an existing lens.</p>
28
- * <p>Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users
29
- * that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
30
- * </p>
31
- * <note>
32
- * <p>
33
- * <b>Disclaimer</b>
34
- * </p>
35
- * <p>By sharing your custom lenses with other Amazon Web Services accounts,
36
- * you acknowledge that Amazon Web Services will make your custom lenses available to those
37
- * other accounts. Those other accounts may continue to access and use your
38
- * shared custom lenses even if you delete the custom lenses
39
- * from your own Amazon Web Services account or terminate
40
- * your Amazon Web Services account.</p>
41
- * </note>
27
+ * <p>Delete an existing lens.</p> <p>Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads. </p> <note> <p> <b>Disclaimer</b> </p> <p>By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.</p> </note>
42
28
  * @example
43
29
  * Use a bare-bones client and the command you need to make an API call.
44
30
  * ```javascript
@@ -24,21 +24,7 @@ declare const DeleteLensShareCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Delete a lens share.</p>
28
- * <p>After the lens share is deleted, Amazon Web Services accounts, users, organizations,
29
- * and organizational units (OUs)
30
- * that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.</p>
31
- * <note>
32
- * <p>
33
- * <b>Disclaimer</b>
34
- * </p>
35
- * <p>By sharing your custom lenses with other Amazon Web Services accounts,
36
- * you acknowledge that Amazon Web Services will make your custom lenses available to those
37
- * other accounts. Those other accounts may continue to access and use your
38
- * shared custom lenses even if you delete the custom lenses
39
- * from your own Amazon Web Services account or terminate
40
- * your Amazon Web Services account.</p>
41
- * </note>
27
+ * <p>Delete a lens share.</p> <p>After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.</p> <note> <p> <b>Disclaimer</b> </p> <p>By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.</p> </note>
42
28
  * @example
43
29
  * Use a bare-bones client and the command you need to make an API call.
44
30
  * ```javascript
@@ -24,18 +24,7 @@ declare const DeleteProfileCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Delete a profile.</p>
28
- * <note>
29
- * <p>
30
- * <b>Disclaimer</b>
31
- * </p>
32
- * <p>By sharing your profile with other Amazon Web Services accounts,
33
- * you acknowledge that Amazon Web Services will make your profile available to those
34
- * other accounts. Those other accounts may continue to access and use your
35
- * shared profile even if you delete the profile
36
- * from your own Amazon Web Services account or terminate
37
- * your Amazon Web Services account.</p>
38
- * </note>
27
+ * <p>Delete a profile.</p> <note> <p> <b>Disclaimer</b> </p> <p>By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.</p> </note>
39
28
  * @example
40
29
  * Use a bare-bones client and the command you need to make an API call.
41
30
  * ```javascript
@@ -24,11 +24,7 @@ declare const DeleteReviewTemplateCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Delete a review template.</p>
28
- * <p>Only the owner of a review template can delete it.</p>
29
- * <p>After the review template is deleted, Amazon Web Services accounts, users,
30
- * organizations, and organizational units (OUs) that you shared the review template with
31
- * will no longer be able to apply it to new workloads.</p>
27
+ * <p>Delete a review template.</p> <p>Only the owner of a review template can delete it.</p> <p>After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.</p>
32
28
  * @example
33
29
  * Use a bare-bones client and the command you need to make an API call.
34
30
  * ```javascript
@@ -24,10 +24,7 @@ declare const DeleteTemplateShareCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Delete a review template share.</p>
28
- * <p>After the review template share is deleted, Amazon Web Services accounts, users,
29
- * organizations, and organizational units (OUs) that you shared the review template with
30
- * will no longer be able to apply it to new workloads.</p>
27
+ * <p>Delete a review template share.</p> <p>After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.</p>
31
28
  * @example
32
29
  * Use a bare-bones client and the command you need to make an API call.
33
30
  * ```javascript
@@ -24,12 +24,7 @@ declare const DisassociateLensesCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Disassociate a lens from a workload.</p>
28
- * <p>Up to 10 lenses can be disassociated from a workload in a single API operation.</p>
29
- * <note>
30
- * <p>The Amazon Web Services Well-Architected Framework lens (<code>wellarchitected</code>) cannot be
31
- * removed from a workload.</p>
32
- * </note>
27
+ * <p>Disassociate a lens from a workload.</p> <p>Up to 10 lenses can be disassociated from a workload in a single API operation.</p> <note> <p>The Amazon Web Services Well-Architected Framework lens (<code>wellarchitected</code>) cannot be removed from a workload.</p> </note>
33
28
  * @example
34
29
  * Use a bare-bones client and the command you need to make an API call.
35
30
  * ```javascript
@@ -24,22 +24,7 @@ declare const ExportLensCommand_base: {
24
24
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
25
  };
26
26
  /**
27
- * <p>Export an existing lens.</p>
28
- * <p>Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content)
29
- * cannot be exported.</p>
30
- * <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>
31
- * in the <i>Well-Architected Tool User Guide</i>.</p>
32
- * <note>
33
- * <p>
34
- * <b>Disclaimer</b>
35
- * </p>
36
- * <p>Do not include or gather personal identifiable information (PII) of end users or
37
- * other identifiable individuals in or via your custom lenses. If your custom
38
- * lens or those shared with you and used in your account do include or collect
39
- * PII you are responsible for: ensuring that the included PII is processed in accordance
40
- * with applicable law, providing adequate privacy notices, and obtaining necessary
41
- * consents for processing such data.</p>
42
- * </note>
27
+ * <p>Export an existing lens.</p> <p>Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.</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> <note> <p> <b>Disclaimer</b> </p> <p>Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.</p> </note>
43
28
  * @example
44
29
  * Use a bare-bones client and the command you need to make an API call.
45
30
  * ```javascript
@@ -0,0 +1,124 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { GetAgentContextRequest, GetAgentContextResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link GetAgentContextCommand}.
11
+ */
12
+ export interface GetAgentContextCommandInput extends GetAgentContextRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link GetAgentContextCommand}.
18
+ */
19
+ export interface GetAgentContextCommandOutput extends GetAgentContextResponse, __MetadataBearer {
20
+ }
21
+ declare const GetAgentContextCommand_base: {
22
+ new (input: GetAgentContextCommandInput): import("@smithy/core/client").CommandImpl<GetAgentContextCommandInput, GetAgentContextCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: GetAgentContextCommandInput): import("@smithy/core/client").CommandImpl<GetAgentContextCommandInput, GetAgentContextCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves detailed information about a specific context associated with a profile.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { WellArchitectedClient, GetAgentContextCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
32
+ * // const { WellArchitectedClient, GetAgentContextCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
33
+ * // import type { WellArchitectedClientConfig } from "@aws-sdk/client-wellarchitected";
34
+ * const config = {}; // type is WellArchitectedClientConfig
35
+ * const client = new WellArchitectedClient(config);
36
+ * const input = { // GetAgentContextRequest
37
+ * profileArn: "STRING_VALUE", // required
38
+ * id: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetAgentContextCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetAgentContextResponse
43
+ * // context: { // ContextSummary
44
+ * // id: "STRING_VALUE", // required
45
+ * // profileArn: "STRING_VALUE", // required
46
+ * // title: "STRING_VALUE", // required
47
+ * // contextType: "APPLICATION", // required
48
+ * // content: { // ContextContent
49
+ * // accountIds: [ // ContextAccountIdList
50
+ * // "STRING_VALUE",
51
+ * // ],
52
+ * // regions: [ // ContextRegionList
53
+ * // "STRING_VALUE",
54
+ * // ],
55
+ * // awsServices: [ // ContextAwsServiceList
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // resourceTypes: [ // ContextResourceTypeList
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // resourceTags: [ // ContextResourceTagList
62
+ * // { // ContextResourceTag
63
+ * // key: "STRING_VALUE", // required
64
+ * // value: "STRING_VALUE", // required
65
+ * // },
66
+ * // ],
67
+ * // applicationOverview: "STRING_VALUE",
68
+ * // industry: "STRING_VALUE",
69
+ * // applicationType: "SAS" || "DESKTOP_APPLICATION" || "OTHER",
70
+ * // criticality: "MISSION_CRITICAL" || "BUSINESS_CRITICAL" || "NON_CRITICAL" || "TEST_DEVELOPMENT",
71
+ * // architectureOverview: "STRING_VALUE",
72
+ * // additionalContext: "STRING_VALUE",
73
+ * // },
74
+ * // applicationType: "SAS" || "DESKTOP_APPLICATION" || "OTHER",
75
+ * // criticality: "MISSION_CRITICAL" || "BUSINESS_CRITICAL" || "NON_CRITICAL" || "TEST_DEVELOPMENT",
76
+ * // createdBy: "STRING_VALUE", // required
77
+ * // createdAt: new Date("TIMESTAMP"), // required
78
+ * // lastModifiedBy: "STRING_VALUE",
79
+ * // lastModifiedAt: new Date("TIMESTAMP"),
80
+ * // },
81
+ * // };
82
+ *
83
+ * ```
84
+ *
85
+ * @param GetAgentContextCommandInput - {@link GetAgentContextCommandInput}
86
+ * @returns {@link GetAgentContextCommandOutput}
87
+ * @see {@link GetAgentContextCommandInput} for command's `input` shape.
88
+ * @see {@link GetAgentContextCommandOutput} for command's `response` shape.
89
+ * @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
90
+ *
91
+ * @throws {@link AccessDeniedException} (client fault)
92
+ * <p>User does not have sufficient access to perform this action.</p>
93
+ *
94
+ * @throws {@link InternalServerException} (server fault)
95
+ * <p>There is a problem with the Well-Architected Tool API service.</p>
96
+ *
97
+ * @throws {@link ResourceNotFoundException} (client fault)
98
+ * <p>The requested resource was not found.</p>
99
+ *
100
+ * @throws {@link ThrottlingException} (client fault)
101
+ * <p>Request was denied due to request throttling.</p>
102
+ *
103
+ * @throws {@link ValidationException} (client fault)
104
+ * <p>The user input is not valid.</p>
105
+ *
106
+ * @throws {@link WellArchitectedServiceException}
107
+ * <p>Base exception class for all service exceptions from WellArchitected service.</p>
108
+ *
109
+ *
110
+ * @public
111
+ */
112
+ export declare class GetAgentContextCommand extends GetAgentContextCommand_base {
113
+ /** @internal type navigation helper, not in runtime. */
114
+ protected static __types: {
115
+ api: {
116
+ input: GetAgentContextRequest;
117
+ output: GetAgentContextResponse;
118
+ };
119
+ sdk: {
120
+ input: GetAgentContextCommandInput;
121
+ output: GetAgentContextCommandOutput;
122
+ };
123
+ };
124
+ }
@@ -0,0 +1,99 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { GetAgentGoalRequest, GetAgentGoalResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link GetAgentGoalCommand}.
11
+ */
12
+ export interface GetAgentGoalCommandInput extends GetAgentGoalRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link GetAgentGoalCommand}.
18
+ */
19
+ export interface GetAgentGoalCommandOutput extends GetAgentGoalResponse, __MetadataBearer {
20
+ }
21
+ declare const GetAgentGoalCommand_base: {
22
+ new (input: GetAgentGoalCommandInput): import("@smithy/core/client").CommandImpl<GetAgentGoalCommandInput, GetAgentGoalCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: GetAgentGoalCommandInput): import("@smithy/core/client").CommandImpl<GetAgentGoalCommandInput, GetAgentGoalCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves detailed information about a specific optimization goal.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { WellArchitectedClient, GetAgentGoalCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
32
+ * // const { WellArchitectedClient, GetAgentGoalCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
33
+ * // import type { WellArchitectedClientConfig } from "@aws-sdk/client-wellarchitected";
34
+ * const config = {}; // type is WellArchitectedClientConfig
35
+ * const client = new WellArchitectedClient(config);
36
+ * const input = { // GetAgentGoalRequest
37
+ * profileArn: "STRING_VALUE", // required
38
+ * id: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetAgentGoalCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetAgentGoalResponse
43
+ * // goal: { // GoalSummary
44
+ * // id: "STRING_VALUE", // required
45
+ * // profileArn: "STRING_VALUE", // required
46
+ * // pillars: [ // Pillars // required
47
+ * // "COST_OPTIMIZATION" || "SECURITY" || "RESILIENCE" || "PERFORMANCE" || "OPERATIONAL_EXCELLENCE",
48
+ * // ],
49
+ * // title: "STRING_VALUE", // required
50
+ * // description: "STRING_VALUE",
51
+ * // createdBy: "STRING_VALUE", // required
52
+ * // createdAt: new Date("TIMESTAMP"), // required
53
+ * // lastModifiedBy: "STRING_VALUE",
54
+ * // lastModifiedAt: new Date("TIMESTAMP"),
55
+ * // },
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param GetAgentGoalCommandInput - {@link GetAgentGoalCommandInput}
61
+ * @returns {@link GetAgentGoalCommandOutput}
62
+ * @see {@link GetAgentGoalCommandInput} for command's `input` shape.
63
+ * @see {@link GetAgentGoalCommandOutput} for command's `response` shape.
64
+ * @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
65
+ *
66
+ * @throws {@link AccessDeniedException} (client fault)
67
+ * <p>User does not have sufficient access to perform this action.</p>
68
+ *
69
+ * @throws {@link InternalServerException} (server fault)
70
+ * <p>There is a problem with the Well-Architected Tool API service.</p>
71
+ *
72
+ * @throws {@link ResourceNotFoundException} (client fault)
73
+ * <p>The requested resource was not found.</p>
74
+ *
75
+ * @throws {@link ThrottlingException} (client fault)
76
+ * <p>Request was denied due to request throttling.</p>
77
+ *
78
+ * @throws {@link ValidationException} (client fault)
79
+ * <p>The user input is not valid.</p>
80
+ *
81
+ * @throws {@link WellArchitectedServiceException}
82
+ * <p>Base exception class for all service exceptions from WellArchitected service.</p>
83
+ *
84
+ *
85
+ * @public
86
+ */
87
+ export declare class GetAgentGoalCommand extends GetAgentGoalCommand_base {
88
+ /** @internal type navigation helper, not in runtime. */
89
+ protected static __types: {
90
+ api: {
91
+ input: GetAgentGoalRequest;
92
+ output: GetAgentGoalResponse;
93
+ };
94
+ sdk: {
95
+ input: GetAgentGoalCommandInput;
96
+ output: GetAgentGoalCommandOutput;
97
+ };
98
+ };
99
+ }
@@ -0,0 +1,119 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { GetAgentProfileRequest, GetAgentProfileResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link GetAgentProfileCommand}.
11
+ */
12
+ export interface GetAgentProfileCommandInput extends GetAgentProfileRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link GetAgentProfileCommand}.
18
+ */
19
+ export interface GetAgentProfileCommandOutput extends GetAgentProfileResponse, __MetadataBearer {
20
+ }
21
+ declare const GetAgentProfileCommand_base: {
22
+ new (input: GetAgentProfileCommandInput): import("@smithy/core/client").CommandImpl<GetAgentProfileCommandInput, GetAgentProfileCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: GetAgentProfileCommandInput): import("@smithy/core/client").CommandImpl<GetAgentProfileCommandInput, GetAgentProfileCommandOutput, import("..").WellArchitectedClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves detailed information about an optimization profile, including its configuration and metadata.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { WellArchitectedClient, GetAgentProfileCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
32
+ * // const { WellArchitectedClient, GetAgentProfileCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
33
+ * // import type { WellArchitectedClientConfig } from "@aws-sdk/client-wellarchitected";
34
+ * const config = {}; // type is WellArchitectedClientConfig
35
+ * const client = new WellArchitectedClient(config);
36
+ * const input = { // GetAgentProfileRequest
37
+ * profileArn: "STRING_VALUE", // required
38
+ * };
39
+ * const command = new GetAgentProfileCommand(input);
40
+ * const response = await client.send(command);
41
+ * // { // GetAgentProfileResponse
42
+ * // name: "STRING_VALUE", // required
43
+ * // displayName: "STRING_VALUE",
44
+ * // description: "STRING_VALUE",
45
+ * // businessOverview: "STRING_VALUE",
46
+ * // pillars: [ // Pillars // required
47
+ * // "COST_OPTIMIZATION" || "SECURITY" || "RESILIENCE" || "PERFORMANCE" || "OPERATIONAL_EXCELLENCE",
48
+ * // ],
49
+ * // deletionProtection: true || false,
50
+ * // executionRoleArn: "STRING_VALUE", // required
51
+ * // aggregationConfiguration: [ // AggregationConfigurations // required
52
+ * // { // AggregationConfiguration
53
+ * // accountId: "STRING_VALUE", // required
54
+ * // regions: [ // Regions // required
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // accessRoleArn: "STRING_VALUE", // required
58
+ * // },
59
+ * // ],
60
+ * // arn: "STRING_VALUE", // required
61
+ * // eligibleForScheduledGeneration: true || false,
62
+ * // eligibleForArchitectureGeneration: true || false,
63
+ * // fieldErrors: { // FieldErrors
64
+ * // "<keys>": "STRING_VALUE",
65
+ * // },
66
+ * // tags: [ // Tags
67
+ * // { // Tag
68
+ * // key: "STRING_VALUE", // required
69
+ * // value: "STRING_VALUE", // required
70
+ * // },
71
+ * // ],
72
+ * // createdBy: "STRING_VALUE", // required
73
+ * // createdAt: new Date("TIMESTAMP"), // required
74
+ * // lastModifiedBy: "STRING_VALUE",
75
+ * // lastModifiedAt: new Date("TIMESTAMP"),
76
+ * // };
77
+ *
78
+ * ```
79
+ *
80
+ * @param GetAgentProfileCommandInput - {@link GetAgentProfileCommandInput}
81
+ * @returns {@link GetAgentProfileCommandOutput}
82
+ * @see {@link GetAgentProfileCommandInput} for command's `input` shape.
83
+ * @see {@link GetAgentProfileCommandOutput} for command's `response` shape.
84
+ * @see {@link WellArchitectedClientResolvedConfig | config} for WellArchitectedClient's `config` shape.
85
+ *
86
+ * @throws {@link AccessDeniedException} (client fault)
87
+ * <p>User does not have sufficient access to perform this action.</p>
88
+ *
89
+ * @throws {@link InternalServerException} (server fault)
90
+ * <p>There is a problem with the Well-Architected Tool API service.</p>
91
+ *
92
+ * @throws {@link ResourceNotFoundException} (client fault)
93
+ * <p>The requested resource was not found.</p>
94
+ *
95
+ * @throws {@link ThrottlingException} (client fault)
96
+ * <p>Request was denied due to request throttling.</p>
97
+ *
98
+ * @throws {@link ValidationException} (client fault)
99
+ * <p>The user input is not valid.</p>
100
+ *
101
+ * @throws {@link WellArchitectedServiceException}
102
+ * <p>Base exception class for all service exceptions from WellArchitected service.</p>
103
+ *
104
+ *
105
+ * @public
106
+ */
107
+ export declare class GetAgentProfileCommand extends GetAgentProfileCommand_base {
108
+ /** @internal type navigation helper, not in runtime. */
109
+ protected static __types: {
110
+ api: {
111
+ input: GetAgentProfileRequest;
112
+ output: GetAgentProfileResponse;
113
+ };
114
+ sdk: {
115
+ input: GetAgentProfileCommandInput;
116
+ output: GetAgentProfileCommandOutput;
117
+ };
118
+ };
119
+ }