feat(clients): codegen for structural hint documentation in commands (#…

…4573)

* feat(clients): example codegen for structural hint documentation in commands

* feat(clients): codegen for command documentation, input structural hints

clients/client-accessanalyzer/src/commands/ApplyArchiveRuleCommand.ts

@@ -43,6 +43,11 @@ export interface ApplyArchiveRuleCommandOutput extends __MetadataBearer {}
  * import { AccessAnalyzerClient, ApplyArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, ApplyArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerArn: "STRING_VALUE", // required
+ *   ruleName: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE",
+ * };
  * const command = new ApplyArchiveRuleCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/CancelPolicyGenerationCommand.ts

@@ -42,6 +42,9 @@ export interface CancelPolicyGenerationCommandOutput extends CancelPolicyGenerat
  * import { AccessAnalyzerClient, CancelPolicyGenerationCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, CancelPolicyGenerationCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   jobId: "STRING_VALUE", // required
+ * };
  * const command = new CancelPolicyGenerationCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/CreateAccessPreviewCommand.ts

@@ -43,6 +43,116 @@ export interface CreateAccessPreviewCommandOutput extends CreateAccessPreviewRes
  * import { AccessAnalyzerClient, CreateAccessPreviewCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, CreateAccessPreviewCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerArn: "STRING_VALUE", // required
+ *   configurations: { // required
+ *     "<keys>": { // Union: only one key present
+ *       ebsSnapshot: {
+ *         userIds: [
+ *           "STRING_VALUE",
+ *         ],
+ *         groups: [
+ *           "STRING_VALUE",
+ *         ],
+ *         kmsKeyId: "STRING_VALUE",
+ *       },
+ *       ecrRepository: {
+ *         repositoryPolicy: "STRING_VALUE",
+ *       },
+ *       iamRole: {
+ *         trustPolicy: "STRING_VALUE",
+ *       },
+ *       efsFileSystem: {
+ *         fileSystemPolicy: "STRING_VALUE",
+ *       },
+ *       kmsKey: {
+ *         keyPolicies: {
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *         grants: [
+ *           {
+ *             operations: [ // required
+ *               "STRING_VALUE",
+ *             ],
+ *             granteePrincipal: "STRING_VALUE", // required
+ *             retiringPrincipal: "STRING_VALUE",
+ *             constraints: {
+ *               encryptionContextEquals: {
+ *                 "<keys>": "STRING_VALUE",
+ *               },
+ *               encryptionContextSubset: {
+ *                 "<keys>": "STRING_VALUE",
+ *               },
+ *             },
+ *             issuingAccount: "STRING_VALUE", // required
+ *           },
+ *         ],
+ *       },
+ *       rdsDbClusterSnapshot: {
+ *         attributes: {
+ *           "<keys>": { // Union: only one key present
+ *             accountIds: [
+ *               "STRING_VALUE",
+ *             ],
+ *           },
+ *         },
+ *         kmsKeyId: "STRING_VALUE",
+ *       },
+ *       rdsDbSnapshot: {
+ *         attributes: {
+ *           "<keys>": { // Union: only one key present
+ *             accountIds: [
+ *               "STRING_VALUE",
+ *             ],
+ *           },
+ *         },
+ *         kmsKeyId: "STRING_VALUE",
+ *       },
+ *       secretsManagerSecret: {
+ *         kmsKeyId: "STRING_VALUE",
+ *         secretPolicy: "STRING_VALUE",
+ *       },
+ *       s3Bucket: {
+ *         bucketPolicy: "STRING_VALUE",
+ *         bucketAclGrants: [
+ *           {
+ *             permission: "STRING_VALUE", // required
+ *             grantee: { // Union: only one key present
+ *               id: "STRING_VALUE",
+ *               uri: "STRING_VALUE",
+ *             },
+ *           },
+ *         ],
+ *         bucketPublicAccessBlock: {
+ *           ignorePublicAcls: true || false, // required
+ *           restrictPublicBuckets: true || false, // required
+ *         },
+ *         accessPoints: {
+ *           "<keys>": {
+ *             accessPointPolicy: "STRING_VALUE",
+ *             publicAccessBlock: {
+ *               ignorePublicAcls: true || false, // required
+ *               restrictPublicBuckets: true || false, // required
+ *             },
+ *             networkOrigin: { // Union: only one key present
+ *               vpcConfiguration: {
+ *                 vpcId: "STRING_VALUE", // required
+ *               },
+ *               internetConfiguration: {},
+ *             },
+ *           },
+ *         },
+ *       },
+ *       snsTopic: {
+ *         topicPolicy: "STRING_VALUE",
+ *       },
+ *       sqsQueue: {
+ *         queuePolicy: "STRING_VALUE",
+ *       },
+ *     },
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
  * const command = new CreateAccessPreviewCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/CreateAnalyzerCommand.ts

@@ -42,6 +42,33 @@ export interface CreateAnalyzerCommandOutput extends CreateAnalyzerResponse, __M
  * import { AccessAnalyzerClient, CreateAnalyzerCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, CreateAnalyzerCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerName: "STRING_VALUE", // required
+ *   type: "STRING_VALUE", // required
+ *   archiveRules: [
+ *     {
+ *       ruleName: "STRING_VALUE", // required
+ *       filter: { // required
+ *         "<keys>": {
+ *           eq: [
+ *             "STRING_VALUE",
+ *           ],
+ *           neq: [
+ *             "STRING_VALUE",
+ *           ],
+ *           contains: [
+ *             "STRING_VALUE",
+ *           ],
+ *           exists: true || false,
+ *         },
+ *       },
+ *     },
+ *   ],
+ *   tags: {
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
  * const command = new CreateAnalyzerCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/CreateArchiveRuleCommand.ts

@@ -44,6 +44,25 @@ export interface CreateArchiveRuleCommandOutput extends __MetadataBearer {}
  * import { AccessAnalyzerClient, CreateArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, CreateArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerName: "STRING_VALUE", // required
+ *   ruleName: "STRING_VALUE", // required
+ *   filter: { // required
+ *     "<keys>": {
+ *       eq: [
+ *         "STRING_VALUE",
+ *       ],
+ *       neq: [
+ *         "STRING_VALUE",
+ *       ],
+ *       contains: [
+ *         "STRING_VALUE",
+ *       ],
+ *       exists: true || false,
+ *     },
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
  * const command = new CreateArchiveRuleCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/DeleteAnalyzerCommand.ts

@@ -44,6 +44,10 @@ export interface DeleteAnalyzerCommandOutput extends __MetadataBearer {}
  * import { AccessAnalyzerClient, DeleteAnalyzerCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, DeleteAnalyzerCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerName: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE",
+ * };
  * const command = new DeleteAnalyzerCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/DeleteArchiveRuleCommand.ts

@@ -42,6 +42,11 @@ export interface DeleteArchiveRuleCommandOutput extends __MetadataBearer {}
  * import { AccessAnalyzerClient, DeleteArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, DeleteArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerName: "STRING_VALUE", // required
+ *   ruleName: "STRING_VALUE", // required
+ *   clientToken: "STRING_VALUE",
+ * };
  * const command = new DeleteArchiveRuleCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/GetAccessPreviewCommand.ts

@@ -42,6 +42,10 @@ export interface GetAccessPreviewCommandOutput extends GetAccessPreviewResponse,
  * import { AccessAnalyzerClient, GetAccessPreviewCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, GetAccessPreviewCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   accessPreviewId: "STRING_VALUE", // required
+ *   analyzerArn: "STRING_VALUE", // required
+ * };
  * const command = new GetAccessPreviewCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/GetAnalyzedResourceCommand.ts

@@ -42,6 +42,10 @@ export interface GetAnalyzedResourceCommandOutput extends GetAnalyzedResourceRes
  * import { AccessAnalyzerClient, GetAnalyzedResourceCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, GetAnalyzedResourceCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerArn: "STRING_VALUE", // required
+ *   resourceArn: "STRING_VALUE", // required
+ * };
  * const command = new GetAnalyzedResourceCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/GetAnalyzerCommand.ts

@@ -42,6 +42,9 @@ export interface GetAnalyzerCommandOutput extends GetAnalyzerResponse, __Metadat
  * import { AccessAnalyzerClient, GetAnalyzerCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, GetAnalyzerCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerName: "STRING_VALUE", // required
+ * };
  * const command = new GetAnalyzerCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/GetArchiveRuleCommand.ts

@@ -43,6 +43,10 @@ export interface GetArchiveRuleCommandOutput extends GetArchiveRuleResponse, __M
  * import { AccessAnalyzerClient, GetArchiveRuleCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, GetArchiveRuleCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerName: "STRING_VALUE", // required
+ *   ruleName: "STRING_VALUE", // required
+ * };
  * const command = new GetArchiveRuleCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/GetFindingCommand.ts

@@ -42,6 +42,10 @@ export interface GetFindingCommandOutput extends GetFindingResponse, __MetadataB
  * import { AccessAnalyzerClient, GetFindingCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, GetFindingCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerArn: "STRING_VALUE", // required
+ *   id: "STRING_VALUE", // required
+ * };
  * const command = new GetFindingCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/GetGeneratedPolicyCommand.ts

@@ -43,6 +43,11 @@ export interface GetGeneratedPolicyCommandOutput extends GetGeneratedPolicyRespo
  * import { AccessAnalyzerClient, GetGeneratedPolicyCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, GetGeneratedPolicyCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   jobId: "STRING_VALUE", // required
+ *   includeResourcePlaceholders: true || false,
+ *   includeServiceLevelTemplate: true || false,
+ * };
  * const command = new GetGeneratedPolicyCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/ListAccessPreviewFindingsCommand.ts

@@ -43,6 +43,26 @@ export interface ListAccessPreviewFindingsCommandOutput extends ListAccessPrevie
  * import { AccessAnalyzerClient, ListAccessPreviewFindingsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, ListAccessPreviewFindingsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   accessPreviewId: "STRING_VALUE", // required
+ *   analyzerArn: "STRING_VALUE", // required
+ *   filter: {
+ *     "<keys>": {
+ *       eq: [
+ *         "STRING_VALUE",
+ *       ],
+ *       neq: [
+ *         "STRING_VALUE",
+ *       ],
+ *       contains: [
+ *         "STRING_VALUE",
+ *       ],
+ *       exists: true || false,
+ *     },
+ *   },
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
  * const command = new ListAccessPreviewFindingsCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/ListAccessPreviewsCommand.ts

@@ -42,6 +42,11 @@ export interface ListAccessPreviewsCommandOutput extends ListAccessPreviewsRespo
  * import { AccessAnalyzerClient, ListAccessPreviewsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, ListAccessPreviewsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerArn: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
  * const command = new ListAccessPreviewsCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/ListAnalyzedResourcesCommand.ts

@@ -43,6 +43,12 @@ export interface ListAnalyzedResourcesCommandOutput extends ListAnalyzedResource
  * import { AccessAnalyzerClient, ListAnalyzedResourcesCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, ListAnalyzedResourcesCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerArn: "STRING_VALUE", // required
+ *   resourceType: "STRING_VALUE",
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
  * const command = new ListAnalyzedResourcesCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/ListAnalyzersCommand.ts

@@ -42,6 +42,11 @@ export interface ListAnalyzersCommandOutput extends ListAnalyzersResponse, __Met
  * import { AccessAnalyzerClient, ListAnalyzersCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, ListAnalyzersCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   type: "STRING_VALUE",
+ * };
  * const command = new ListAnalyzersCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/ListArchiveRulesCommand.ts

@@ -42,6 +42,11 @@ export interface ListArchiveRulesCommandOutput extends ListArchiveRulesResponse,
  * import { AccessAnalyzerClient, ListArchiveRulesCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, ListArchiveRulesCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerName: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
  * const command = new ListArchiveRulesCommand(input);
  * const response = await client.send(command);
  * ```

clients/client-accessanalyzer/src/commands/ListFindingsCommand.ts

@@ -43,6 +43,29 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad
  * import { AccessAnalyzerClient, ListFindingsCommand } from "@aws-sdk/client-accessanalyzer"; // ES Modules import
  * // const { AccessAnalyzerClient, ListFindingsCommand } = require("@aws-sdk/client-accessanalyzer"); // CommonJS import
  * const client = new AccessAnalyzerClient(config);
+ * const input = {
+ *   analyzerArn: "STRING_VALUE", // required
+ *   filter: {
+ *     "<keys>": {
+ *       eq: [
+ *         "STRING_VALUE",
+ *       ],
+ *       neq: [
+ *         "STRING_VALUE",
+ *       ],
+ *       contains: [
+ *         "STRING_VALUE",
+ *       ],
+ *       exists: true || false,
+ *     },
+ *   },
+ *   sort: {
+ *     attributeName: "STRING_VALUE",
+ *     orderBy: "STRING_VALUE",
+ *   },
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
  * const command = new ListFindingsCommand(input);
  * const response = await client.send(command);
  * ```