Skip to content

Commit 5fba8a4

Browse files
authored
docs: add necessary docs for clients api reference (#1716)
Also update typedoc dependency and doc build scripts
1 parent b5bfada commit 5fba8a4

File tree

11,097 files changed

+112882
-1442
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

11,097 files changed

+112882
-1442
lines changed

clients/client-accessanalyzer/commands/CreateAnalyzerCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type CreateAnalyzerCommandInput = CreateAnalyzerRequest;
2121
export type CreateAnalyzerCommandOutput = CreateAnalyzerResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Creates an analyzer for your account.</p>
25+
*/
2326
export class CreateAnalyzerCommand extends $Command<
2427
CreateAnalyzerCommandInput,
2528
CreateAnalyzerCommandOutput,
@@ -34,6 +37,9 @@ export class CreateAnalyzerCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: AccessAnalyzerClientResolvedConfig,

clients/client-accessanalyzer/commands/CreateArchiveRuleCommand.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ import {
2020
export type CreateArchiveRuleCommandInput = CreateArchiveRuleRequest;
2121
export type CreateArchiveRuleCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Creates an archive rule for the specified analyzer. Archive rules automatically archive
25+
* findings that meet the criteria you define when you create the rule.</p>
26+
*/
2327
export class CreateArchiveRuleCommand extends $Command<
2428
CreateArchiveRuleCommandInput,
2529
CreateArchiveRuleCommandOutput,
@@ -34,6 +38,9 @@ export class CreateArchiveRuleCommand extends $Command<
3438
// End section: command_constructor
3539
}
3640

41+
/**
42+
* @internal
43+
*/
3744
resolveMiddleware(
3845
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3946
configuration: AccessAnalyzerClientResolvedConfig,

clients/client-accessanalyzer/commands/DeleteAnalyzerCommand.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ import {
2020
export type DeleteAnalyzerCommandInput = DeleteAnalyzerRequest;
2121
export type DeleteAnalyzerCommandOutput = __MetadataBearer;
2222

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

42+
/**
43+
* @internal
44+
*/
3745
resolveMiddleware(
3846
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3947
configuration: AccessAnalyzerClientResolvedConfig,

clients/client-accessanalyzer/commands/DeleteArchiveRuleCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type DeleteArchiveRuleCommandInput = DeleteArchiveRuleRequest;
2121
export type DeleteArchiveRuleCommandOutput = __MetadataBearer;
2222

23+
/**
24+
* <p>Deletes the specified archive rule.</p>
25+
*/
2326
export class DeleteArchiveRuleCommand extends $Command<
2427
DeleteArchiveRuleCommandInput,
2528
DeleteArchiveRuleCommandOutput,
@@ -34,6 +37,9 @@ export class DeleteArchiveRuleCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: AccessAnalyzerClientResolvedConfig,

clients/client-accessanalyzer/commands/GetAnalyzedResourceCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type GetAnalyzedResourceCommandInput = GetAnalyzedResourceRequest;
2121
export type GetAnalyzedResourceCommandOutput = GetAnalyzedResourceResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Retrieves information about a resource that was analyzed.</p>
25+
*/
2326
export class GetAnalyzedResourceCommand extends $Command<
2427
GetAnalyzedResourceCommandInput,
2528
GetAnalyzedResourceCommandOutput,
@@ -34,6 +37,9 @@ export class GetAnalyzedResourceCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: AccessAnalyzerClientResolvedConfig,

clients/client-accessanalyzer/commands/GetAnalyzerCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type GetAnalyzerCommandInput = GetAnalyzerRequest;
2121
export type GetAnalyzerCommandOutput = GetAnalyzerResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Retrieves information about the specified analyzer.</p>
25+
*/
2326
export class GetAnalyzerCommand extends $Command<
2427
GetAnalyzerCommandInput,
2528
GetAnalyzerCommandOutput,
@@ -34,6 +37,9 @@ export class GetAnalyzerCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: AccessAnalyzerClientResolvedConfig,

clients/client-accessanalyzer/commands/GetArchiveRuleCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type GetArchiveRuleCommandInput = GetArchiveRuleRequest;
2121
export type GetArchiveRuleCommandOutput = GetArchiveRuleResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Retrieves information about an archive rule.</p>
25+
*/
2326
export class GetArchiveRuleCommand extends $Command<
2427
GetArchiveRuleCommandInput,
2528
GetArchiveRuleCommandOutput,
@@ -34,6 +37,9 @@ export class GetArchiveRuleCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: AccessAnalyzerClientResolvedConfig,

clients/client-accessanalyzer/commands/GetFindingCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type GetFindingCommandInput = GetFindingRequest;
2121
export type GetFindingCommandOutput = GetFindingResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Retrieves information about the specified finding.</p>
25+
*/
2326
export class GetFindingCommand extends $Command<
2427
GetFindingCommandInput,
2528
GetFindingCommandOutput,
@@ -34,6 +37,9 @@ export class GetFindingCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: AccessAnalyzerClientResolvedConfig,

clients/client-accessanalyzer/commands/ListAnalyzedResourcesCommand.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ import {
2020
export type ListAnalyzedResourcesCommandInput = ListAnalyzedResourcesRequest;
2121
export type ListAnalyzedResourcesCommandOutput = ListAnalyzedResourcesResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Retrieves a list of resources of the specified type that have been analyzed by the
25+
* specified analyzer..</p>
26+
*/
2327
export class ListAnalyzedResourcesCommand extends $Command<
2428
ListAnalyzedResourcesCommandInput,
2529
ListAnalyzedResourcesCommandOutput,
@@ -34,6 +38,9 @@ export class ListAnalyzedResourcesCommand extends $Command<
3438
// End section: command_constructor
3539
}
3640

41+
/**
42+
* @internal
43+
*/
3744
resolveMiddleware(
3845
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3946
configuration: AccessAnalyzerClientResolvedConfig,

clients/client-accessanalyzer/commands/ListAnalyzersCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ import {
2020
export type ListAnalyzersCommandInput = ListAnalyzersRequest;
2121
export type ListAnalyzersCommandOutput = ListAnalyzersResponse & __MetadataBearer;
2222

23+
/**
24+
* <p>Retrieves a list of analyzers.</p>
25+
*/
2326
export class ListAnalyzersCommand extends $Command<
2427
ListAnalyzersCommandInput,
2528
ListAnalyzersCommandOutput,
@@ -34,6 +37,9 @@ export class ListAnalyzersCommand extends $Command<
3437
// End section: command_constructor
3538
}
3639

40+
/**
41+
* @internal
42+
*/
3743
resolveMiddleware(
3844
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
3945
configuration: AccessAnalyzerClientResolvedConfig,

0 commit comments

Comments
 (0)