@aws-sdk/client-accessanalyzer 3.296.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves a list of tags applied to the specified resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, AccessAnalyzerClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccessAnalyzerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
 import { StartPolicyGenerationRequest, StartPolicyGenerationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StartPolicyGenerationCommand}.
  */
 export interface StartPolicyGenerationCommandInput extends StartPolicyGenerationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartPolicyGenerationCommand}.
  */
 export interface StartPolicyGenerationCommandOutput extends StartPolicyGenerationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts the policy generation request.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StartPolicyGenerationCommandOutput extends StartPolicyGeneratio
  * const response = await client.send(command);
  * ```
  *
+ * @param StartPolicyGenerationCommandInput - {@link StartPolicyGenerationCommandInput}
+ * @returns {@link StartPolicyGenerationCommandOutput}
  * @see {@link StartPolicyGenerationCommandInput} for command's `input` shape.
  * @see {@link StartPolicyGenerationCommandOutput} for command's `response` shape.
  * @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
@@ -52,11 +59,20 @@ export interface StartPolicyGenerationCommandOutput extends StartPolicyGeneratio
 export declare class StartPolicyGenerationCommand extends $Command<StartPolicyGenerationCommandInput, StartPolicyGenerationCommandOutput, AccessAnalyzerClientResolvedConfig> {
     readonly input: StartPolicyGenerationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartPolicyGenerationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccessAnalyzerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartPolicyGenerationCommandInput, StartPolicyGenerationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
 import { StartResourceScanRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StartResourceScanCommand}.
  */
 export interface StartResourceScanCommandInput extends StartResourceScanRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartResourceScanCommand}.
  */
 export interface StartResourceScanCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Immediately starts a scan of the policies applied to the specified resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StartResourceScanCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param StartResourceScanCommandInput - {@link StartResourceScanCommandInput}
+ * @returns {@link StartResourceScanCommandOutput}
  * @see {@link StartResourceScanCommandInput} for command's `input` shape.
  * @see {@link StartResourceScanCommandOutput} for command's `response` shape.
  * @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StartResourceScanCommandOutput extends __MetadataBearer {
 export declare class StartResourceScanCommand extends $Command<StartResourceScanCommandInput, StartResourceScanCommandOutput, AccessAnalyzerClientResolvedConfig> {
     readonly input: StartResourceScanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartResourceScanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccessAnalyzerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartResourceScanCommandInput, StartResourceScanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds a tag to the specified resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, AccessAnalyzerClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccessAnalyzerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes a tag from the specified resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, AccessAnalyzerClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccessAnalyzerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
 import { UpdateArchiveRuleRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateArchiveRuleCommand}.
  */
 export interface UpdateArchiveRuleCommandInput extends UpdateArchiveRuleRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateArchiveRuleCommand}.
  */
 export interface UpdateArchiveRuleCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the criteria and values for the specified archive rule.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateArchiveRuleCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateArchiveRuleCommandInput - {@link UpdateArchiveRuleCommandInput}
+ * @returns {@link UpdateArchiveRuleCommandOutput}
  * @see {@link UpdateArchiveRuleCommandInput} for command's `input` shape.
  * @see {@link UpdateArchiveRuleCommandOutput} for command's `response` shape.
  * @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateArchiveRuleCommandOutput extends __MetadataBearer {
 export declare class UpdateArchiveRuleCommand extends $Command<UpdateArchiveRuleCommandInput, UpdateArchiveRuleCommandOutput, AccessAnalyzerClientResolvedConfig> {
     readonly input: UpdateArchiveRuleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateArchiveRuleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccessAnalyzerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateArchiveRuleCommandInput, UpdateArchiveRuleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
 import { UpdateFindingsRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateFindingsCommand}.
  */
 export interface UpdateFindingsCommandInput extends UpdateFindingsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateFindingsCommand}.
  */
 export interface UpdateFindingsCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the status for the specified findings.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateFindingsCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateFindingsCommandInput - {@link UpdateFindingsCommandInput}
+ * @returns {@link UpdateFindingsCommandOutput}
  * @see {@link UpdateFindingsCommandInput} for command's `input` shape.
  * @see {@link UpdateFindingsCommandOutput} for command's `response` shape.
  * @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateFindingsCommandOutput extends __MetadataBearer {
 export declare class UpdateFindingsCommand extends $Command<UpdateFindingsCommandInput, UpdateFindingsCommandOutput, AccessAnalyzerClientResolvedConfig> {
     readonly input: UpdateFindingsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateFindingsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccessAnalyzerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFindingsCommandInput, UpdateFindingsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AccessAnalyzerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AccessAnalyzerClient";
 import { ValidatePolicyRequest, ValidatePolicyResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ValidatePolicyCommand}.
  */
 export interface ValidatePolicyCommandInput extends ValidatePolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ValidatePolicyCommand}.
  */
 export interface ValidatePolicyCommandOutput extends ValidatePolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Requests the validation of a policy and returns a list of findings. The findings help
  *          you identify issues and provide actionable recommendations to resolve the issue and enable
  *          you to author functional policies that meet security best practices. </p>
@@ -27,6 +32,8 @@ export interface ValidatePolicyCommandOutput extends ValidatePolicyResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param ValidatePolicyCommandInput - {@link ValidatePolicyCommandInput}
+ * @returns {@link ValidatePolicyCommandOutput}
  * @see {@link ValidatePolicyCommandInput} for command's `input` shape.
  * @see {@link ValidatePolicyCommandOutput} for command's `response` shape.
  * @see {@link AccessAnalyzerClientResolvedConfig | config} for AccessAnalyzerClient's `config` shape.
@@ -48,11 +55,20 @@ export interface ValidatePolicyCommandOutput extends ValidatePolicyResponse, __M
 export declare class ValidatePolicyCommand extends $Command<ValidatePolicyCommandInput, ValidatePolicyCommandOutput, AccessAnalyzerClientResolvedConfig> {
     readonly input: ValidatePolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ValidatePolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AccessAnalyzerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ValidatePolicyCommandInput, ValidatePolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/AccessAnalyzerServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from AccessAnalyzer service.
  */
 export declare class AccessAnalyzerServiceException extends __ServiceException {