Skip to content
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

docs(client): use interface for command input and output #2274

Merged
merged 3 commits into from
Apr 20, 2021
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.
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 @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ApplyArchiveRuleCommandInput = ApplyArchiveRuleRequest;
export type ApplyArchiveRuleCommandOutput = __MetadataBearer;
export interface ApplyArchiveRuleCommandInput extends ApplyArchiveRuleRequest {}
export interface ApplyArchiveRuleCommandOutput extends __MetadataBearer {}

/**
* <p>Retroactively applies the archive rule to existing findings that meet the archive rule
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type CancelPolicyGenerationCommandInput = CancelPolicyGenerationRequest;
export type CancelPolicyGenerationCommandOutput = CancelPolicyGenerationResponse & __MetadataBearer;
export interface CancelPolicyGenerationCommandInput extends CancelPolicyGenerationRequest {}
export interface CancelPolicyGenerationCommandOutput extends CancelPolicyGenerationResponse, __MetadataBearer {}

/**
* <p>Cancels the requested policy generation.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type CreateAccessPreviewCommandInput = CreateAccessPreviewRequest;
export type CreateAccessPreviewCommandOutput = CreateAccessPreviewResponse & __MetadataBearer;
export interface CreateAccessPreviewCommandInput extends CreateAccessPreviewRequest {}
export interface CreateAccessPreviewCommandOutput extends CreateAccessPreviewResponse, __MetadataBearer {}

/**
* <p>Creates an access preview that allows you to preview Access Analyzer findings for your resource
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type CreateAnalyzerCommandInput = CreateAnalyzerRequest;
export type CreateAnalyzerCommandOutput = CreateAnalyzerResponse & __MetadataBearer;
export interface CreateAnalyzerCommandInput extends CreateAnalyzerRequest {}
export interface CreateAnalyzerCommandOutput extends CreateAnalyzerResponse, __MetadataBearer {}

/**
* <p>Creates an analyzer for your account.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type CreateArchiveRuleCommandInput = CreateArchiveRuleRequest;
export type CreateArchiveRuleCommandOutput = __MetadataBearer;
export interface CreateArchiveRuleCommandInput extends CreateArchiveRuleRequest {}
export interface CreateArchiveRuleCommandOutput extends __MetadataBearer {}

/**
* <p>Creates an archive rule for the specified analyzer. Archive rules automatically archive
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type DeleteAnalyzerCommandInput = DeleteAnalyzerRequest;
export type DeleteAnalyzerCommandOutput = __MetadataBearer;
export interface DeleteAnalyzerCommandInput extends DeleteAnalyzerRequest {}
export interface DeleteAnalyzerCommandOutput extends __MetadataBearer {}

/**
* <p>Deletes the specified analyzer. When you delete an analyzer, Access Analyzer is disabled for the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type DeleteArchiveRuleCommandInput = DeleteArchiveRuleRequest;
export type DeleteArchiveRuleCommandOutput = __MetadataBearer;
export interface DeleteArchiveRuleCommandInput extends DeleteArchiveRuleRequest {}
export interface DeleteArchiveRuleCommandOutput extends __MetadataBearer {}

/**
* <p>Deletes the specified archive rule.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type GetAccessPreviewCommandInput = GetAccessPreviewRequest;
export type GetAccessPreviewCommandOutput = GetAccessPreviewResponse & __MetadataBearer;
export interface GetAccessPreviewCommandInput extends GetAccessPreviewRequest {}
export interface GetAccessPreviewCommandOutput extends GetAccessPreviewResponse, __MetadataBearer {}

/**
* <p>Retrieves information about an access preview for the specified analyzer.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type GetAnalyzedResourceCommandInput = GetAnalyzedResourceRequest;
export type GetAnalyzedResourceCommandOutput = GetAnalyzedResourceResponse & __MetadataBearer;
export interface GetAnalyzedResourceCommandInput extends GetAnalyzedResourceRequest {}
export interface GetAnalyzedResourceCommandOutput extends GetAnalyzedResourceResponse, __MetadataBearer {}

/**
* <p>Retrieves information about a resource that was analyzed.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type GetAnalyzerCommandInput = GetAnalyzerRequest;
export type GetAnalyzerCommandOutput = GetAnalyzerResponse & __MetadataBearer;
export interface GetAnalyzerCommandInput extends GetAnalyzerRequest {}
export interface GetAnalyzerCommandOutput extends GetAnalyzerResponse, __MetadataBearer {}

/**
* <p>Retrieves information about the specified analyzer.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type GetArchiveRuleCommandInput = GetArchiveRuleRequest;
export type GetArchiveRuleCommandOutput = GetArchiveRuleResponse & __MetadataBearer;
export interface GetArchiveRuleCommandInput extends GetArchiveRuleRequest {}
export interface GetArchiveRuleCommandOutput extends GetArchiveRuleResponse, __MetadataBearer {}

/**
* <p>Retrieves information about an archive rule.</p>
Expand Down
4 changes: 2 additions & 2 deletions clients/client-accessanalyzer/commands/GetFindingCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type GetFindingCommandInput = GetFindingRequest;
export type GetFindingCommandOutput = GetFindingResponse & __MetadataBearer;
export interface GetFindingCommandInput extends GetFindingRequest {}
export interface GetFindingCommandOutput extends GetFindingResponse, __MetadataBearer {}

/**
* <p>Retrieves information about the specified finding.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type GetGeneratedPolicyCommandInput = GetGeneratedPolicyRequest;
export type GetGeneratedPolicyCommandOutput = GetGeneratedPolicyResponse & __MetadataBearer;
export interface GetGeneratedPolicyCommandInput extends GetGeneratedPolicyRequest {}
export interface GetGeneratedPolicyCommandOutput extends GetGeneratedPolicyResponse, __MetadataBearer {}

/**
* <p>Retrieves the policy that was generated using <code>StartPolicyGeneration</code>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ListAccessPreviewFindingsCommandInput = ListAccessPreviewFindingsRequest;
export type ListAccessPreviewFindingsCommandOutput = ListAccessPreviewFindingsResponse & __MetadataBearer;
export interface ListAccessPreviewFindingsCommandInput extends ListAccessPreviewFindingsRequest {}
export interface ListAccessPreviewFindingsCommandOutput extends ListAccessPreviewFindingsResponse, __MetadataBearer {}

/**
* <p>Retrieves a list of access preview findings generated by the specified access
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ListAccessPreviewsCommandInput = ListAccessPreviewsRequest;
export type ListAccessPreviewsCommandOutput = ListAccessPreviewsResponse & __MetadataBearer;
export interface ListAccessPreviewsCommandInput extends ListAccessPreviewsRequest {}
export interface ListAccessPreviewsCommandOutput extends ListAccessPreviewsResponse, __MetadataBearer {}

/**
* <p>Retrieves a list of access previews for the specified analyzer.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ListAnalyzedResourcesCommandInput = ListAnalyzedResourcesRequest;
export type ListAnalyzedResourcesCommandOutput = ListAnalyzedResourcesResponse & __MetadataBearer;
export interface ListAnalyzedResourcesCommandInput extends ListAnalyzedResourcesRequest {}
export interface ListAnalyzedResourcesCommandOutput extends ListAnalyzedResourcesResponse, __MetadataBearer {}

/**
* <p>Retrieves a list of resources of the specified type that have been analyzed by the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ListAnalyzersCommandInput = ListAnalyzersRequest;
export type ListAnalyzersCommandOutput = ListAnalyzersResponse & __MetadataBearer;
export interface ListAnalyzersCommandInput extends ListAnalyzersRequest {}
export interface ListAnalyzersCommandOutput extends ListAnalyzersResponse, __MetadataBearer {}

/**
* <p>Retrieves a list of analyzers.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ListArchiveRulesCommandInput = ListArchiveRulesRequest;
export type ListArchiveRulesCommandOutput = ListArchiveRulesResponse & __MetadataBearer;
export interface ListArchiveRulesCommandInput extends ListArchiveRulesRequest {}
export interface ListArchiveRulesCommandOutput extends ListArchiveRulesResponse, __MetadataBearer {}

/**
* <p>Retrieves a list of archive rules created for the specified analyzer.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ListFindingsCommandInput = ListFindingsRequest;
export type ListFindingsCommandOutput = ListFindingsResponse & __MetadataBearer;
export interface ListFindingsCommandInput extends ListFindingsRequest {}
export interface ListFindingsCommandOutput extends ListFindingsResponse, __MetadataBearer {}

/**
* <p>Retrieves a list of findings generated by the specified analyzer.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ListPolicyGenerationsCommandInput = ListPolicyGenerationsRequest;
export type ListPolicyGenerationsCommandOutput = ListPolicyGenerationsResponse & __MetadataBearer;
export interface ListPolicyGenerationsCommandInput extends ListPolicyGenerationsRequest {}
export interface ListPolicyGenerationsCommandOutput extends ListPolicyGenerationsResponse, __MetadataBearer {}

/**
* <p>Lists all of the policy generations requested in the last seven days.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ListTagsForResourceCommandInput = ListTagsForResourceRequest;
export type ListTagsForResourceCommandOutput = ListTagsForResourceResponse & __MetadataBearer;
export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {}
export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {}

/**
* <p>Retrieves a list of tags applied to the specified resource.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type StartPolicyGenerationCommandInput = StartPolicyGenerationRequest;
export type StartPolicyGenerationCommandOutput = StartPolicyGenerationResponse & __MetadataBearer;
export interface StartPolicyGenerationCommandInput extends StartPolicyGenerationRequest {}
export interface StartPolicyGenerationCommandOutput extends StartPolicyGenerationResponse, __MetadataBearer {}

/**
* <p>Starts the policy generation request.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type StartResourceScanCommandInput = StartResourceScanRequest;
export type StartResourceScanCommandOutput = __MetadataBearer;
export interface StartResourceScanCommandInput extends StartResourceScanRequest {}
export interface StartResourceScanCommandOutput extends __MetadataBearer {}

/**
* <p>Immediately starts a scan of the policies applied to the specified resource.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type TagResourceCommandInput = TagResourceRequest;
export type TagResourceCommandOutput = TagResourceResponse & __MetadataBearer;
export interface TagResourceCommandInput extends TagResourceRequest {}
export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {}

/**
* <p>Adds a tag to the specified resource.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type UntagResourceCommandInput = UntagResourceRequest;
export type UntagResourceCommandOutput = UntagResourceResponse & __MetadataBearer;
export interface UntagResourceCommandInput extends UntagResourceRequest {}
export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {}

/**
* <p>Removes a tag from the specified resource.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type UpdateArchiveRuleCommandInput = UpdateArchiveRuleRequest;
export type UpdateArchiveRuleCommandOutput = __MetadataBearer;
export interface UpdateArchiveRuleCommandInput extends UpdateArchiveRuleRequest {}
export interface UpdateArchiveRuleCommandOutput extends __MetadataBearer {}

/**
* <p>Updates the criteria and values for the specified archive rule.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type UpdateFindingsCommandInput = UpdateFindingsRequest;
export type UpdateFindingsCommandOutput = __MetadataBearer;
export interface UpdateFindingsCommandInput extends UpdateFindingsRequest {}
export interface UpdateFindingsCommandOutput extends __MetadataBearer {}

/**
* <p>Updates the status for the specified findings.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type ValidatePolicyCommandInput = ValidatePolicyRequest;
export type ValidatePolicyCommandOutput = ValidatePolicyResponse & __MetadataBearer;
export interface ValidatePolicyCommandInput extends ValidatePolicyRequest {}
export interface ValidatePolicyCommandOutput extends ValidatePolicyResponse, __MetadataBearer {}

/**
* <p>Requests the validation of a policy and returns a list of findings. The findings help
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type CreateCertificateAuthorityAuditReportCommandInput = CreateCertificateAuthorityAuditReportRequest;
export type CreateCertificateAuthorityAuditReportCommandOutput = CreateCertificateAuthorityAuditReportResponse &
__MetadataBearer;
export interface CreateCertificateAuthorityAuditReportCommandInput
extends CreateCertificateAuthorityAuditReportRequest {}
export interface CreateCertificateAuthorityAuditReportCommandOutput
extends CreateCertificateAuthorityAuditReportResponse,
__MetadataBearer {}

/**
* <p>Creates an audit report that lists every time that your CA private key is used. The
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type CreateCertificateAuthorityCommandInput = CreateCertificateAuthorityRequest;
export type CreateCertificateAuthorityCommandOutput = CreateCertificateAuthorityResponse & __MetadataBearer;
export interface CreateCertificateAuthorityCommandInput extends CreateCertificateAuthorityRequest {}
export interface CreateCertificateAuthorityCommandOutput extends CreateCertificateAuthorityResponse, __MetadataBearer {}

/**
* <p>Creates a root or subordinate private certificate authority (CA). You must specify the
Expand Down
4 changes: 2 additions & 2 deletions clients/client-acm-pca/commands/CreatePermissionCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type CreatePermissionCommandInput = CreatePermissionRequest;
export type CreatePermissionCommandOutput = __MetadataBearer;
export interface CreatePermissionCommandInput extends CreatePermissionRequest {}
export interface CreatePermissionCommandOutput extends __MetadataBearer {}

/**
* <p>Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type DeleteCertificateAuthorityCommandInput = DeleteCertificateAuthorityRequest;
export type DeleteCertificateAuthorityCommandOutput = __MetadataBearer;
export interface DeleteCertificateAuthorityCommandInput extends DeleteCertificateAuthorityRequest {}
export interface DeleteCertificateAuthorityCommandOutput extends __MetadataBearer {}

/**
* <p>Deletes a private certificate authority (CA). You must provide the Amazon Resource
Expand Down
4 changes: 2 additions & 2 deletions clients/client-acm-pca/commands/DeletePermissionCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type DeletePermissionCommandInput = DeletePermissionRequest;
export type DeletePermissionCommandOutput = __MetadataBearer;
export interface DeletePermissionCommandInput extends DeletePermissionRequest {}
export interface DeletePermissionCommandOutput extends __MetadataBearer {}

/**
* <p>Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal
Expand Down
4 changes: 2 additions & 2 deletions clients/client-acm-pca/commands/DeletePolicyCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type DeletePolicyCommandInput = DeletePolicyRequest;
export type DeletePolicyCommandOutput = __MetadataBearer;
export interface DeletePolicyCommandInput extends DeletePolicyRequest {}
export interface DeletePolicyCommandOutput extends __MetadataBearer {}

/**
* <p>Deletes the resource-based policy attached to a private CA. Deletion will remove any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ import {
SerdeContext as __SerdeContext,
} from "@aws-sdk/types";

export type DescribeCertificateAuthorityAuditReportCommandInput = DescribeCertificateAuthorityAuditReportRequest;
export type DescribeCertificateAuthorityAuditReportCommandOutput = DescribeCertificateAuthorityAuditReportResponse &
__MetadataBearer;
export interface DescribeCertificateAuthorityAuditReportCommandInput
extends DescribeCertificateAuthorityAuditReportRequest {}
export interface DescribeCertificateAuthorityAuditReportCommandOutput
extends DescribeCertificateAuthorityAuditReportResponse,
__MetadataBearer {}

/**
* <p>Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action. Audit information is created
Expand Down