Skip to content

docs: add necessary docs for clients api reference #1716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type CreateAnalyzerCommandInput = CreateAnalyzerRequest;
export type CreateAnalyzerCommandOutput = CreateAnalyzerResponse & __MetadataBearer;

/**
* <p>Creates an analyzer for your account.</p>
*/
export class CreateAnalyzerCommand extends $Command<
CreateAnalyzerCommandInput,
CreateAnalyzerCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class CreateAnalyzerCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ import {
export type CreateArchiveRuleCommandInput = CreateArchiveRuleRequest;
export type CreateArchiveRuleCommandOutput = __MetadataBearer;

/**
* <p>Creates an archive rule for the specified analyzer. Archive rules automatically archive
* findings that meet the criteria you define when you create the rule.</p>
*/
export class CreateArchiveRuleCommand extends $Command<
CreateArchiveRuleCommandInput,
CreateArchiveRuleCommandOutput,
Expand All @@ -34,6 +38,9 @@ export class CreateArchiveRuleCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ import {
export type DeleteAnalyzerCommandInput = DeleteAnalyzerRequest;
export type DeleteAnalyzerCommandOutput = __MetadataBearer;

/**
* <p>Deletes the specified analyzer. When you delete an analyzer, Access Analyzer is disabled
* for the account in the current or specific Region. All findings that were generated by the
* analyzer are deleted. You cannot undo this action.</p>
*/
export class DeleteAnalyzerCommand extends $Command<
DeleteAnalyzerCommandInput,
DeleteAnalyzerCommandOutput,
Expand All @@ -34,6 +39,9 @@ export class DeleteAnalyzerCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type DeleteArchiveRuleCommandInput = DeleteArchiveRuleRequest;
export type DeleteArchiveRuleCommandOutput = __MetadataBearer;

/**
* <p>Deletes the specified archive rule.</p>
*/
export class DeleteArchiveRuleCommand extends $Command<
DeleteArchiveRuleCommandInput,
DeleteArchiveRuleCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class DeleteArchiveRuleCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type GetAnalyzedResourceCommandInput = GetAnalyzedResourceRequest;
export type GetAnalyzedResourceCommandOutput = GetAnalyzedResourceResponse & __MetadataBearer;

/**
* <p>Retrieves information about a resource that was analyzed.</p>
*/
export class GetAnalyzedResourceCommand extends $Command<
GetAnalyzedResourceCommandInput,
GetAnalyzedResourceCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class GetAnalyzedResourceCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
6 changes: 6 additions & 0 deletions clients/client-accessanalyzer/commands/GetAnalyzerCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type GetAnalyzerCommandInput = GetAnalyzerRequest;
export type GetAnalyzerCommandOutput = GetAnalyzerResponse & __MetadataBearer;

/**
* <p>Retrieves information about the specified analyzer.</p>
*/
export class GetAnalyzerCommand extends $Command<
GetAnalyzerCommandInput,
GetAnalyzerCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class GetAnalyzerCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type GetArchiveRuleCommandInput = GetArchiveRuleRequest;
export type GetArchiveRuleCommandOutput = GetArchiveRuleResponse & __MetadataBearer;

/**
* <p>Retrieves information about an archive rule.</p>
*/
export class GetArchiveRuleCommand extends $Command<
GetArchiveRuleCommandInput,
GetArchiveRuleCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class GetArchiveRuleCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
6 changes: 6 additions & 0 deletions clients/client-accessanalyzer/commands/GetFindingCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type GetFindingCommandInput = GetFindingRequest;
export type GetFindingCommandOutput = GetFindingResponse & __MetadataBearer;

/**
* <p>Retrieves information about the specified finding.</p>
*/
export class GetFindingCommand extends $Command<
GetFindingCommandInput,
GetFindingCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class GetFindingCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ import {
export type ListAnalyzedResourcesCommandInput = ListAnalyzedResourcesRequest;
export type ListAnalyzedResourcesCommandOutput = ListAnalyzedResourcesResponse & __MetadataBearer;

/**
* <p>Retrieves a list of resources of the specified type that have been analyzed by the
* specified analyzer..</p>
*/
export class ListAnalyzedResourcesCommand extends $Command<
ListAnalyzedResourcesCommandInput,
ListAnalyzedResourcesCommandOutput,
Expand All @@ -34,6 +38,9 @@ export class ListAnalyzedResourcesCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type ListAnalyzersCommandInput = ListAnalyzersRequest;
export type ListAnalyzersCommandOutput = ListAnalyzersResponse & __MetadataBearer;

/**
* <p>Retrieves a list of analyzers.</p>
*/
export class ListAnalyzersCommand extends $Command<
ListAnalyzersCommandInput,
ListAnalyzersCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class ListAnalyzersCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type ListArchiveRulesCommandInput = ListArchiveRulesRequest;
export type ListArchiveRulesCommandOutput = ListArchiveRulesResponse & __MetadataBearer;

/**
* <p>Retrieves a list of archive rules created for the specified analyzer.</p>
*/
export class ListArchiveRulesCommand extends $Command<
ListArchiveRulesCommandInput,
ListArchiveRulesCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class ListArchiveRulesCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
6 changes: 6 additions & 0 deletions clients/client-accessanalyzer/commands/ListFindingsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type ListFindingsCommandInput = ListFindingsRequest;
export type ListFindingsCommandOutput = ListFindingsResponse & __MetadataBearer;

/**
* <p>Retrieves a list of findings generated by the specified analyzer.</p>
*/
export class ListFindingsCommand extends $Command<
ListFindingsCommandInput,
ListFindingsCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class ListFindingsCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type ListTagsForResourceCommandInput = ListTagsForResourceRequest;
export type ListTagsForResourceCommandOutput = ListTagsForResourceResponse & __MetadataBearer;

/**
* <p>Retrieves a list of tags applied to the specified resource.</p>
*/
export class ListTagsForResourceCommand extends $Command<
ListTagsForResourceCommandInput,
ListTagsForResourceCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class ListTagsForResourceCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type StartResourceScanCommandInput = StartResourceScanRequest;
export type StartResourceScanCommandOutput = __MetadataBearer;

/**
* <p>Immediately starts a scan of the policies applied to the specified resource.</p>
*/
export class StartResourceScanCommand extends $Command<
StartResourceScanCommandInput,
StartResourceScanCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class StartResourceScanCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
6 changes: 6 additions & 0 deletions clients/client-accessanalyzer/commands/TagResourceCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type TagResourceCommandInput = TagResourceRequest;
export type TagResourceCommandOutput = TagResourceResponse & __MetadataBearer;

/**
* <p>Adds a tag to the specified resource.</p>
*/
export class TagResourceCommand extends $Command<
TagResourceCommandInput,
TagResourceCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class TagResourceCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type UntagResourceCommandInput = UntagResourceRequest;
export type UntagResourceCommandOutput = UntagResourceResponse & __MetadataBearer;

/**
* <p>Removes a tag from the specified resource.</p>
*/
export class UntagResourceCommand extends $Command<
UntagResourceCommandInput,
UntagResourceCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class UntagResourceCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type UpdateArchiveRuleCommandInput = UpdateArchiveRuleRequest;
export type UpdateArchiveRuleCommandOutput = __MetadataBearer;

/**
* <p>Updates the criteria and values for the specified archive rule.</p>
*/
export class UpdateArchiveRuleCommand extends $Command<
UpdateArchiveRuleCommandInput,
UpdateArchiveRuleCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class UpdateArchiveRuleCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ import {
export type UpdateFindingsCommandInput = UpdateFindingsRequest;
export type UpdateFindingsCommandOutput = __MetadataBearer;

/**
* <p>Updates the status for the specified findings.</p>
*/
export class UpdateFindingsCommand extends $Command<
UpdateFindingsCommandInput,
UpdateFindingsCommandOutput,
Expand All @@ -34,6 +37,9 @@ export class UpdateFindingsCommand extends $Command<
// End section: command_constructor
}

/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: AccessAnalyzerClientResolvedConfig,
Expand Down
6 changes: 3 additions & 3 deletions clients/client-accessanalyzer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"description": "AWS SDK for JavaScript Accessanalyzer Client for Node.js, Browser and React Native",
"version": "1.0.0-rc.7",
"scripts": {
"clean": "npm run remove-definitions && npm run remove-dist",
"build-documentation": "npm run clean && typedoc ./",
"clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
"build-documentation": "yarn remove-documentation && typedoc ./",
"prepublishOnly": "yarn build",
"pretest": "yarn build:cjs",
"remove-definitions": "rimraf ./types",
Expand Down Expand Up @@ -65,7 +65,7 @@
"@types/uuid": "^3.0.0",
"jest": "^26.1.0",
"rimraf": "^3.0.0",
"typedoc": "^0.17.8",
"typedoc": "^0.19.2",
"typescript": "~4.0.2"
},
"engines": {
Expand Down
Loading