Skip to content

Commit

Permalink
chore(docs): move documentation before release tag (#5905)
Browse files Browse the repository at this point in the history
  • Loading branch information
trivikr authored Mar 15, 2024
1 parent a967bfc commit 74b4812
Show file tree
Hide file tree
Showing 16,473 changed files with 201,014 additions and 201,447 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion clients/client-accessanalyzer/src/AccessAnalyzer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,6 @@ export interface AccessAnalyzer {
}

/**
* @public
* <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing
* a suite of capabilities. Its features include findings for external and unused access,
* basic and custom policy checks for validating policies, and policy generation to generate
Expand All @@ -701,6 +700,7 @@ export interface AccessAnalyzer {
* <p>This guide describes the IAM Access Analyzer operations that you can call programmatically.
* For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the
* <b>IAM User Guide</b>.</p>
* @public
*/
export class AccessAnalyzer extends AccessAnalyzerClient implements AccessAnalyzer {}
createAggregatedClient(commands, AccessAnalyzer);
2 changes: 1 addition & 1 deletion clients/client-accessanalyzer/src/AccessAnalyzerClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,6 @@ export type AccessAnalyzerClientResolvedConfigType = __SmithyResolvedConfigurati
export interface AccessAnalyzerClientResolvedConfig extends AccessAnalyzerClientResolvedConfigType {}

/**
* @public
* <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing
* a suite of capabilities. Its features include findings for external and unused access,
* basic and custom policy checks for validating policies, and policy generation to generate
Expand All @@ -394,6 +393,7 @@ export interface AccessAnalyzerClientResolvedConfig extends AccessAnalyzerClient
* <p>This guide describes the IAM Access Analyzer operations that you can call programmatically.
* For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the
* <b>IAM User Guide</b>.</p>
* @public
*/
export class AccessAnalyzerClient extends __Client<
__HttpHandlerOptions,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface ApplyArchiveRuleCommandInput extends ApplyArchiveRuleRequest {}
export interface ApplyArchiveRuleCommandOutput extends __MetadataBearer {}

/**
* @public
* <p>Retroactively applies the archive rule to existing findings that meet the archive rule
* criteria.</p>
* @example
Expand Down Expand Up @@ -71,6 +70,7 @@ export interface ApplyArchiveRuleCommandOutput extends __MetadataBearer {}
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class ApplyArchiveRuleCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface CancelPolicyGenerationCommandInput extends CancelPolicyGenerati
export interface CancelPolicyGenerationCommandOutput extends CancelPolicyGenerationResponse, __MetadataBearer {}

/**
* @public
* <p>Cancels the requested policy generation.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -65,6 +64,7 @@ export interface CancelPolicyGenerationCommandOutput extends CancelPolicyGenerat
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class CancelPolicyGenerationCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ export interface CheckAccessNotGrantedCommandInput extends CheckAccessNotGranted
export interface CheckAccessNotGrantedCommandOutput extends CheckAccessNotGrantedResponse, __MetadataBearer {}

/**
* @public
* <p>Checks whether the specified access isn't allowed by a policy.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -93,6 +92,7 @@ export interface CheckAccessNotGrantedCommandOutput extends CheckAccessNotGrante
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class CheckAccessNotGrantedCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ export interface CheckNoNewAccessCommandInput extends CheckNoNewAccessRequest {}
export interface CheckNoNewAccessCommandOutput extends CheckNoNewAccessResponse, __MetadataBearer {}

/**
* @public
* <p>Checks whether new access is allowed for an updated policy when compared to the existing
* policy.</p>
* <p>You can find examples for reference policies and learn how to set up and run a custom
Expand Down Expand Up @@ -92,6 +91,7 @@ export interface CheckNoNewAccessCommandOutput extends CheckNoNewAccessResponse,
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class CheckNoNewAccessCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface CreateAccessPreviewCommandInput extends CreateAccessPreviewRequ
export interface CreateAccessPreviewCommandOutput extends CreateAccessPreviewResponse, __MetadataBearer {}

/**
* @public
* <p>Creates an access preview that allows you to preview IAM Access Analyzer findings for your
* resource before deploying resource permissions.</p>
* @example
Expand Down Expand Up @@ -187,6 +186,7 @@ export interface CreateAccessPreviewCommandOutput extends CreateAccessPreviewRes
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class CreateAccessPreviewCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface CreateAnalyzerCommandInput extends CreateAnalyzerRequest {}
export interface CreateAnalyzerCommandOutput extends CreateAnalyzerResponse, __MetadataBearer {}

/**
* @public
* <p>Creates an analyzer for your account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -102,6 +101,7 @@ export interface CreateAnalyzerCommandOutput extends CreateAnalyzerResponse, __M
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class CreateAnalyzerCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface CreateArchiveRuleCommandInput extends CreateArchiveRuleRequest
export interface CreateArchiveRuleCommandOutput extends __MetadataBearer {}

/**
* @public
* <p>Creates an archive rule for the specified analyzer. Archive rules automatically archive
* new findings that meet the criteria you define when you create the rule.</p>
* <p>To learn about filter keys that you can use to create an archive rule, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>
Expand Down Expand Up @@ -92,6 +91,7 @@ export interface CreateArchiveRuleCommandOutput extends __MetadataBearer {}
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class CreateArchiveRuleCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface DeleteAnalyzerCommandInput extends DeleteAnalyzerRequest {}
export interface DeleteAnalyzerCommandOutput extends __MetadataBearer {}

/**
* @public
* <p>Deletes the specified analyzer. When you delete an analyzer, IAM Access Analyzer is disabled
* for the account or organization in the current or specific Region. All findings that were
* generated by the analyzer are deleted. You cannot undo this action.</p>
Expand Down Expand Up @@ -71,6 +70,7 @@ export interface DeleteAnalyzerCommandOutput extends __MetadataBearer {}
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class DeleteAnalyzerCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface DeleteArchiveRuleCommandInput extends DeleteArchiveRuleRequest
export interface DeleteArchiveRuleCommandOutput extends __MetadataBearer {}

/**
* @public
* <p>Deletes the specified archive rule.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -70,6 +69,7 @@ export interface DeleteArchiveRuleCommandOutput extends __MetadataBearer {}
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class DeleteArchiveRuleCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface GetAccessPreviewCommandInput extends GetAccessPreviewRequest {}
export interface GetAccessPreviewCommandOutput extends GetAccessPreviewResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves information about an access preview for the specified analyzer.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -188,6 +187,7 @@ export interface GetAccessPreviewCommandOutput extends GetAccessPreviewResponse,
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class GetAccessPreviewCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface GetAnalyzedResourceCommandInput extends GetAnalyzedResourceRequ
export interface GetAnalyzedResourceCommandOutput extends GetAnalyzedResourceResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves information about a resource that was analyzed.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -87,6 +86,7 @@ export interface GetAnalyzedResourceCommandOutput extends GetAnalyzedResourceRes
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class GetAnalyzedResourceCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface GetAnalyzerCommandInput extends GetAnalyzerRequest {}
export interface GetAnalyzerCommandOutput extends GetAnalyzerResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves information about the specified analyzer.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -89,6 +88,7 @@ export interface GetAnalyzerCommandOutput extends GetAnalyzerResponse, __Metadat
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class GetAnalyzerCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface GetArchiveRuleCommandInput extends GetArchiveRuleRequest {}
export interface GetArchiveRuleCommandOutput extends GetArchiveRuleResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves information about an archive rule.</p>
* <p>To learn about filter keys that you can use to create an archive rule, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html">IAM Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>
* @example
Expand Down Expand Up @@ -90,6 +89,7 @@ export interface GetArchiveRuleCommandOutput extends GetArchiveRuleResponse, __M
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class GetArchiveRuleCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface GetFindingCommandInput extends GetFindingRequest {}
export interface GetFindingCommandOutput extends GetFindingResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves information about the specified finding. GetFinding and GetFindingV2 both use
* <code>access-analyzer:GetFinding</code> in the <code>Action</code> element of an IAM
* policy statement. You must have permission to perform the
Expand Down Expand Up @@ -103,6 +102,7 @@ export interface GetFindingCommandOutput extends GetFindingResponse, __MetadataB
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class GetFindingCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface GetFindingV2CommandInput extends GetFindingV2Request {}
export interface GetFindingV2CommandOutput extends GetFindingV2Response, __MetadataBearer {}

/**
* @public
* <p>Retrieves information about the specified finding. GetFinding and GetFindingV2 both use
* <code>access-analyzer:GetFinding</code> in the <code>Action</code> element of an IAM
* policy statement. You must have permission to perform the
Expand Down Expand Up @@ -131,6 +130,7 @@ export interface GetFindingV2CommandOutput extends GetFindingV2Response, __Metad
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class GetFindingV2Command extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface GetGeneratedPolicyCommandInput extends GetGeneratedPolicyReques
export interface GetGeneratedPolicyCommandOutput extends GetGeneratedPolicyResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves the policy that was generated using <code>StartPolicyGeneration</code>.
* </p>
* @example
Expand Down Expand Up @@ -103,6 +102,7 @@ export interface GetGeneratedPolicyCommandOutput extends GetGeneratedPolicyRespo
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class GetGeneratedPolicyCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface ListAccessPreviewFindingsCommandInput extends ListAccessPreview
export interface ListAccessPreviewFindingsCommandOutput extends ListAccessPreviewFindingsResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves a list of access preview findings generated by the specified access
* preview.</p>
* @example
Expand Down Expand Up @@ -124,6 +123,7 @@ export interface ListAccessPreviewFindingsCommandOutput extends ListAccessPrevie
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class ListAccessPreviewFindingsCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface ListAccessPreviewsCommandInput extends ListAccessPreviewsReques
export interface ListAccessPreviewsCommandOutput extends ListAccessPreviewsResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves a list of access previews for the specified analyzer.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -83,6 +82,7 @@ export interface ListAccessPreviewsCommandOutput extends ListAccessPreviewsRespo
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class ListAccessPreviewsCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface ListAnalyzedResourcesCommandInput extends ListAnalyzedResources
export interface ListAnalyzedResourcesCommandOutput extends ListAnalyzedResourcesResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves a list of resources of the specified type that have been analyzed by the
* specified external access analyzer. This action is not supported for unused access
* analyzers.</p>
Expand Down Expand Up @@ -82,6 +81,7 @@ export interface ListAnalyzedResourcesCommandOutput extends ListAnalyzedResource
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class ListAnalyzedResourcesCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface ListAnalyzersCommandInput extends ListAnalyzersRequest {}
export interface ListAnalyzersCommandOutput extends ListAnalyzersResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves a list of analyzers.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -91,6 +90,7 @@ export interface ListAnalyzersCommandOutput extends ListAnalyzersResponse, __Met
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class ListAnalyzersCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface ListArchiveRulesCommandInput extends ListArchiveRulesRequest {}
export interface ListArchiveRulesCommandOutput extends ListArchiveRulesResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves a list of archive rules created for the specified analyzer.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down Expand Up @@ -90,6 +89,7 @@ export interface ListArchiveRulesCommandOutput extends ListArchiveRulesResponse,
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class ListArchiveRulesCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface ListFindingsCommandInput extends ListFindingsRequest {}
export interface ListFindingsCommandOutput extends ListFindingsResponse, __MetadataBearer {}

/**
* @public
* <p>Retrieves a list of findings generated by the specified analyzer. ListFindings and
* ListFindingsV2 both use <code>access-analyzer:ListFindings</code> in the
* <code>Action</code> element of an IAM policy statement. You must have permission to
Expand Down Expand Up @@ -126,6 +125,7 @@ export interface ListFindingsCommandOutput extends ListFindingsResponse, __Metad
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class ListFindingsCommand extends $Command
.classBuilder<
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export interface ListFindingsV2CommandInput extends ListFindingsV2Request {}
export interface ListFindingsV2CommandOutput extends ListFindingsV2Response, __MetadataBearer {}

/**
* @public
* <p>Retrieves a list of findings generated by the specified analyzer. ListFindings and
* ListFindingsV2 both use <code>access-analyzer:ListFindings</code> in the
* <code>Action</code> element of an IAM policy statement. You must have permission to
Expand Down Expand Up @@ -108,6 +107,7 @@ export interface ListFindingsV2CommandOutput extends ListFindingsV2Response, __M
* @throws {@link AccessAnalyzerServiceException}
* <p>Base exception class for all service exceptions from AccessAnalyzer service.</p>
*
* @public
*/
export class ListFindingsV2Command extends $Command
.classBuilder<
Expand Down
Loading

0 comments on commit 74b4812

Please sign in to comment.